Applications

Issue an API key for an application (key returned once)

post/applications/{id}/keys

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/applications/{id}/keys
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Request body

namestring
environment'production' | 'staging' | 'development'

Response

Created; the full secret is present only in this response

idstring required
application_idstring required

The application the key belongs to.

namestring required
prefixstring required

The stored, non-secret prefix that identifies the key, for example cd_live_ab12cd34.

environment'production' | 'staging' | 'development' required
scopesstring[]
is_defaultboolean required

true on the workspace default key (at most one active per workspace).

last_used_atstring date-time

When the key last authenticated a request. Absent until it has been used.

created_atstring date-time required
revoked_atstring date-time

When the key was revoked. Absent while the key is active.

keystring

cd_live_… or cd_test_…; shown once, stored hashed

Changes

No recorded changes to this operation across all 1 revision of this API.