H2h2o
Configurations

Sets global configuration item.

Sets global configuration item (to be used by admins only).

put/configurations/{key_name}

Request

Path parameters

key_namestring required

The key of the configuration item that will be set.

Request body

string_valuestring required

The value to be set for the global config.

can_overwriteboolean required

Whether user settings can override this global setting.

is_publicboolean required

Whether users can see the value for this global setting.

value_typestring

The type of the value to be set for the global config.

Response

Successful operation

key_namestring required
string_valuestring required
value_typestring required
can_overwriteboolean required
upper_boundnumber
is_publicboolean required
is_read_onlyboolean
is_encryptedboolean
descriptionstring
categorystring
needs_propagationboolean

When true, mux resolves this key per-user (with role-priority overrides) and caches the resolved value for the duration of the global config_cache_ttl_seconds setting. The UI uses this flag to render an info icon explaining that changes take up to the cache-TTL seconds to propagate across all mux replicas.

Changes

No recorded changes to this operation across all 1 revision of this API.