Appearance
List runtime API keys
GET /v1/admin/runtime/api-keys
- Operation ID:
listRuntimeApiKeys - Tags: Runtime API keys
- Base URL:
http://localhost:8787
Key metadata only (prefix, scope, expiry); plaintext keys are never listed. Requires runtime.admin even for reads. If the runtime is unreachable the response is still 200 with { available: false }. 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
Responses
200
API keys.
- Header
x-request-id: Request identifier; quote it when reporting an error. Content type:application/json
Schema: object | object (RuntimeUnavailable)
| Field | Type | Required | Description |
|---|---|---|---|
(variant 1).available | boolean | yes | One of: true |
(variant 1).data | object | yes | - |
(variant 1).data.items | (object (RuntimeApiKey))[] | yes | - |
(variant 1).data.items[].id | string | yes | - |
(variant 1).data.items[].name | string | yes | - |
(variant 1).data.items[].prefix | string | yes | - |
(variant 1).data.items[].scope | string | yes | One of: "admin", "agent", "driver" |
(variant 1).data.items[].poolId | string | null | yes | - |
(variant 1).data.items[].nodeId | string | null | yes | - |
(variant 1).data.items[].expiresAt | integer | null | yes | Expiry (Unix epoch milliseconds). |
(variant 1).data.items[].lastUsedAt | integer | null | yes | Last used (Unix epoch milliseconds). |
(variant 1).data.items[].revokedAt | integer | null | yes | Revoked (Unix epoch milliseconds). |
(variant 1).data.items[].createdAt | integer | yes | Created (Unix epoch milliseconds). |
(variant 1).data.nextCursor | string | null | yes | - |
(variant 2).available | boolean | yes | One of: false |
Errors
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
json
{
"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
json
{
"error": "forbidden",
"details": {
"perm": "runtime.admin"
}
}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
json
{
"error": "internal"
}Examples
curl
bash
curl -X GET 'http://localhost:8787/v1/admin/runtime/api-keys' \
-H "Authorization: Bearer $ACCESS_TOKEN"TypeScript
ts
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: "GET",
headers: {
"Authorization": `Bearer ${accessToken}`,
},
});
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();