PATCH /user/api-keys
Revoke, archive or move several API keys — Applies one action to up to 50 of your keys at once. revoke and archive both set the status to revoked…
Authorization: Bearer …) or the session cookie (browser sessions). See Authentication.Applies one action to up to 50 of your keys at once. revoke and archive both set the status to revoked; move replaces each key's project restriction. If any key belongs to someone else, or the batch includes a key the action can't touch, nothing is changed: revoke and archive refuse the key .bloom* manages for job callbacks, and move refuses that key and every other key .bloom* manages. Requires a signed-in session; an ivy_ key is answered with 401.
Request
Request body
Required for move. An empty array removes the project restriction.
Responses
200 OK
Response shape:
Number of keys in the request that the action was applied to.
400 Bad Request
keyIds is empty or longer than 50, action is not recognised, or allowedProjectIds is missing for moveResponse shape: object
401 Unauthorized
Response shape: object
403 Forbidden
unauthorizedIds), a project is not accessible to you, or the batch includes a managed key the action refuses (managedKeyIds). If a key becomes managed while the request runs, the other keys are still changed: read affected and refusedResponse shape: object
429 Too Many Requests
Response shape: object
Was this page helpful?
PUT /user/api-keys
Update an API key — Changes the name, description, rate limits or project restriction of one of your active keys. Send only the fields you want to change.
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.