Update deployment settings

PUT /api/system_settings

Interactive request editor loads with JavaScript.

Authorization

X-API-KEY<token>

In: header

Request Body

application/json

dp_manager_address?array<>

DP manager address.

Items0 <= items <= 32

source?string

The source of the control plane address and Admin API address.

Value in

"database"
"config"

admin_api_address?string

The URL address of the Admin API.

Formaturl_scheme

file_server_address?string

The URL address of the file server for serving uploaded files.

Formaturl_scheme

Response Body

`application/json`

curl -X PUT "$API_BASE_URL/api/system_settings" \  -H "Content-Type: application/json" \  -d '{}'

Successfully retrieved or updated the system settings.

{
  "value": {
    "dp_manager_address": [],
    "source": "database",
    "admin_api_address": "https://192.168.101.10:7443",
    "file_server_address": "http://192.168.101.10:8080"
  }
}

Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.

{
  "value": {},
  "error_msg": "error message"
}

Complete operation details and schema variants

PUT /api/system_settings

Update deployment settings

Update global system settings that control dashboard deployment behavior and platform-wide defaults. This operation affects configuration used across managed gateway resources.

Required IAM Permission: Action gateway:UpdateDeploymentSetting, Resource arn:api7:gateway:gatewaysetting/*

Parameters

Request body

Content type: application/json

dp_manager_address (array, optional): DP manager address.
source (string, optional): The source of the control plane address and Admin API address.
admin_api_address (string, optional): The URL address of the Admin API.
file_server_address (string, optional): The URL address of the file server for serving uploaded files.

Responses

200: Successfully retrieved or updated the system settings.
allOf variant 1
value (object, optional): The specific resource.
allOf variant 2
value (object, optional):
value.dp_manager_address (array, optional): DP manager address.
value.source (string, optional): The source of the control plane address and Admin API address.
value.admin_api_address (string, optional): The URL address of the Admin API.
value.file_server_address (string, optional): The URL address of the file server for serving uploaded files.
400: Bad Request — The request was malformed or contained invalid parameters. Check the error_msg field for details.
value (object, optional): The specific resource.
error_msg (string, optional): The error message.

cURL

curl -X PUT '$API_BASE_URL/api/system_settings'

Update deployment settings

200application/json

400application/json

`application/json`

`application/json`