Update server config
Replaces the entire server configuration with the provided values. This is a bulk update operation primarily used for profile import functionality. Use this method when you need to apply a complete configuration snapshot, such as when importing settings from a saved profile or restoring a backup. For individual setting changes during normal operation, prefer UpdateServerConfigEntry. The new configuration is persisted to the database, and runtime hooks are triggered to apply changes immediately (e.g., log level adjustments).
Replaces the entire server configuration with the provided values. This is a bulk update operation primarily used for profile import functionality.
Use this method when you need to apply a complete configuration snapshot, such as when importing settings from a saved profile or restoring a backup. For individual setting changes during normal operation, prefer UpdateServerConfigEntry.
The new configuration is persisted to the database, and runtime hooks are triggered to apply changes immediately (e.g., log level adjustments).
Preferred API authentication. Use a JWT with the api audience.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "http://127.0.0.1:38765/v1/server/config" \ -H "Content-Type: application/json" \ -d '{}'{}{
"code": 0,
"grpc-code": "string",
"message": "string",
"stack-trace": "string",
"details": [
{}
]
}{
"code": 0,
"grpc-code": "string",
"message": "string",
"stack-trace": "string",
"details": [
{}
]
}{
"code": 0,
"grpc-code": "string",
"message": "string",
"stack-trace": "string",
"details": [
{}
]
}How is this page?
Get server info GET
Retrieves comprehensive server information including current configuration, all available settings definitions, settings page layouts, and registered plugins. This method is typically called when initializing a settings UI to obtain: 1. Current configuration values to populate form fields 2. Settings definitions describing each setting's type, constraints, and metadata 3. Page definitions for organizing settings into logical groups 4. Plugin information for displaying registered plugins
Update server config entry PUT
Updates a single configuration entry identified by namespace and key. This is a granular update operation for modifying individual settings. This is the preferred method for real-time UI interactions where users modify settings one at a time. It avoids overwriting unrelated settings and is more efficient than replacing the entire configuration. If the namespace doesn't exist, it will be created. If the key doesn't exist within the namespace, it will be added. Existing values are overwritten. The change is persisted to the database, and runtime hooks are triggered to apply the new value immediately where applicable.