API Keys
4 operations.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/api-keys | List API keys |
| POST | /api/v1/api-keys | Create an API key |
| GET | /api/v1/api-keys/{apiKeyId} | Get an API key |
| DELETE | /api/v1/api-keys/{apiKeyId} | Revoke an API key |
List API keys
GET /api/v1/api-keys
Sessions must specify the organizationId query parameter. Organization-scoped credentials may omit it.
Parameters
query
| Name | Type | Required | Description |
|---|---|---|---|
organizationId | string | optional | Selects the organization that owns the collection. Required for session credentials. A credential scoped to one organization may omit it. Applies to List API keys. |
limit | integer | optional | Sets the maximum number of resources returned in this page. Applies to List API keys. |
cursor | string | optional | Opaque cursor returned by the previous page; omit it to read the first page. Applies to List API keys. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — apiKeys: array<object> (required); pagination: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
Create an API key
POST /api/v1/api-keys
Requires api-keys:create. Sessions must specify organizationId. Organization-scoped credentials may omit it. API-key callers can delegate only a subset of their own grants. Rotate by creating a replacement and revoking the old key.
Parameters
query
| Name | Type | Required | Description |
|---|---|---|---|
organizationId | string | optional | Selects the organization that owns the collection. Required for session credentials. A credential scoped to one organization may omit it. Applies to Create an API key. |
Request body
Required — Request body for: Create an API key.
application/json
| Name | Type | Required | Description |
|---|---|---|---|
name | string | optional | |
grants | one of 4 types | required | |
expiresIn | integer | optional | |
expiresAt | string | null | optional |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
Get an API key
GET /api/v1/api-keys/{apiKeyId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
apiKeyId | string | required | Identifies the API key being attached or removed. Applies to Get an API key. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |
Revoke an API key
DELETE /api/v1/api-keys/{apiKeyId}
Parameters
path
| Name | Type | Required | Description |
|---|---|---|---|
apiKeyId | string | required | Identifies the API key being attached or removed. Applies to Revoke an API key. |
Responses
| Status | Description | Body |
|---|---|---|
200 | Response for status 200 | application/json — object — data: object (required) |
400 | The request is malformed or cannot be processed. | application/json — PublicApiError — error: object (required) |
401 | Authentication failed. The Authorization header is missing, or the credential is invalid or expired. | application/json — PublicApiError — error: object (required) |
403 | Access denied. The authenticated user does not have permission to perform this action. | application/json — PublicApiError — error: object (required) |
404 | Resource not found. | application/json — PublicApiError — error: object (required) |
409 | Request conflicts with current state of the resource, including safe deployment conflict classifications. | application/json — PublicApiError — error: object (required) |
422 | Request validation failed. Check the request body, query parameters, or path parameters. | application/json — PublicApiError — error: object (required) |
429 | Too many requests. | application/json — PublicApiError — error: object (required) |
500 | The server could not complete the request. | application/json — PublicApiError — error: object (required) |
503 | Service temporarily unavailable (e.g. execution capacity exhausted). The response carries a Retry-After header; retry with backoff. | application/json — PublicApiError — error: object (required) |