HomepageBlog

Systems

Get status of running services.

get

API Key Scope: systems / services

Authorizations
Responses
200

OK

application/json
Responseany
get
/systems/services
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
Responses
200

OK

application/json
Responseany
get
/systems/hosts
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
Responses
200

OK

application/json
Responseany
get
/systems/license
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
Body
anyOptional
Responses
200

OK

application/json
Responseany
put
/systems/license
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
Body
Responses
200

The var file created

application/x-yaml
Responsestring · binary
post
/systems/reset/generate_vars
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-11-05T15:49:53.953Z",
      "before": "2025-11-05T15:49:53.953Z"
    }
  ]
}
200

The var file created

binary

Last updated

Was this helpful?