Admin API keys

Server

sk-admin-… keys for this API and the MCP server. These routes only accept a dashboard session (with 2FA); an admin API key gets 403.

List admin API keys

GET

https://ai.brandkamu.id/api/admin

/api-keys

All active (not revoked) admin API keys of every admin, newest first. Dashboard session only.

List admin API keys › Responses

The keys.

AdminApiKey[]

AdminApiKey

id

string · uuid · required

name

string · required

key_prefix

string · required

e.g. sk-admin-****a1b2.

read_only

boolean · required

expires_at

string | null · date-time · required

allowed_ips

array | null · required

last_used_at

string | null · date-time · required

last_used_ip

string | null · required

owner_email

string | null · required

created_at

string · date-time · required

Create an admin API key

POST

https://ai.brandkamu.id/api/admin

/api-keys

Creates a key owned by the signed-in admin. The full key is returned once; only a hash is stored. At most 20 active admin keys can exist. Dashboard session only.

Create an admin API key › Request Body

AdminApiKeyInput

name

string · minLength: 1 · maxLength: 100 · required

read_only

boolean

Only GET/HEAD requests allowed.

Default: false

expires_at

string | null · date-time

Must be in the future; null never expires.

allowed_ips

array | null · maxItems: 50

IP addresses or CIDR ranges (e.g. 203.0.113.7, 10.0.0.0/8, 2001:db8::/32); empty or null allows any.

Create an admin API key › Responses

The new key, including the secret.

id

string · uuid · required

key

string · required

The full sk-admin-… key. Shown only here.

key_prefix

string · required

Display form, e.g. sk-admin-****a1b2.

name

string · required

POST/api-keys

curl https://ai.brandkamu.id/api/admin/api-keys \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "Billing reconciliation script",
  "read_only": true,
  "expires_at": "2027-01-01T00:00:00Z",
  "allowed_ips": [
    "203.0.113.7",
    "10.0.0.0/8"
  ]
}'

Example Request Body

{
  "name": "Billing reconciliation script",
  "read_only": true,
  "expires_at": "2027-01-01T00:00:00Z",
  "allowed_ips": [
    "203.0.113.7",
    "10.0.0.0/8"
  ]
}

json

application/json

Example Responses

{
  "id": "0b9a7c52-8e7d-4d3a-9c1e-4f6a2b8d0e11",
  "key": "sk-admin-AbCdEfGhIjKlMnOpQrStUvWxYz0123456789AbCdEfGhIjKl",
  "key_prefix": "sk-admin-****IjKl",
  "name": "Billing reconciliation script"
}

json

application/json

Update an admin API key

PUT

https://ai.brandkamu.id/api/admin

/api-keys/{id}

Replaces the key's name, access level, expiry and IP allow-list (omitted expires_at / allowed_ips clear them). Dashboard session only.

Update an admin API key › path Parameters

id

string · uuid · required

Admin API key id.

Update an admin API key › Request Body

AdminApiKeyInput

name

string · minLength: 1 · maxLength: 100 · required

read_only

boolean

Only GET/HEAD requests allowed.

Default: false

expires_at

string | null · date-time

Must be in the future; null never expires.

allowed_ips

array | null · maxItems: 50

IP addresses or CIDR ranges (e.g. 203.0.113.7, 10.0.0.0/8, 2001:db8::/32); empty or null allows any.

Update an admin API key › Responses

The updated key.

AdminApiKey

id

string · uuid · required

name

string · required

key_prefix

string · required

e.g. sk-admin-****a1b2.

read_only

boolean · required

expires_at

string | null · date-time · required

allowed_ips

array | null · required

last_used_at

string | null · date-time · required

last_used_ip

string | null · required

owner_email

string | null · required

created_at

string · date-time · required

PUT/api-keys/{id}

curl https://ai.brandkamu.id/api/admin/api-keys/:id \
  --request PUT \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "name": "name",
  "read_only": false,
  "expires_at": "2024-08-25T15:00:00Z",
  "allowed_ips": [
    "string"
  ]
}'

Example Request Body

{
  "name": "name",
  "read_only": false,
  "expires_at": "2024-08-25T15:00:00Z",
  "allowed_ips": [
    "string"
  ]
}

json

Example Responses

{
  "id": "00000000-0000-0000-0000-000000000000",
  "name": "name",
  "key_prefix": "key_prefix",
  "read_only": true,
  "expires_at": "2024-08-25T15:00:00Z",
  "allowed_ips": [
    "string"
  ],
  "last_used_at": "2024-08-25T15:00:00Z",
  "last_used_ip": "last_used_ip",
  "owner_email": "owner_email",
  "created_at": "2024-08-25T15:00:00Z"
}

json

application/json

Revoke an admin API key

DELETE

https://ai.brandkamu.id/api/admin

/api-keys/{id}

Revokes the key at once. Dashboard session only.

Revoke an admin API key › path Parameters

id

string · uuid · required

Admin API key id.

Revoke an admin API key › Responses

Done.

ok

boolean · const · required

Const value:

Settings Audit