Get the value of a setting

Get the current value of a specific setting

get/settings/{settingId}

Request

Base URL
https://rudder.example.com/rudder/api/latest
Auth
API key in header X-API-Token
TypeScript
https://skmtc.dev/rudder/apis/rudder-api/docs/settings/:settingId/get.ts
A function with typed inputs. Its response is checked against the schema.

settingIdstring required

Example:global_policy_mode

Id of the setting to set

Settings

idstring required

Id of the setting

result'success' | 'error' required

Result of the request

action'getSetting' required

The id of the action

{
  "id": "global_policy_mode",
  "data": {
    "settingId": "allowed_networks"
  }
}

No recorded changes to this operation across all 7 revisions of this API.