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.
Authorization: Bearer …) or the session cookie (browser sessions). See Authentication.Changes the name, description, rate limits or project restriction of one of your active keys. Send only the fields you want to change. Scopes and expiry cannot be changed. Requires a signed-in session; an ivy_ key is answered with 401.
Request
Request body
The key's id.
New display name. Must not be blank.
New project restriction. Send null to remove it.
Responses
200 OK
Response shape:
Key id. Pass it as keyId to read usage.
Public key identifier.
First characters of the key, for recognising it.
Projects the key is limited to; null means all of your projects.
400 Bad Request
keyId is missing, the name is empty, or a limit is not a positive bounded integerResponse shape: object
401 Unauthorized
Response shape: object
403 Forbidden
unauthorizedProjectIds lists them)Response shape: object
404 Not Found
Response shape: object
429 Too Many Requests
Response shape: object
Was this page helpful?