Delete connection

Forgets a connector: every custodied secret, then the row.

DELETE /v1/connection/{id}

Provider → · All API references → · Get started →

Address	`https://api.hanzo.ai/v1/connection/{id}`
Method	`DELETE`
Operation	`delete_connection_by_id`
Auth	`Authorization: Bearer $HANZO_API_KEY`

Forgets a connector: every custodied secret, then the row. Idempotent — dropping a never-connected id still answers {disconnected:true} (disconnect() parity). No provider Revoke: none of the user-plane providers exposes a revoke endpoint.

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`	provider.disconnectOut	ok
`default`	problem-details	refused

200 body — 1 field.

Field	In	Type	Always	Description
`disconnected`	body	boolean	—	Disconnected is always true — the org's secrets and connection row are gone.

Failure carries the platform error shape — see Errors.

Examples

CLI

SDK

HTTP

MCP

hanzo connection rm <id>

.ts

.py

.go

.rs

.java

import { Configuration, ProviderApi } from 'hanzoai';

const api = new ProviderApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.deleteConnectionById({ id: 'id' });

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ProviderApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ProviderApi(client).delete_connection_by_id(id='id')

cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.ProviderAPI.DeleteConnectionById(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_client::apis::{configuration::Configuration, provider_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = provider_api::delete_connection_by_id(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ProviderApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new ProviderApi(client).deleteConnectionById();

curl -X DELETE https://api.hanzo.ai/v1/connection/<id> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches provider through the provider tool, which names its 38 operations with its own verbs — this one among them, under a name only MCP 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_connections"
         }
       }
     }'

Provider API · All Hanzo APIs · Interactive reference

Was this page useful?

PreviousCreate prompt NextDelete pages