Validate settings before applying them.

POST

/api/admin/settings/validate

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/settings/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "settings": { "additionalProperty": "example" } }'

Validate Setting in the Settings - General area. The request body is JSON unless the detailed schema for this operation states otherwise.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Header Parameters

X-Tenant-Id

string

Tenant selector for multi-tenant admin requests.

Request Body ^required

Media type application/json

object

settings

required

object

key

additional properties

key

additional properties

Example ^generated

{
  "settings": {
    "additionalProperty": "example"
  }
}

Responses

200

Legacy settings validation response.

Media type application/json

Legacy settings validation result.

object

key

additional properties

Example ^generated

{
  "additionalProperty": "example"
}