API Keys

API key management endpoints for projects

List API Keys

get

Retrieves a list of API keys for a specific project.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstringRequired

Organization ID

project_idstringRequired

The project ID

Responses

200

A list of API keys.

application/json

400

The request is invalid.

application/json

401

Unauthorized access.

application/json

404

The project was not found.

application/json

500

An unexpected internal server error occurred.

application/json

get

/api/v1/orgs/{org_id}/projects/{project_id}/api-keys

HTTPcURLJavaScriptPython

GET /api/v1/orgs/{org_id}/projects/{project_id}/api-keys HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
      "name": "Production API Key",
      "api_key_masked": "sk-nc-kJ...E2xW",
      "created_at": "2024-01-01T12:00:00Z",
      "deleted_at": null
    }
  ]
}

Create API Key

post

Creates a new API key for a specific project. The API key value will be auto-generated and returned only once in the response.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstringRequired

Organization ID

project_idstringRequired

The project ID

Body

application/json

Request to create a new API key.

namestring · min: 1 · max: 255Required

A descriptive name for the API key.

Example: Production API Key

Responses

201

The API key was created successfully.

application/json

400

The request payload is invalid.

application/json

401

Unauthorized access.

application/json

404

The project was not found.

application/json

500

An unexpected internal server error occurred.

application/json

post

/api/v1/orgs/{org_id}/projects/{project_id}/api-keys

HTTPcURLJavaScriptPython

POST /api/v1/orgs/{org_id}/projects/{project_id}/api-keys HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "name": "Production API Key"
}

{
  "id": "a1b2c3d4-e5f6-7a8b-9c0d-1e2f3a4b5c6d",
  "name": "Production API Key",
  "api_key": "sk-nc-kJ8h3mN9pQ2wX5yR7tV1cB4nM6lK0fG8hD3sA9zE2xW",
  "created_at": "2024-01-01T12:00:00Z"
}

Delete API Key

delete

Soft deletes an API key by setting the deleted_at timestamp. The API key can no longer be used for authentication after deletion.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

org_idstringRequired

Organization ID

project_idstringRequired

The project ID

api_key_idstring · uuidRequired

The API key ID

Responses

204

The API key was deleted successfully.

400

The request is invalid.

application/json

401

Unauthorized access.

application/json

404

The API key was not found.

application/json

500

An unexpected internal server error occurred.

application/json

delete

/api/v1/orgs/{org_id}/projects/{project_id}/api-keys/{api_key_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/orgs/{org_id}/projects/{project_id}/api-keys/{api_key_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content