Get Setting

Получение значения конкретной настройки по ключу.

GET /settings/{key}

Get Setting

cURL

curl --request GET \
  --url https://api.example.com/settings/{key} \
  --header 'X-API-Key: <api-key>'

200

{
  "key": "<string>",
  "name": "<string>",
  "category": {
    "key": "<string>",
    "label": "<string>"
  },
  "type": "<string>",
  "is_optional": true,
  "has_override": true,
  "current": null,
  "original": null,
  "read_only": false,
  "choices": [
    {
      "value": "<unknown>",
      "label": "<string>",
      "description": "<string>"
    }
  ]
}

Authorizations

X-API-Key · string · header · required

Path Parameters

key · string · required

Response

200

application/json

Successful Response

Полное описание настройки и её текущего состояния.

key · string · required

name · string · required

category · SettingCategoryRef · object · required

Ссылка на категорию, к которой относится настройка.

Show child attributes

type · string · required

is_optional · boolean · required

has_override · boolean · required

current · unknown

original · unknown

read_only · boolean · default: false

choices · SettingChoice · object[]

Show child attributes