5 Tracing

5.1 Get

GET https://<HOST>:<PORT>/api/tracing/get?version=0

Returns the current tracing options.

Required Permissions

  • API

  • Tracing

Request parameters

  • product

    Choose for which product the current tracing options should be requested for. If this parameter is not given, the current options for anynode are requested.

    Type: String

    Possible Values:

    • anynode

    • anynodeFrontend

    • anynodeMonitor

    • anynodeAdministration

Response Body Structure

The response body is structured as TracingOptionsJson JSON object. A description for its fields is at section 30.5.1. For the JSON schema refer to section 30.5.2.

Example

GET http://127.0.0.1:8888/api/tracing/get?product=anynodeFrontend&version=0
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "selection": "FILE",
  "traceActive": false
}

5.2 Set

PUT https://<HOST>:<PORT>/api/tracing/set?version=0

Sets the tracing options.

Required Permissions

  • API

  • Tracing

Request parameters

  • product

    Choose for which product the current tracing options should be requested for. If this parameter is not given, the current options for anynode are requested.

    Type: String

    Possible Values:

    • anynode

    • anynodeFrontend

    • anynodeMonitor

    • anynodeAdministration

Request Body Structure

The request body is structured as TracingOptionsJson JSON object. A description for its fields is at section 30.5.1. For the JSON schema refer to section 30.5.2.

Response Body Structure

The response body is structured as TracingOptionsJson JSON object. A description for its fields is at section 30.5.1. For the JSON schema refer to section 30.5.2.

Example

PUT http://127.0.0.1:8888/api/tracing/set?product=anynodeFrontend&version=0
HTTP Request Body
{
  "selection": "FILE",
  "options": {},
  "traceActive": false
}
HTTP Response
HTTP/1.1 200 OK
HTTP Response Body
{
  "selection": "FILE",
  "traceActive": false
}

5.3 Download

GET https://<HOST>:<PORT>/api/trace/get?version=0

Returns the trace file(s).

Required Permissions

  • API

  • Tracing

Request parameters

  • product

    Choose for which product the current trace files should be requested for. If this parameter is not given, the current trace from anynode will be returned.

    Type: String

    Possible Values:

    • anynode

    • anynodeFrontend

    • anynodeMonitor

    • anynodeAdministration