Hanzo
OpenapiIntegrations

Forces a token rotation for a connected connector, ahead of the automatic…

Forces a token rotation for a connected connector, ahead of the automatic rotation a token read would do inside the expiry window.

POST /v1/integrations/connectors/{id}/refresh

Addresshttps://api.hanzo.ai/v1/integrations/connectors/{id}/refresh
MethodPOST
Operationpost_integrations_connectors_by_id_refresh
AuthAuthorization: Bearer $HANZO_API_KEY

Forces a token rotation for a connected connector, ahead of the automatic rotation a token read would do inside the expiry window. Only providers that declare a Refresh support it.

Request

1 field.

FieldInTypeRequiredDescription
idpathstringyesID is the connector id, provider + ":" + label ("openai:default") — the auth-profile-id shape.

Response

StatusBodyMeaning
200refreshOutok

200 body — 10 fields.

FieldInTypeAlwaysDescription
connectorbodyconnView
connector.accountbodystringAccount is the provider's label for the connected account.
connector.connectedAtbodystringConnectedAt is when the connector was last (re)established, RFC 3339 UTC.
connector.expiresAtbodystringExpiresAt is when the access token expires, RFC 3339 UTC; empty for a non-expiring credential.
connector.externalIdbodystringExternalID is the provider's own id for that account.
connector.idbodystringID is provider + ":" + label — what every other connector route addresses.
connector.labelbodystringLabel is the caller's name for this connection ("default", "work").
connector.providerbodystringProvider is the user-scoped provider's registry id.
connector.scopesbodystring[]Scopes are the permissions the credential carries.
refreshedbodybooleanRefreshed is always true — a failed rotation is an HTTP error.

Failure carries the platform error shape — see Errors.

Examples

hanzo has no subcommand for this operation — the CLI serves only what cloud's live route table confirms. Use HTTP or an SDK.


Integrations API · All Hanzo APIs · Interactive reference

How is this guide?

On this page