/bff/settings/env-known-keys

Returns the well-known CONFIGURATION_KEYS catalogue — every key the platform recognises along with its description and group prefix. Used by the admin "Add key" picker so operators can discover available keys instead of mistyping them.

SettingsgetBffSettingsEnv-known-keys

Parameters

No parameters required

This endpoint takes no path, query, header or body parameters.

Response schema

1 status code documented

200Success

itemsobject[]Required

Well-known configuration keys sorted by key.

Each array item:

keystringRequired

Canonical configuration key identifier.

descriptionstringRequired

Human-readable description of what the key controls.

groupstringRequired

First underscore-delimited segment used to group keys in the admin picker.

Examplescomgateemailergopayai

Response example

application/json

{
  "items": [
    {
      "key": "example_key",
      "description": "example_description",
      "group": "comgate"
    }
  ]
}

Request example

GET /bff/settings/env-known-keys

get

curl -X GET "https://api.bizkithub.com/bff/settings/env-known-keys" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key