API Keys

SDK Reference · Resource

API Keys

Create and revoke API keys for server-to-server integrations.

list()create()delete()

method

list()

List API keys

Returns API keys created by the authenticated account. Secret key values are returned only where the underlying account policy permits it.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.apiKeys.list(options: APIKeysListOptions = {}): Promise<APIKeysListResponse>

Parameters

Name	Type	Requirement	Description
limit	number	Optional	Number of results to return per page.
offset	number	Optional	The initial index from which to return the results.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.apiKeys.list();

Returns

PaginatedAPIKeyListList

The operation completed successfully.

typePaginatedAPIKeyListList4fields

FieldTypeRequirementDescription

count

number

Required

—

next

string

Optional

—

previous

string

Optional

—

results

APIKeyList[]

Required

—

typeAPIKeyList7fields

FieldTypeRequirementDescription

id

string

Optional

—

title

string

Required

Descriptive label that identifies the purpose or owner of this API key. Mobile App Dashboard Integration CI Pipeline

prefix

string

Required

—

key

string

Optional

The API key value used for authentication. Leave blank to have it generated automatically on save. Store this value securely.

allowed_ips

string[]

Required

—

created

string

Required

—

updated

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.apiKeys.listWithResponse(options): Promise<ApiResponse<APIKeysListResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.api_keys.list(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedAPIKeyList

Asyncawait async_client.api_keys.list(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> PaginatedAPIKeyList

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.api_keys.list()

Async example

result = await async_client.api_keys.list()

Returns

PaginatedAPIKeyList

The operation completed successfully.

classPaginatedAPIKeyList4fields

FieldTypeRequirementDescription

count

int

Required

—

results

list[APIKeyList]

Required

—

classAPIKeyList7fields

FieldTypeRequirementDescription

title

str

Required

Descriptive label that identifies the purpose or owner of this API key. Mobile App Dashboard Integration CI Pipeline

prefix

str

Required

—

allowed_ips

list[str]

Required

—

created

datetime.datetime

Required

—

updated

datetime.datetime

Required

—

id

str

Optional

—

key

str

Optional

The API key value used for authentication. Leave blank to have it generated automatically on save. Store this value securely.

next_

None | str

Optional

—

previous

None | str

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.api_keys.list_with_response(*, limit: int | Unset=UNSET, offset: int | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[PaginatedAPIKeyList]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->apiKeys()->list($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

Parameters

Name	Type	Requirement	Description
limit	int	Optional	Number of results to return per page.
offset	int	Optional	The initial index from which to return the results.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->apiKeys()->list();

Returns

PaginatedAPIKeyList

The operation completed successfully.

classPaginatedAPIKeyList4fields

FieldTypeRequirementDescription

count

int

Required

|

next

string

Required

| [optional]

previous

string

Required

| [optional]

results

[APIKeyList[]](APIKeyList.md)

Required

|

classAPIKeyList7fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

title

string

Required

Descriptive label that identifies the purpose or owner of this API key. Mobile App Dashboard Integration CI Pipeline |

prefix

string

Required

| [readonly]

key

string

Optional

The API key value used for authentication. Leave blank to have it generated automatically on save. Store this value securely.

allowedIps

array<string>

Required

| [readonly]

created

DateTime

Required

| [readonly]

updated

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->apiKeys()->listWithResponse($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->apiKeys()->listWithHttpInfo($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns the OpenAPI Generator response tuple.

• $client->apiKeys()->listAsync($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the decoded result.

• $client->apiKeys()->listAsyncWithHttpInfo($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Returns a Guzzle promise for the response tuple.

• $client->apiKeys()->listRequest($limit = null, $offset = null, $acceptLanguage = null, string $contentType = self::contentTypes['list'][0])

  Builds the PSR-7 request without sending it.

method

create()

Create an API key

Creates an API key for server-to-server access. allowed_ips can restrict the key to trusted IPv4 or IPv6 addresses.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.apiKeys.create(options: APIKeysCreateOptions = {}): Promise<APIKeysCreateResponse>

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	APIKeyCreateRequest	Optional	—

Example

const result = await client.apiKeys.create({
  body: {}
});

Returns

APIKeyCreate

The resource or action result was created successfully.

typeAPIKeyCreate5fields

FieldTypeRequirementDescription

id

string

Optional

—

title

string

Required

—

key

string

Required

—

allowed_ips

string[]

Optional

—

created

string

Required

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.apiKeys.createWithResponse(options): Promise<ApiResponse<APIKeysCreateResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.api_keys.create(*, body: APIKeyCreateRequest | Unset=UNSET, accept_language: str | Unset=UNSET) -> APIKeyCreate

Asyncawait async_client.api_keys.create(*, body: APIKeyCreateRequest | Unset=UNSET, accept_language: str | Unset=UNSET) -> APIKeyCreate

Parameters

Name	Type	Requirement	Description
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
body	APIKeyCreateRequest	Optional	—

Example

result = client.api_keys.create(
        body=models.APIKeyCreateRequest.from_dict({}),
    )

Async example

result = await async_client.api_keys.create(
        body=models.APIKeyCreateRequest.from_dict({}),
    )

Returns

APIKeyCreate

The resource or action result was created successfully.

classAPIKeyCreate5fields

FieldTypeRequirementDescription

title

str

Required

—

key

str

Required

—

created

datetime.datetime

Required

—

id

str

Optional

—

allowed_ips

list[str]

Optional

—

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.api_keys.create_with_response(*, body: APIKeyCreateRequest | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[APIKeyCreate]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->apiKeys()->create($acceptLanguage = null, $aPIKeyCreateRequest = null, string $contentType = self::contentTypes['create'][0])

Parameters

Name	Type	Requirement	Description
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.
aPIKeyCreateRequest	APIKeyCreateRequest	Optional	—

Example

$result = $client->apiKeys()->create(
    aPIKeyCreateRequest: new Dto\APIKeyCreateRequest([]),
);

Returns

APIKeyCreate

The resource or action result was created successfully.

classAPIKeyCreate5fields

FieldTypeRequirementDescription

id

string

Required

| [optional]

title

string

Required

| [readonly]

key

string

Required

| [readonly]

allowedIps

array<string>

Required

| [optional]

created

DateTime

Required

| [readonly]

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->apiKeys()->createWithResponse($acceptLanguage = null, $aPIKeyCreateRequest = null, string $contentType = self::contentTypes['create'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->apiKeys()->createWithHttpInfo($acceptLanguage = null, $aPIKeyCreateRequest = null, string $contentType = self::contentTypes['create'][0])

  Returns the OpenAPI Generator response tuple.

• $client->apiKeys()->createAsync($acceptLanguage = null, $aPIKeyCreateRequest = null, string $contentType = self::contentTypes['create'][0])

  Returns a Guzzle promise for the decoded result.

• $client->apiKeys()->createAsyncWithHttpInfo($acceptLanguage = null, $aPIKeyCreateRequest = null, string $contentType = self::contentTypes['create'][0])

  Returns a Guzzle promise for the response tuple.

• $client->apiKeys()->createRequest($acceptLanguage = null, $aPIKeyCreateRequest = null, string $contentType = self::contentTypes['create'][0])

  Builds the PSR-7 request without sending it.

method

delete()

Revoke an API key

Permanently revokes an API key owned by the authenticated account. Requests using the revoked key fail immediately.

JavaScript / TypeScriptPythonPHP

Signature

Promiseclient.apiKeys.delete(options: APIKeysDeleteOptions): Promise<APIKeysDeleteResponse>

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this API Key.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

const result = await client.apiKeys.delete({
  id: "550e8400-e29b-41d4-a716-446655440000"
});

Returns

void

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

• kind: "validation"The request arguments or business rules are invalid.
• kind: "authentication"Authentication credentials are missing, expired, or invalid.
• kind: "permission"The authenticated account cannot perform this operation.
• kind: "not_found"The requested resource does not exist.
• kind: "conflict"The operation conflicts with the current resource or idempotency state.
• kind: "network"The request could not reach ProxyRequest.
• kind: "unexpected"The response could not be decoded or did not match the SDK contract.

Advanced variants

• client.apiKeys.deleteWithResponse(options): Promise<ApiResponse<APIKeysDeleteResponse>>

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Syncclient.api_keys.delete(id: str, *, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> None

Asyncawait async_client.api_keys.delete(id: str, *, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> None

Parameters

Name	Type	Requirement	Description
id	str	Required	A unique value identifying this API Key.
idempotency_key	str	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
accept_language	str	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

result = client.api_keys.delete(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Async example

result = await async_client.api_keys.delete(
        id='550e8400-e29b-41d4-a716-446655440000',
    )

Returns

None

No response body

Throws

ApiError

Normalized API, transport, and response processing failure.

• ErrorKind.AUTHENTICATIONAuthentication credentials are missing, expired, or invalid.
• ErrorKind.PERMISSIONThe authenticated account cannot perform this operation.
• ErrorKind.NOT_FOUNDThe requested resource does not exist.
• ErrorKind.VALIDATIONThe request arguments or business rules are invalid.
• ErrorKind.CONFLICTThe operation conflicts with the current resource or idempotency state.
• ErrorKind.NETWORKThe request could not reach ProxyRequest.
• ErrorKind.UNEXPECTEDThe response could not be decoded or did not match the SDK contract.

Advanced variants

• client.api_keys.delete_with_response(id: str, *, idempotency_key: str | Unset=UNSET, accept_language: str | Unset=UNSET) -> ApiResponse[None]

  Returns response status, headers, ETag and idempotency metadata with the decoded data.

Signature

Sync$client->apiKeys()->delete($id, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

Parameters

Name	Type	Requirement	Description
id	string	Required	A unique value identifying this API Key.
idempotencyKey	string	Optional	Stable key for one logical mutation. Successful responses are replayable for 24 hours; reusing a key with a different request fails.
acceptLanguage	string	Optional	Preferred language for human-readable API errors. Supported languages: en, ru, uk, de, it, fr, es, zh-hans, ja. Regional language tags and quality weights are accepted; unsupported or omitted values use English.

Example

$result = $client->apiKeys()->delete(
    id: '550e8400-e29b-41d4-a716-446655440000',
);

Returns

void

No response body

Throws

ApiException

Normalized API, transport, and response processing failure.

• ErrorKind::AuthenticationAuthentication credentials are missing, expired, or invalid.
• ErrorKind::PermissionThe authenticated account cannot perform this operation.
• ErrorKind::NotFoundThe requested resource does not exist.
• ErrorKind::ValidationThe request arguments or business rules are invalid.
• ErrorKind::ConflictThe operation conflicts with the current resource or idempotency state.
• ErrorKind::NetworkThe request could not reach ProxyRequest.
• ErrorKind::UnexpectedThe response could not be decoded or did not match the SDK contract.

InvalidArgumentException

A required argument is missing or violates a local SDK constraint.

• local validationThe request was rejected before it was sent.

Advanced variants

• $client->apiKeys()->deleteWithResponse($id, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0]): \ProxyRequest\ApiResponse

  Returns an ApiResponse with decoded data and HTTP metadata.

• $client->apiKeys()->deleteWithHttpInfo($id, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Returns the OpenAPI Generator response tuple.

• $client->apiKeys()->deleteAsync($id, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Returns a Guzzle promise for the decoded result.

• $client->apiKeys()->deleteAsyncWithHttpInfo($id, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Returns a Guzzle promise for the response tuple.

• $client->apiKeys()->deleteRequest($id, $idempotencyKey = null, $acceptLanguage = null, string $contentType = self::contentTypes['delete'][0])

  Builds the PSR-7 request without sending it.