Get a settings namespace

GET

/v1/settings/{ns}

curl --request GET \
  --url http://localhost:8080/v1/settings/example

Returns every known setting in the namespace with its current value, type (text, number, flag, json), description, and whether it is secret (values are masked), needs a restart, or is read-only (managed by the platform, such as wizard state and the signing key). Administrators only. 404 for an unknown namespace.

Parameters

Path Parameters

ns

required

string

Responses

200

OK

Media typeapplication/json

object

namespace

required

string

settings

required

Array<object>

object

key

required

string

value

required

null | string

valueType

required

string

isSecret

required

boolean

restartRequired

required

boolean

readOnly

required

boolean

description

required

string

Example^generated

{
  "namespace": "example",
  "settings": [
    {
      "key": "example",
      "value": "example",
      "valueType": "example",
      "isSecret": true,
      "restartRequired": true,
      "readOnly": true,
      "description": "example"
    }
  ]
}