Get deployment settings
GET /api/system_settings
GET /api/system_settingsInteractive request editor loads with JavaScript.
X-API-KEY<token>
In: header
Response Body
application/json
application/json
curl -X GET "$API_BASE_URL/api/system_settings"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
GET /api/system_settings
Get deployment settings
Retrieve current global deployment settings for the control plane. Use this endpoint to inspect active system-level configuration before making changes.
Parameters
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 GET '$API_BASE_URL/api/system_settings'