Skip to content
BookendBookend Docs

Update a settings namespace

PUT
/v1/settings/{ns}
curl --request PUT \
  --url http://localhost:8080/v1/settings/example \
  --header 'Content-Type: application/json' \
  --data '{ "values": { "additionalProperty": "example" } }'

Writes values (setting key to string value) for the namespace and returns the namespace afterwards. Unknown keys, keys of other namespaces and read-only keys are rejected; values must parse as the setting’s type; a blank secret keeps the stored value. Settings flagged restart-required take effect after a restart. Administrators only. 404 for an unknown namespace, 400 with one error per offending key.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ns
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
values
object
key
additional properties
string
Examplegenerated
{
  "values": {
    "additionalProperty": "example"
  }
}

Responses

Section titled “Responses”

200

Section titled “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
Examplegenerated
{
  "namespace": "example",
  "settings": [
    {
      "key": "example",
      "value": "example",
      "valueType": "example",
      "isSecret": true,
      "restartRequired": true,
      "readOnly": true,
      "description": "example"
    }
  ]
}