Systems

Get status of running services.

get

API Key Scope: systems / services

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Responses

200

OK

application/json

Responseany

default

Error returned from the data management.

application/json

get

/systems/services

HTTPcURLJavaScriptPython

GET /api/v2/systems/services HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

No content

Get info about hosts.

get

API Key Scope: systems / hosts

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Responses

200

OK

application/json

Responseany

default

Error returned from the data management.

application/json

get

/systems/hosts

HTTPcURLJavaScriptPython

GET /api/v2/systems/hosts HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

No content

Get information about current license.

get

API Key Scope: licenses / show

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Responses

200

OK

application/json

Responseany

default

Error returned from the data management.

application/json

get

/systems/license

HTTPcURLJavaScriptPython

GET /api/v2/systems/license HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

No content

Set new license

put

API Key Scope: licenses / update

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Body

application/json

anyOptional

Responses

200

OK

application/json

Responseany

422

The received resource was not correctly formatted.

application/json

default

Error returned from the data management.

application/json

put

/systems/license

HTTPcURLJavaScriptPython

PUT /api/v2/systems/license HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*

No content

Creates a YAML file with selected tables and downloads it

post

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

Pass the username and password of a user in the authorization header. This currently gives full access.

Body

application/json

Responses

200

The var file created

application/x-yaml

Responsestring · binary

post

/systems/reset/generate_vars

HTTPcURLJavaScriptPython

POST /api/v2/systems/reset/generate_vars HTTP/1.1
Host: localhost
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "sections": [
    {
      "value": "full",
      "after": "2025-12-23T05:39:00.544Z",
      "before": "2025-12-23T05:39:00.544Z"
    }
  ]
}

200

The var file created

binary