Create an API key (admin)

Authorization

AdminKeyAuth

AGENTBOX-API-KEY<token>

Admin-level API key. Same header as ApiKeyAuth but requires admin role.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

namespace?string

Kubernetes namespace to associate the key with.

user?string

Username to associate the key with.

team?string

Team name to associate the key with.

description?string

Optional human-readable description for this key.

expiresAt?string

Optional RFC 3339 expiry timestamp. Omit for a non-expiring key.

Formatdate-time

tokenHash?string

Full SHA-256 hex hash of the raw token (64 hex chars). When provided together with hashPrefix, the key is imported using the given hash instead of generating a new random token. The operation is idempotent — if a key with the same hash already exists it is silently accepted. Admin-only.

hashPrefix?string

First 16 hex characters of the tokenHash. Required when tokenHash is provided.

issuedAt?string

Original issue timestamp (import mode). Used to preserve the original creation time. Ignored when tokenHash is not provided.

Formatdate-time

Response Body

`application/json`

curl -X POST "https://admin/api-keys" \  -H "Content-Type: application/json" \  -d '{}'

{  "apiKey": "string",  "keyId": "string",  "user": "string",  "team": "string",  "role": "string",  "description": "string",  "issuedAt": "2019-08-24T14:15:22Z",  "expiresAt": "2019-08-24T14:15:22Z"}

{  "error": "string",  "errorCode": "API_KEY_REQUIRED",  "detail": null}

{  "error": "string",  "errorCode": "API_KEY_REQUIRED",  "detail": null}

{  "error": "string",  "errorCode": "API_KEY_REQUIRED",  "detail": null}

{  "error": "string",  "errorCode": "API_KEY_REQUIRED",  "detail": null}

Create an API key (admin)

Authorization

Request Body

Response Body

201application/json

400application/json

401application/json

403application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`