Skip to main content

Traces Commands

See Traces module docs for permissions and data model.

soat list-traces​

List traces

  • Method: GET
  • Path: /api/v1/traces

Usage​

soat list-traces

Options​

--project-id​

Project public ID to filter by

  • Source: query
  • Required: no
  • Type: string
--parent-trace-id​

Only the direct children of this trace. A trace naming nothing the caller can read matches nothing rather than widening the listing.

  • Source: query
  • Required: no
  • Type: string
  • Example: trace_V1StGXR8Z5jdHi6B

soat get-trace​

Get a trace

  • Method: GET
  • Path: /api/v1/traces/{trace_id}

Usage​

soat get-trace --trace-id <string>

Options​

--trace-id​

Public ID of the trace

  • Source: path
  • Required: yes
  • Type: string

soat get-trace-tree​

Get trace tree

  • Method: GET
  • Path: /api/v1/traces/{trace_id}/tree

Usage​

soat get-trace-tree --trace-id <string>

Options​

--trace-id​

Public ID of any trace in the tree (root or child)

  • Source: path
  • Required: yes
  • Type: string

soat purge-trace-content​

Purge trace content

  • Method: DELETE
  • Path: /api/v1/traces/{trace_id}/content

Usage​

soat purge-trace-content --trace-id <string>

Options​

--trace-id​

Public ID of the trace

  • Source: path
  • Required: yes
  • Type: string