Revoke a Connection

DELETE /v1/connections/{connection_id}

Revokes the Connection at the revision If-Match names and answers it revoked (1.60.0; integrations.md section 7). The invalidation is published on the cell's Redis at once, so a grant that still names the Connection fails with connection_not_active; a leased task calls the vendor's revocation endpoint where one exists, then the sealed secrets are destroyed. Revoked is terminal: a second revocation is connection_revoked. Writes the event connection.revoked.

Request

Set VOCAL_API to the base URL of your API and VOCAL_API_KEY to an API key with the integrations:write scope (Authentication and keys). Replace each placeholder, such as agt_... or <name>, with your own value.

curl -X DELETE "$VOCAL_API/v1/connections/con_..." \
  -H "Authorization: Bearer $VOCAL_API_KEY" \
  -H 'If-Match: "1"'

const response = await fetch(`${process.env.VOCAL_API}/v1/connections/con_...`, {
  method: 'DELETE',
  headers: {
    Authorization: `Bearer ${process.env.VOCAL_API_KEY}`,
    'If-Match': '"1"',
  },
});
console.log(response.status, await response.text());

import os

import requests

response = requests.delete(
    f"{os.environ['VOCAL_API']}/v1/connections/con_...",
    headers={
        "Authorization": f"Bearer {os.environ['VOCAL_API_KEY']}",
        "If-Match": '"1"',
    },
)
print(response.status_code, response.text)

Parameters

Responses

Fields of the 200 answer

The shape is Connection.