Skip to content
OpenPostDocs
OpenPostDocs
Admin

Save administrator-managed instance settings

Validates and encrypts optional instance settings atomically. Changes apply after the server restarts.

PUT/admin/instance-settings

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/problem+json

curl -X PUT "https://example.com/admin/instance-settings" \  -H "Content-Type: application/json" \  -d '{    "settings": [      {        "key": "string"      }    ]  }'
{  "$schema": "https://example.com/api/v1/schemas/InstanceSettingsResponse.json",  "requires_restart": true,  "settings": [    {      "configured": true,      "database_override_configured": true,      "description": "string",      "editable": true,      "environment_variables": [        "string"      ],      "group": "string",      "key": "string",      "label": "string",      "managed_by": "string",      "optional": true,      "options": [        {          "label": "string",          "value": "string"        }      ],      "requires_restart": true,      "secret": true,      "secret_configured": true,      "source": "environment",      "type": "boolean",      "updated_at": "string",      "value": "string"    }  ]}