Configure environment settings

Included in the Basic API.

You can use the Tonic Structural API to configure selected environment settings. The settings that you can configure are the same settings that are listed on the Environment Settings tab of Structural Settings.

Identify the settings that you can configure

To identify the settings that you can use the API to configure, use:

GET /api/environment/settings

For each setting, the response includes the setting name, the current value, and the default value.

Update an environment setting

To update the value of an environment setting, use:

POST /api/environment/settings/<setting name>

The request body provides the new value.

Restore an environment setting to the default value

For an environment setting that you can configure from the API, the default value is either:

• The setting value in the .yaml file.

• If the setting is not configured in the .yaml file, the Structural default value.

To restore the default value, use:

DELETE /api/environment/settings/<setting name>