Create a runtime API key

POST /v1/admin/runtime/api-keys

• Operation ID: createRuntimeApiKey
• Tags: Runtime API keys
• Base URL: http://localhost:8787

Creates a key for the runtime itself (agent, driver or admin scope). The plaintext key is returned once and is never stored, logged or audited; the audit row records name, scope and pool/node only. Audited as runtime.api_key_create. Authenticates with a Platform staff JWT and permission, like every admin route; the backend calls the separate Runtime service on the caller's behalf (no Runtime API key is ever exposed or accepted).

Workflow: Integration guide.

Authentication: staff Bearer JWT with permission runtime.admin.

Authentication

• Auth: staff Bearer JWT (Authorization: Bearer <access_token>) with the permissions below.
• Required permissions: runtime.admin

Request body

Required: yes.

Content type: application/json

Schema: object

Field	Type	Required	Description
name	string	yes	Min length: 1. Max length: 200
scope	string	yes	One of: "admin", "agent", "driver"
poolId	string	no	Max length: 200
nodeId	string	no	Max length: 200
expiresAt	integer	no	Greater than: 0

Responses

201

Key created.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (RuntimeApiKeyCreated)

Field	Type	Required	Description
id	string	yes	-
name	string	yes	-
prefix	string	yes	-
scope	string	yes	One of: "admin", "agent", "driver"
poolId	string | null	yes	-
nodeId	string | null	yes	-
expiresAt	integer | null	yes	Expiry (Unix epoch milliseconds).
lastUsedAt	integer | null	yes	Last used (Unix epoch milliseconds).
revokedAt	integer | null	yes	Revoked (Unix epoch milliseconds).
createdAt	integer	yes	Created (Unix epoch milliseconds).
key	string	yes	Plaintext key. Returned only once, on creation.

Errors

400

Request validation failed.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody)

Field	Type	Required	Description
success	boolean	yes	One of: false
error	object	yes	-
error.name	string	yes	One of: "ZodError"
error.issues	object[]	yes	-
error.issues[].code	string	yes	-
error.issues[].path	(string | number)[]	yes	-
error.issues[].message	string	yes	-

Request validation

{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

403

Authenticated but lacking the required permission. details.perm lists the accepted permission keys.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "forbidden",
  "details": {
    "perm": "runtime.admin"
  }
}

404

not_found: the runtime does not know this resource.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "not_found"
}

409

conflict: the runtime rejected the change (details carry its message).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "conflict"
}

422

invalid_request: the runtime rejected the payload (details carry its message).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "invalid_request"
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

503

unavailable: the runtime could not be reached; retry.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "unavailable"
}

Examples

curl

curl -X POST 'http://localhost:8787/v1/admin/runtime/api-keys' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"name":"example","scope":"admin","poolId":"3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90","nodeId":"3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90","expiresAt":1}'

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/admin/runtime/api-keys", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "name": "example",
    "scope": "admin",
    "poolId": "3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90",
    "nodeId": "3f6c2a1e-8b4d-4e7a-9c1f-2d5b6a7e8f90",
    "expiresAt": 1
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();