Skip to content
InternetData

Revoke

post/api/v1/iam/apikeys/{id}/revoke

Stops the key working. Revocation is soft: the key stays listed with a revoked_at, because the organization still owns whatever it did while it was alive.

Authorization

BearerAuthbearer token

Authorization: Bearer <key>, with a key from the console. Keys are default-deny: each operation names the scope it needs, and an existing key does not gain an operation until that scope is added to it.

Scopes: apikeys.manage

Path parameters

idrequiredstring (uuid)

The key's ID, as returned by the list endpoint. Never the key itself.

Responses

200application/json

Revoked.

rcrequiredstring

The outcome. SUCCESS on success; otherwise the reason.

TypeScript type
ts
{
  rc: string;
}
401application/json

No credential was presented, or it is not valid.

rcrequiredstring

The outcome. SUCCESS on success; otherwise the reason.

TypeScript type
ts
{
  rc: string;
}
403application/json

The credential does not hold the scope this endpoint requires. The missing scope is deliberately not named.

rcrequiredstring

The outcome. SUCCESS on success; otherwise the reason.

TypeScript type
ts
{
  rc: string;
}
404application/json

No such key in this organization.

rcrequiredstring

The outcome. SUCCESS on success; otherwise the reason.

TypeScript type
ts
{
  rc: string;
}