Docs

Revoke an API key; it stops working at once

  • In the sandbox

In plain words

Revokes an API key at once.
POST
/keys/{id}/revoke

Authorization

apiKey
headerAuthorizationBearer <token>

Send your key as a bearer token: Authorization: Bearer <your-api-key>. Health is the only call that needs no key.

Path parameters

id*string

Response body

Revoked (or already revoked).

application/json
  1. response
id*string
client*string
environment*string
Value in"sandbox""production"
scopes*array<>
label?string
created_at*string
Formatdate-time
revoked_at?string
Formatdate-time
also_revoked?array<string>

Only in a revoke answer, the ids of the keys minted under this one that were revoked with it.

curl -X POST "https://example.com/keys/string/revoke" \  -H "Authorization: Bearer <your-api-key>"
{  "id": "string",  "client": "string",  "environment": "sandbox",  "scopes": [    "submit"  ],  "label": "string",  "created_at": "2019-08-24T14:15:22Z",  "revoked_at": "2019-08-24T14:15:22Z",  "also_revoked": [    "string"  ]}