Systems

Check result of a download traces job.

get

API Key Scope: systems / download_traces

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Query parameters

job_idstringRequired

ID of active job

Responses

200

A completed job for downloading traces.

application/jsonapplication/tar+gzip

Responsestring · binary

202

An active job that may be queued, working, completed or failed.

application/json

get

/systems/download_traces

HTTPcURLJavaScriptPython

GET /api/v2/systems/download_traces?job_id=text HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

binary

Trigger a download traces request.

put

API Key Scope: systems / download_traces

Authorizations

BasicAuthBearerAuthJWT

AuthorizationstringRequired

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

Query parameters

typestring · enumRequired

Type of traces to download

Possible values:

Responses

202

An active job that may be queued, working, completed or failed.

application/json

put

/systems/download_traces

HTTPcURLJavaScriptPython

PUT /api/v2/systems/download_traces?type=interface HTTP/1.1
Host: localhost
Authorization: Basic username:password
Accept: */*

202

An active job that may be queued, working, completed or failed.

{
  "job_id": "6f4d759d-48e9-43c8-ab24-640f5ea63922",
  "status": "queued"
}

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-22T22:43:58.369Z",
      "before": "2025-12-22T22:43:58.369Z"
    }
  ]
}

200

The var file created

binary