GET /api/v1/traces

Changed on

Returns a list of all the traces.

Request

  • The document declares no server URL.
  • Auth
    • API key in header X-Auth-Token
    • or API key in header St2-Api-Key
    • or API key in query parameter x-auth-token
    • or API key in query parameter st2-api-key
    • or API key in header auth-token

Query parameters

exclude_attributesstring[]

List of attributes to exclude

include_attributesstring[]

List of attributes to include

limitinteger

Number of traces to get

offsetinteger

Number of traces to offset

sortstring

Comma-separated list of fields to sort by

idstring[]

Entity id filter

namestring[]

Entity name filter

trace_tagstring

Trace-tag to filter the list.

executionstring

Execution to filter the list.

rulestring

Rule to filter the list..

trigger_instancestring

TraceInstance to filter the list.

sort_ascstring

Sort in ascending order by start timestamp, asc/ascending (earliest first)

sort_descstring

Sort in descending order by start timestamp, desc/descending (latest first)

Response

List of traces

TracesList[] required

Changes

    • info

      added the new optional query request parameter exclude_attributes

    • info

      added the new optional query request parameter include_attributes