Update settings

PUT

/api/v1/settings

const url = 'https://example.com/api/v1/settings';
const options = {
  method: 'PUT',
  headers: {'X-Label-Hub-Key': '<X-Label-Hub-Key>', 'Content-Type': 'application/json'},
  body: '{"values":{}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request PUT \
  --url https://example.com/api/v1/settings \
  --header 'Content-Type: application/json' \
  --header 'X-Label-Hub-Key: <X-Label-Hub-Key>' \
  --data '{ "values": {} }'

Authorizations

APIKeyHeader

Request Body^required

application/json

SettingsUpdate

Documented request body of PUT /api/v1/settings (parsed by hand, see the route).

object

values

required

Values

object

key

additional properties

any

Example ^generated

{
  "values": {}
}

Responses

200

Successful Response

application/json

Response Update Settings Api V1 Settings Put

Array<object>

SettingView

object

choices

Choices

Array<string>

is_set

required

Is Set

boolean

key

required

Key

string

kind

required

Kind

string

Allowed values: str int float bool url secret enum

locked

required

Locked

boolean

state

State

string

default: ok

Allowed values: ok undecryptable env_secret_needs_env_url

value

Value

Any of:

unknown
null

Example

[
  {
    "kind": "str",
    "state": "ok"
  }
]

Update settings

Authorizations

Request Bodyrequired

Example generated

Responses

200

Example

Request Body^required

Example ^generated