Skip to main content

Exceptions Commands

See Exceptions module docs for permissions and data model.

soat list-exceptions​

List exception items

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

Usage​

soat list-exceptions

Options​

--project-id​

Project ID (required if not using project key auth)

  • Source: query
  • Required: no
  • Type: string
  • Example: proj_V1StGXR8Z5jdHi6B
--status​

Filter by triage status

  • Source: query
  • Required: no
  • Type: enum("open", "acknowledged", "resolved")
--severity​

Filter by severity

  • Source: query
  • Required: no
  • Type: enum("info", "warning", "critical")
--kind​

Filter by how the exception was filed

  • Source: query
  • Required: no
  • Type: enum("run_failed", "guardrail_tripwire", "approval_expired", "quota_unpriced", "manual")
--limit​

Maximum number of results to return

  • Source: query
  • Required: no
  • Type: integer
  • Default: 50
--offset​

Number of results to skip

  • Source: query
  • Required: no
  • Type: integer
  • Default: 0

soat get-exception​

Get an exception item

  • Method: GET
  • Path: /api/v1/exceptions/{exception_id}

Usage​

soat get-exception

Options​

This command has no options.

soat acknowledge-exception​

Acknowledge an exception item

  • Method: POST
  • Path: /api/v1/exceptions/{exception_id}/acknowledge

Usage​

soat acknowledge-exception

Options​

This command has no options.

soat resolve-exception​

Resolve an exception item

  • Method: POST
  • Path: /api/v1/exceptions/{exception_id}/resolve

Usage​

soat resolve-exception

Options​

--note​

Optional resolution note

  • Source: body
  • Required: no
  • Type: string
  • Example: Root cause fixed; retried the run successfully.