Revoke an install's key

DELETE

/installs/{id}/key

const url = 'https://api.canopyhq.dev/installs/example/key';
const options = {method: 'DELETE', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request DELETE \
  --url https://api.canopyhq.dev/installs/example/key \
  --header 'Authorization: Bearer <token>'

Revoke under the tenant owner’s console token, keeping the install and its sessions.

Authorizations

console_token

Parameters

Path Parameters

required

Opaque; never the key, never anything the vendor chose.

string

The install whose key is revoked.

Responses

204

Owner only. No key resolves until the owner rotates. The install and its sessions remain. Open sessions keep their landed config and work until their 15-minute tokens expire; the revoked key cannot renew them.

403

Only the tenant owner may revoke.

404

The tenant has no such install, or it was deleted.

409

Another key-management operation won; retry revocation.