GET/v1/definitions/{key}/api-keys

Read definitions key api-keys

The ingestion keys minted on one record page: each key's name, prefix, scopes, when it was made, when it was last used and whether it is revoked. The SECRET is never here — it existed once, in the answer that minted it. Workspace admin, because key metadata is the page's shape. For what one key has actually been doing, read get_definitions_key_api-keys_keyId_usage.

Access class: def:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

keypath · stringrequired

bodyquery · nulloptional

paramsquery · objectoptional

:keystringoptional

queryquery · objectoptional

Responses

200application/json

the action's answer

{
  "data": [
    {
      "boardId": "",
      "createdAt": "string",
      "id": "",
      "keyPrefix": "string",
      "lastUsedAt": "string",
      "name": "string",
      "scopes": [
        "string"
      ]
    }
  ]
}

dataarray<>required

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired