POST/api-keys/scope-catalog

Get the API-key scope catalog

Returns the supported project API-key resources, actions, and scope strings.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Request body

application/json

Responses

200application/json

Current supported API-key scopes.

{
  "status": "success",
  "data": {
    "resources": [
      {
        "id": "",
        "path_prefix": "string",
        "actions": [
          "read"
        ],
        "scopes": [
          "v1.checks:read"
        ]
      }
    ]
  }
}

400application/json

The request body, parameter, filter, cursor, or project-scoping pattern is invalid.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}

statusstringrequired

messagestringrequired

codestringoptional

Stable machine-readable code when the error defines one.

detailobjectoptional

quotaoptional

featurestringoptional

dependencystringoptional

401application/json

Authentication is missing or the credential is invalid, inactive, expired, or lacks the required scope.

{
  "status": "error",
  "message": "string",
  "code": "string",
  "detail": {},
  "quota": {
    "key": "string",
    "limit": 1,
    "used": 1
  },
  "feature": "string",
  "dependency": "string"
}