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
| Address | https://api.hanzo.ai/v1/integrations/connectors/{id}/refresh |
| Method | POST |
| Operation | post_integrations_connectors_by_id_refresh |
| Auth | Authorization: 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.
| Field | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | ID is the connector id, provider + ":" + label ("openai:default") — the auth-profile-id shape. |
Response
| Status | Body | Meaning |
|---|---|---|
200 | refreshOut | ok |
200 body — 10 fields.
| Field | In | Type | Always | Description |
|---|---|---|---|---|
connector | body | connView | — | |
connector.account | body | string | — | Account is the provider's label for the connected account. |
connector.connectedAt | body | string | — | ConnectedAt is when the connector was last (re)established, RFC 3339 UTC. |
connector.expiresAt | body | string | — | ExpiresAt is when the access token expires, RFC 3339 UTC; empty for a non-expiring credential. |
connector.externalId | body | string | — | ExternalID is the provider's own id for that account. |
connector.id | body | string | — | ID is provider + ":" + label — what every other connector route addresses. |
connector.label | body | string | — | Label is the caller's name for this connection ("default", "work"). |
connector.provider | body | string | — | Provider is the user-scoped provider's registry id. |
connector.scopes | body | string[] | — | Scopes are the permissions the credential carries. |
refreshed | body | boolean | — | Refreshed 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.
import { Configuration, IntegrationsApi } from 'hanzoai';
const api = new IntegrationsApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postIntegrationsConnectorsByIdRefresh({ id: 'id' });from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import IntegrationsApi
client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = IntegrationsApi(client).post_integrations_connectors_by_id_refresh(id='id')cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)
resp, _, err := client.IntegrationsAPI.PostIntegrationsConnectorsByIdRefresh(context.Background()).Execute()
if err != nil {
return err
}use hanzo_cloud::apis::{configuration::Configuration, integrations_api};
let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();
let result = integrations_api::post_integrations_connectors_by_id_refresh(&cfg, Default::default()).await?;import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.IntegrationsApi;
ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));
var result = new IntegrationsApi(client).postIntegrationsConnectorsByIdRefresh();The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →
curl -X POST https://api.hanzo.ai/v1/integrations/connectors/<id>/refresh \
-H "Authorization: Bearer $HANZO_API_KEY"The door reaches integrations through the integrations tool, which names its 45 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:
curl -X POST https://api.hanzo.ai/v1/mcp \
-H "Content-Type: application/json" \
-d '{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "describe",
"arguments": {
"op": "list_connectors"
}
}
}'How is this guide?