Systems

Check result of a download traces job.

get

API Key Scope: systems / download_traces

Authorizations
Query parameters
job_idstringRequired

ID of active job

Responses
200

A completed job for downloading traces.

Responsestring · binary
get
/systems/download_traces
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
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
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
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:41:44.881Z",
      "before": "2025-11-05T15:41:44.881Z"
    }
  ]
}
200

The var file created

binary

Last updated

Was this helpful?