List supported resource schemes

Returns the list of supported resource URI schemes. Used by the CLI for discovery of available resource types.

GET /api/resolve/schemes

List supported resource schemes

cURL

curl --request GET \
  --url https://platform.kodexa.ai/api/resolve/schemes \
  --header 'x-api-key: <api-key>'

200

[
  {
    "description": "<string>",
    "endpointPattern": "/api/modules",
    "scheme": "module",
    "scope": "organization"
  }
]

Authorizations

x-api-keybearerAuth

x-api-key · string · header · required

API key for authentication. Create one from the Kodexa platform UI under Settings > Access Tokens.

Response

200

application/json

List of supported schemes

description · string

Human-readable description of the resource type.

endpointPattern · string

The API endpoint pattern for this resource type.

Example:

"/api/modules"

scheme · string

The URI scheme name.

Example:

"module"

scope · string

The scope of the resource (e.g., 'organization').

Example:

"organization"