Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

ApiKey

Create a new API key

Used to create a new API key

post/workspaces/{workspace_id}/apiKeys

Path parameters

workspace_idstring required

The ID of the workspace in which the key should be created

Request body

time_to_livestring

The time to live for this API key specified in ISO-8601 duration format

namestring required

Friendly name for this API key

type'agent_review' | 'ci_cd_integration' | 'command_line_interface' | 'custom' | 'database_query_execution' | 'deployment_trigger' | 'editor' | 'execution' | 'issue_tracker' | 'link_agent' | 'reporting' | 'selenium_agent' | 'test_authoring' | 'usage_analytics' | 'user_management' | 'viewer' | 'workspace_admin' | 'workspace_setup' required

The intended use of this API key

workspace_idstring

The ID of the workspace associated with this API key

Response

The API Key that was created

idstring

The ID of the API key, NOT the raw API Key secret

secret_keystring

secret API key (may not be returned from all endpoints)

secret_key_hashstring

Secure key hash (may not be returned from all endpoints)

secret_key_hash_cypherstring

Secure key hash type (may not be returned from all endpoints)

encrypted_secret_keystring

Encrypted secret API key (may not be returned from all endpoints)

created_timeinteger

Time at which the API key was created

created_by_idstring

The ID of the user who created this API key

deleted_timeinteger

Time at which the API key was deleted

deleted_by_idstring

The ID of the client/user who deleted this API key

expiration_timeinteger

Time at which this API key will expire

last_updated_timeinteger

Time at which the organization API key was last updated

last_updated_by_idstring

The ID of the user who last updated this API key

organization_idstring

DEPRECATED - The ID of the organization associated with this API key

namestring

Friendly name for this API key

type'agent_review' | 'ci_cd_integration' | 'command_line_interface' | 'custom' | 'database_query_execution' | 'deployment_trigger' | 'editor' | 'execution' | 'impersonation' | 'integration' | 'issue_tracker' | 'link_agent' | 'login' | 'reporting' | 'selenium_agent' | 'test_authoring' | 'usage_analytics' | 'user_management' | 'viewer' | 'workspace_admin' | 'workspace_invitation_acceptance' | 'workspace_setup'

The intended use of this API key

enabledboolean

False if key authentication should be paused

workspace_idstring

The ID of the workspace associated with this API key. Mutually exclusive with company_id.

company_idstring

The ID of the company associated with this API key. Set for company-scoped keys that grant access to all workspaces owned by the company. Mutually exclusive with workspace_id.