DELETE /user/api-keys
Revoke an API key — Revokes one of your keys, so it stops authenticating immediately. The key stays in your list with status revoked.
Auth: required. Send a signed-in session token (
Authorization: Bearer …) or the session cookie (browser sessions). See Authentication.Revokes one of your keys, so it stops authenticating immediately. The key stays in your list with status revoked. A key .bloom* manages for you cannot be revoked and returns 403 with code MANAGED_CALLBACK_KEY. Requires a signed-in session; an ivy_ key is answered with 401.
Request
Query parameters
keyIdstring (uuid)
The key's id.
Responses
200 OK
The key was revoked
Response shape:
successboolean
messagestring
400 Bad Request
keyId is missingResponse shape: object
401 Unauthorized
A signed-in session is required
Response shape: object
403 Forbidden
The key is managed by .bloom* for job callbacks and cannot be revoked
Response shape: object
404 Not Found
No key with that id on your account
Response shape: object
429 Too Many Requests
Rate limit exceeded
Response shape: object
Was this page helpful?