Api Keys

List Api Keys

get

List API keys for projects the user has access to.

If project_id is provided, returns keys for that project only. If no project_id, returns keys for all projects the user can access.

Plaintext keys are never returned - only metadata.

Requires: read access to the project(s)

Query parameters

project_idany ofOptional

stringOptional

or

nullOptional

include_revokedbooleanOptionalDefault: false

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for API key (without plaintext).

key_idstringRequired

project_idstringRequired

team_idstringRequired

org_idstringRequired

namestringRequired

scopesstring[]Required

statusstringRequired

key_suffixstringRequired

created_atstringRequired

expires_atany ofOptional

stringOptional

or

nullOptional

last_used_atany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/admin/api-keys

HTTPcURLJavaScriptPython

GET /v1/admin/api-keys HTTP/1.1
Accept: */*

[
  {
    "key_id": "text",
    "project_id": "text",
    "team_id": "text",
    "org_id": "text",
    "name": "text",
    "scopes": [
      "text"
    ],
    "status": "text",
    "key_suffix": "text",
    "created_at": "text",
    "expires_at": "text",
    "last_used_at": "text"
  }
]

Create Api Key

post

Generate a new API key for a project.

IMPORTANT: The plaintext API key is returned ONLY ONCE. Store it securely - it cannot be retrieved later.

Requires: project_admin role or higher for the project

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

application/json

Request to create a new API key.

project_idstringRequired

namestringRequired

scopesstring[]OptionalDefault: ["read:services","write:services"]

expires_in_daysany ofOptional

integerOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/v1/admin/api-keys

HTTPcURLJavaScriptPython

POST /v1/admin/api-keys HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 73

{
  "project_id": "text",
  "name": "text",
  "scopes": [
    "text"
  ],
  "expires_in_days": 1
}

{
  "api_key": "text",
  "key_id": "text",
  "project_id": "text",
  "name": "text",
  "scopes": [
    "text"
  ],
  "warning": "Store this API key securely. It will not be shown again."
}

Get Api Key

get

Get API key details by ID.

Plaintext key is never returned.

Requires: read access to the project

Path parameters

key_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for API key (without plaintext).

key_idstringRequired

project_idstringRequired

team_idstringRequired

org_idstringRequired

namestringRequired

scopesstring[]Required

statusstringRequired

key_suffixstringRequired

created_atstringRequired

expires_atany ofOptional

stringOptional

or

nullOptional

last_used_atany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

get

/v1/admin/api-keys/{key_id}

HTTPcURLJavaScriptPython

GET /v1/admin/api-keys/{key_id} HTTP/1.1
Accept: */*

{
  "key_id": "text",
  "project_id": "text",
  "team_id": "text",
  "org_id": "text",
  "name": "text",
  "scopes": [
    "text"
  ],
  "status": "text",
  "key_suffix": "text",
  "created_at": "text",
  "expires_at": "text",
  "last_used_at": "text"
}

Revoke Api Key

delete

Revoke an API key.

Revoked keys cannot be used for authentication. This is a soft delete - the key metadata is retained for audit purposes.

Requires: project_admin role or higher

Path parameters

key_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

204

Successful Response

422

Validation Error

application/json

delete

/v1/admin/api-keys/{key_id}

HTTPcURLJavaScriptPython

DELETE /v1/admin/api-keys/{key_id} HTTP/1.1
Accept: */*

No content

Update Api Key

patch

Update API key metadata (name, scopes).

The actual key value cannot be changed - use rotation instead.

Requires: project_admin role or higher

Path parameters

key_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Body

application/json

Request to update API key metadata.

nameany ofOptional

stringOptional

or

nullOptional

scopesany ofOptional

string[]Optional

or

nullOptional

Responses

200

Successful Response

application/json

Response model for API key (without plaintext).

key_idstringRequired

project_idstringRequired

team_idstringRequired

org_idstringRequired

namestringRequired

scopesstring[]Required

statusstringRequired

key_suffixstringRequired

created_atstringRequired

expires_atany ofOptional

stringOptional

or

nullOptional

last_used_atany ofOptional

stringOptional

or

nullOptional

422

Validation Error

application/json

patch

/v1/admin/api-keys/{key_id}

HTTPcURLJavaScriptPython

PATCH /v1/admin/api-keys/{key_id} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "name": "text",
  "scopes": [
    "text"
  ]
}

{
  "key_id": "text",
  "project_id": "text",
  "team_id": "text",
  "org_id": "text",
  "name": "text",
  "scopes": [
    "text"
  ],
  "status": "text",
  "key_suffix": "text",
  "created_at": "text",
  "expires_at": "text",
  "last_used_at": "text"
}

Rotate Api Key

post

Rotate an API key.

Generates a new key and revokes the old one. The new plaintext key is returned ONLY ONCE.

Requires: project_admin role or higher

Path parameters

key_idstringRequired

Header parameters

authorizationany ofOptional

stringOptional

or

nullOptional

X-Atlas-API-Keyany ofOptional

stringOptional

or

nullOptional

Responses

200

Successful Response

application/json

Response when creating a new API key (includes plaintext ONCE).

api_keystringRequired

key_idstringRequired

project_idstringRequired

namestringRequired

scopesstring[]Required

warningstringOptionalDefault: Store this API key securely. It will not be shown again.

422

Validation Error

application/json

post

/v1/admin/api-keys/{key_id}/rotate

HTTPcURLJavaScriptPython

POST /v1/admin/api-keys/{key_id}/rotate HTTP/1.1
Accept: */*

{
  "api_key": "text",
  "key_id": "text",
  "project_id": "text",
  "name": "text",
  "scopes": [
    "text"
  ],
  "warning": "Store this API key securely. It will not be shown again."
}