Delete credentials

Removes one of your org's notify provider credentials.

DELETE /v1/notify/credentials/{provider}/{key}

Addresshttps://api.hanzo.ai/v1/notify/credentials/{provider}/{key}
MethodDELETE
Operationdelete_notify_credentials_by_provider_by_key
AuthAuthorization: Bearer $HANZO_API_KEY

Removes one of your org's notify provider credentials.

The value is forgotten in KMS. A provider missing a key it cannot send without is no longer picked for its channel, and a send that pins it fails with the key it lacks. Removing a key that is not set succeeds, since what was asked for is already true. Org admin only.

Request

2 fields.

FieldInTypeRequiredDescription
providerpathstringyesProvider is the delivery provider the credential is for.
keypathstringyesKey is the credential's name within that provider.

Response

StatusBodyMeaning
204—no content
defaultproblem-detailsrefused

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, NotifyApi } from 'hanzoai';

const api = new NotifyApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.deleteNotifyCredentialsByProviderByKey({ provider: 'provider', key: 'key' });
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import NotifyApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = NotifyApi(client).delete_notify_credentials_by_provider_by_key(provider='provider', key='key')
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.NotifyAPI.DeleteNotifyCredentialsByProviderByKey(context.Background()).Execute()
if err != nil {
	return err
}
use hanzo_client::apis::{configuration::Configuration, notify_api};

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

let result = notify_api::delete_notify_credentials_by_provider_by_key(&cfg, Default::default()).await?;
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.NotifyApi;

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

var result = new NotifyApi(client).deleteNotifyCredentialsByProviderByKey();
curl -X DELETE https://api.hanzo.ai/v1/notify/credentials/<provider>/<key> \
  -H "Authorization: Bearer $HANZO_API_KEY"

MCP reaches notify through the notify tool, which names its 4 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": "get_notify_health"
         }
       }
     }'

Notify API · All Hanzo APIs · Interactive reference

Was this page useful?