Create API key

Generate a new API key for an app

POST /api-auth/apps/{app_name}/keys

Create API key

cURL

curl --request POST \
  --url https://api.wacht.dev/api-auth/apps/{app_name}/keys \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Production Key",
  "key_prefix": "wacht_prod",
  "scope_preset": "read_write",
  "permissions": [
    "<string>"
  ],
  "metadata": {},
  "expires_at": "2024-12-31T23:59:59Z"
}
'

200

{
  "id": "1234567890123456789",
  "app_id": "9876543210987654321",
  "deployment_id": "1111111111111111111",
  "name": "Production Key",
  "key_prefix": "wacht_prod",
  "key_suffix": "abcd",
  "permissions": [
    "<string>"
  ],
  "metadata": {},
  "expires_at": "2023-11-07T05:31:56Z",
  "last_used_at": "2023-11-07T05:31:56Z",
  "is_active": true,
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "revoked_at": "2023-11-07T05:31:56Z",
  "revoked_reason": "<string>",
  "secret": "<string>"
}

Authorizations

Authorization · string · header · required

API key authentication (format: Bearer {api_key})

Path Parameters

app_name · string · required

API Auth app name

Body

application/json

name · string · required

API key name

Example:

"Production Key"

key_prefix · string

Key prefix (required for backend API, optional for console)

Example:

"wacht_prod"

scope_preset · enum<string>

Permission preset

Available options: default, read_only, read_write, admin, custom

Example:

"read_write"

permissions · string[]

Custom permissions (used when scope_preset is custom)

metadata · object

Additional metadata

expires_at · string<date-time>

Expiration timestamp

Example:

"2024-12-31T23:59:59Z"

Response

200

application/json

API key created

id · string

Key ID

Example:

"1234567890123456789"

app_id · string

App ID

Example:

"9876543210987654321"

deployment_id · string

Deployment ID

Example:

"1111111111111111111"

name · string

Key name

Example:

"Production Key"

key_prefix · string

Key prefix

Example:

"wacht_prod"

key_suffix · string

Key suffix (last 4 characters)

Example:

"abcd"

permissions · string[]

Granted permissions

metadata · object

Additional metadata

expires_at · string<date-time> | null

Expiration timestamp

last_used_at · string<date-time> | null

Last used timestamp

is_active · boolean

Whether the key is active

Example:

true

created_at · string<date-time>

Creation timestamp

Example:

"2024-01-15T10:30:00Z"

updated_at · string<date-time>

Last update timestamp

Example:

"2024-01-15T10:30:00Z"

revoked_at · string<date-time> | null

Revocation timestamp

revoked_reason · string | null

Reason for revocation

secret · string

Full API key (only shown on creation)