System Setup
The System Setup endpoints return appliance information and status, list and stop backups, issue client authentication certificates, manage the portal TLS certificate, configure Loki and Splunk log forwarding, and create support packages.
For the corresponding user interface, refer to the System Setup section.
Endpoints
Returns basic information about the appliance, used by the client tools.
Example Request
curl -X GET "https://<your domain>/api/system_setup/GetSystemInfoTool" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
GET /system_setup/backup_list/
Returns the backup archives held on the appliance, with the date of each.
Example Request
curl -X GET "https://<your domain>/api/system_setup/backup_list/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
POST /system_setup/generate_p12/
Issues a client certificate that a signing tool presents when connecting. The file is returned by the response; its password is sent in the X-Certificate-Password response header.
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| certificate_name | string | Yes | Name for the client certificate. |
| username | string | Yes | Account the certificate is issued to. |
| expiry_days | integer | No | Lifetime of the certificate in days. |
| algo | string | No | Key algorithm to use. |
Example Request
curl -X POST "https://<your domain>/api/system_setup/generate_p12/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"certificate_name":"string","username":"string","expiry_days":1,"algo":"string"}'
Responses
| Status Code | Description |
|---|
| 200 | The operation completed. |
POST /system_setup/generate_tls_csr/
Generates a certificate signing request for the appliance's own web certificate.
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| domain | string | Yes | Domain the certificate is for. |
| common_name | string | Yes | Certificate common name. |
| organisation | string | No | Organisation name. |
| organisation_unit | string | No | Organisational unit. |
| locality | string | No | Locality or city. |
| state | string | No | State or province. |
| country_code | string | No | Two-letter country code. |
Example Request
curl -X POST "https://<your domain>/api/system_setup/generate_tls_csr/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"domain":"string","common_name":"string"}'
Responses
| Status Code | Description |
|---|
| 200 | The operation completed. |
GET /system_setup/get_plugins/
Returns the CI and build-tool plugins available for download.
Example Request
curl -X GET "https://<your domain>/api/system_setup/get_plugins/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
POST /system_setup/import_tls/
Installs an issued certificate for the appliance's own web service. Send as multipart/form-data.
Request Body (multipart/form-data)
| Field | Type | Required | Description |
|---|
| domain | string | Yes | Domain the certificate is for. |
| certificate | file | Yes | Issued certificate. |
| fullchain | file | Yes | Full certificate chain. |
Example Request
curl -X POST "https://<your domain>/api/system_setup/import_tls/" \
-H "Authorization: Bearer <token>" \
-F "domain=<domain>" \
-F "certificate=@<certificate file>" \
-F "fullchain=@<fullchain file>"
Responses
| Status Code | Description |
|---|
| 200 | The operation completed. |
GET /system_setup/maintenance/
Returns appliance health and maintenance information, such as uptime and resource usage.
Example Request
curl -X GET "https://<your domain>/api/system_setup/maintenance/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
POST /system_setup/maintenance/support_package/
Collects appliance diagnostics into a single archive for sending to support.
Example Request
curl -X POST "https://<your domain>/api/system_setup/maintenance/support_package/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The operation completed. |
POST /system_setup/oltp_loki_logging/
Points the appliance's log forwarding at a Loki collector.
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| loki_protocol | string | Yes | Protocol to use, http or https. |
| loki_endpoint | string | Yes | Host name or address of the collector. |
| loki_port | integer | Yes | Port the collector listens on. |
Example Request
curl -X POST "https://<your domain>/api/system_setup/oltp_loki_logging/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"loki_protocol":"string","loki_endpoint":"string","loki_port":1}'
Responses
| Status Code | Description |
|---|
| 200 | The operation completed. |
POST /system_setup/oltp_loki_logging/{action}/
Starts, stops or removes the configured Loki log forwarding.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| action | Path | string | Yes | Action to perform. |
Example Request
curl -X POST "https://<your domain>/api/system_setup/oltp_loki_logging/<action>/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The operation completed. |
POST /system_setup/oltp_splunk_logging/
Points the appliance's log forwarding at a Splunk collector.
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| splunk_protocol | string | Yes | Protocol to use, http or https. |
| splunk_endpoint | string | Yes | Host name or address of the collector. |
| splunk_port | integer | Yes | Port the collector listens on. |
| splunk_token | string | Yes | Collector authentication token. |
| splunk_index | string | Yes | Index to write events to. |
Example Request
curl -X POST "https://<your domain>/api/system_setup/oltp_splunk_logging/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"splunk_protocol":"string","splunk_endpoint":"string","splunk_port":1,"splunk_token":"string","splunk_index":"string"}'
Responses
| Status Code | Description |
|---|
| 200 | The operation completed. |
POST /system_setup/oltp_splunk_logging/{action}/
Starts, stops or removes the configured Splunk log forwarding.
Request Parameters
| Name | Located In | Type | Required | Description |
|---|
| action | Path | string | Yes | Action to perform. |
Example Request
curl -X POST "https://<your domain>/api/system_setup/oltp_splunk_logging/<action>/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The operation completed. |
POST /system_setup/stop_backup/
Cancels a backup that is currently in progress.
Example Request
curl -X POST "https://<your domain>/api/system_setup/stop_backup/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The operation completed. |
GET /system_setup/tls_records/
Returns the web certificates installed on the appliance, with their validity dates.
Example Request
curl -X GET "https://<your domain>/api/system_setup/tls_records/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
GET /system_setup/tls_records/status/
Reports whether the renewal reminder for the appliance's web certificate is currently shown.
Example Request
curl -X GET "https://<your domain>/api/system_setup/tls_records/status/" \
-H "Authorization: Bearer <token>"
Responses
| Status Code | Description |
|---|
| 200 | The requested records. |
PUT /system_setup/tls_records/status/
Turns the renewal reminder on or off.
Request Body (application/json)
| Field | Type | Required | Description |
|---|
| flag | boolean | Yes | Whether the reminder should be shown. |
Example Request
curl -X PUT "https://<your domain>/api/system_setup/tls_records/status/" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{"flag":true}'
Responses
| Status Code | Description |
|---|
| 200 | The record after the update. |
