Update system settings

PATCH

/api/access/admin/settings

Maintainer:Not configured

OperationId:admin_update_settings

Partial update: each field present overwrites its setting, each field absent is left unchanged. Requires a system admin.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Settings after the partial update

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/access/admin/settings' \
--header 'X-Temper-Surface;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "gating_team_slug": "string",
    "instance_name": "string",
    "terms_resource_uri": "string",
    "terms_version": "string"
}'

Response Example

200 - Example 1

{
    "gating_team_slug": "string",
    "id": 0,
    "instance_name": "string",
    "terms_resource_uri": "string",
    "terms_version": "string",
    "updated": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-10-06 12:32:37

Read full system settings

Erase a principal