Sign in
API Keys

List the scope catalog

Every scope an API key may hold, nested by resource with the actions a route actually requires. Static and cacheable. For what an omitted scopes mints for YOUR credential see GET /v1/auth/whoami → credential.defaultScopes; the most you may mint is credential.scopes. Requires no scope.

get/v1/api-keys/scopes

Response

The scope catalog

Example response

{
  "resources": [
    {
      "key": "runs",
      "label": "Runs",
      "description": "Start runs and read their results",
      "actions": [
        {
          "key": "create",
          "description": "POST /v1/run — start a run"
        }
      ]
    }
  ]
}

Changes

Changed in 1 of the 22 revisions of this API.1