POST /user/api-keys
Create an API key — Creates an ivy_ API key for your account and returns the full key in apiKey.
Authorization: Bearer …) or the session cookie (browser sessions). See Authentication.Creates an ivy_ API key for your account and returns the full key in apiKey. This is the only time the secret is shown, so store it immediately. An API key cannot create other keys: this route needs a signed-in session, and an ivy_ key is answered with 401.
Request
Request body
Display name. Must not be blank.
Capabilities to grant (read, write, manage). Defaults to the standard set when omitted. Scopes reserved for .bloom* are rejected.
Days until the key expires. The key never expires when omitted.
Limit the key to these projects. You must have access to each one. The key covers all your projects when omitted.
Responses
201 Created
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.
The full ivy_ key. Shown once and never returned again.
400 Bad Request
Response 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?
GET /user/api-keys
List your API keys, or read one key's usage — Without query parameters, returns every API key on your account, newest first.
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.