Diagnostics

Invoke the generate-debug-dump operation

SecurityaccessToken
Request
query Parameters
site
string

Send the request to the specfifed site

Request Body schema:
One of:
all-hosts
boolean

Must have the value true.

procs
string <enumeration>
Default: "all"
  • none
  • all
  • suspicious
scheduler-state
boolean
Default: true
netm-state
boolean
Default: true
local-store-state
boolean
Default: true
call-home-state
boolean
Default: false
registry-check
boolean
Default: false
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/diagnostics/generate-debug-dump
Request samples
all-hosts: true
procs: all
scheduler-state: true
netm-state: true
local-store-state: true
call-home-state: false
registry-check: false
Response samples
No sample

Invoke the get-connections operation

SecurityaccessToken
Request
query Parameters
site
string

Send the request to the specfifed site

Request Body schema:
site
string
connected-only
boolean
Responses
200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/diagnostics/get-connections
Request samples
site: mysite
connected-only: false
Response samples
down-connections:
  sites:
    - site: mysite
      connected: true
      last-connect: 2023-05-06T10:00:00Z
      last-disconnect: 2023-05-06T09:59:00Z
      hosts:
        - host: mysite-001
          protocol: quic
          peer: 1.2.3.4:5678
        - host: mysite-002
          protocol: quic
          peer: 2.3.4.5:6789
        - host: mysite-003
          protocol: tcp
          peer: 3.4.5.6:7890

Invoke the halt-supd operation

Immediately halt supd, forcing a hard restart. Warning: this may seal the system if there are no other hosts in the cluster that are up and running.

SecurityaccessToken
Request
query Parameters
site
string

Send the request to the specfifed site

Request Body schema:
One of:
all-hosts
boolean

Must have the value true.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/diagnostics/halt-supd
Request samples
hosts:
  - sthlm-north-001

Invoke the reboot operation

Reboot the host. On a site with more than one host either all-hosts or a list of hosts must be provided.

WARNING: This may seal the system, depending on the seal-mode.

SecurityaccessToken
Request
query Parameters
site
string

Send the request to the specfifed site

Request Body schema:
One of:
all-hosts
boolean

Must have the value true.

Responses
204

No Content

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

503

Service Unavailable (strongbox sealed)

post/v1/state/diagnostics/reboot
Request samples
hosts:
  - sthlm-north-001