Skip to main content

ApiKeyInfo

ApiKeyInfo

id

The ID of this API key.

name

The name of this API key.

created_at

When this API key was created, formatted as an ISO 8601 timestamp (e.g. 2025-12-31T10:15:45+00:00)

expires_at

created_by

The email address of the user who created this API key.

last_used_at

status

The current status of this API key (active or expired).

api_key_hint

Partial API key hint

ApiKeyStatus

ApiKeyStatus

ACTIVE

EXPIRED

ClientApiKeyCreateRequest

ClientApiKeyCreateRequest

name

expiration_days

The number of days until the API key expires.

ClientApiKeyCreateResponse

ClientApiKeyCreateResponse

id

The ID of this API key.

name

The name of this API key.

created_at

When this API key was created, formatted as an ISO 8601 timestamp (e.g. 2025-12-31T10:15:45+00:00)

expires_at

created_by

The email address of the user who created this API key.

last_used_at

status

The current status of this API key (active or expired).

api_key_hint

Partial API key hint

api_key

The API key secret.

ClientApiKeyListResponse

ClientApiKeyListResponse

api_keys

The fetched page of API keys.

total_pages

The total number of pages of API keys. Use the request arguments page_number and page_size to control which API keys are fetched.

page_number

The number of the fetched page.

page_size

The page size, i.e. number of API keys, fetched.