Skip to main content

Remove Integration Credentials (Admin)

Deactivate an integration by removing its stored credential. Idempotent: returns success whether or not a row existed. Requires an admin-scoped API key.

Parameters

NameTypeDefaultDescription
integration_key Requiredstring-Catalog key for the integration to deactivate (e.g., 'hginsights_v2', 'salesforce').

Use Cases

  • Disconnect an integration by deleting its stored credential
  • Deactivate an integration during a security rotation — the call is idempotent

Example Usage

Deactivate the HG Insights v2 integration

{
"tool": "admin_remove_integration_credentials",
"arguments": {
"integration_key": "hginsights_v2"
}
}

Response Format

FieldTypeDescription
keystringIntegration catalog key that was deactivated.
isConfiguredbooleanAlways false after removal.