/system
Returns system initialization status and version information.
Response
Retrieves system configuration.
Request Body
Request Body
Request Body
Request Body
Request Body
Request Body
Checks for system updates.
Performs system update.
Request Body
Request Body
HTTP notification values follow back/data/notify.ts. They differ from the in-script gRPC enum; for example, the HTTP Chronocat value is Chronocat.
Request Body
Response Headers
Content-type: application/octet-streamQL-Task-Pid: <process_id>QL-Task-Log: <relative_log_path>The response streams command output and closes when the task finishes. It is not a JSON response.
Request Body
Returns a compressed backup download. Pass a JSON body such as {"type":["scripts","config","log"]} to include these additional data directories. Omitting type or passing an empty array exports only db and upload, excluding scripts, configuration and logs. base denotes the base data, not an extra directory. See the maintenance guide for a complete backup.
Request
multipart/form-datadata (file)Upload the exported data.tgz. This endpoint only extracts the backup into the temporary directory. After a successful import, call PUT /open/system/reload with {"type":"data"} to replace the current data and restart the service. Replacement clears the existing data directory; directories absent from the backup are not retained. Back up current data before applying the import.
Query Parameters
Logs are filtered by file creation date. Start and end times expand to the beginning and end of their respective days; omitted values default to today. The response is raw log text. When it exceeds limit, the tail of the selected logs is returned. X-QL-Log-Total reports total matching bytes, X-QL-Log-Truncated indicates truncation, and Content-Length reports returned bytes. This endpoint does not use the regular Log API’s offset/nextOffset pagination structure.
Deletes system logs.
All endpoints follow the same error handling pattern:
{ code: 200, data: ... }YYYY-MM-DD-HH-mm-ss-SSS| Method | Full path | Description |
|---|---|---|
| GET | /open/system/client-ip/config |
Read trusted proxy configuration |
| PUT | /open/system/client-ip/config |
Update with { "trustProxy": "..." }; maximum 500 characters |
| GET | /open/system/client-ip/diagnose |
Diagnose client IP resolution for this request |
Under /open/system/storage-retention, PUT /config saves retention policy, POST /preview previews cleanup, and POST /cleanup performs cleanup.
| Field | Type | Description |
|---|---|---|
runningInstanceRetentionDays |
number | Required integer retention days, 0–3650 |
cronStatRetentionDays |
number | Required integer retention days, 0–3650 |
dependenceCacheTypes |
string[] | Optional for preview/cleanup: node, python3; default empty |
compactDatabase |
boolean | Optional for preview/cleanup; default false |
confirmation |
string | Required only for cleanup; must be CLEAN |
Preview the selected policy before applying cleanup. This example only previews:
See the route reference for the remaining system endpoints and CLI commands.