Skip to main content
GET
List all faults

Authorizations

Authorization
string
header
required

API requests are authenticated using a JSON Web Token (JWT) provided in the Authorization header.

Query Parameters

limit
integer
default:50

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

Required range: 1 <= x <= 100
cursor
string

A cursor for use in pagination. The cursor is an opaque string that specifies your current position in the list.

Example:

"eyJQSyI6eyJTIjoiRkFVTFQjMzFwbGg4a2FhblB2R0h"

from
string<date-time>

A timestamp in ISO 8601 format. Only return faults created after this time.

Example:

"2025-10-20T10:00:00Z"

to
string<date-time>

A timestamp in ISO 8601 format. Only return faults created before this time.

Example:

"2025-10-21T10:00:00Z"

severity
enum<string>

Filter faults by their severity level.

Available options:
LOW,
MEDIUM,
HIGH,
CRITICAL,
WARNING
type
string

Filter faults by their type, such as site or wantunnel.

Example:

"wantunnel"

resource_id
string

Filter faults to a specific resource identifier.

Example:

"dev_2j4k2l2j3k4l2j3k4"

site
string

Filter faults to a specific site and all its child resources. This performs a hierarchical query.

Example:

"site_8a7b6c5d4e3f2g1h"

status
enum<string>

Filter faults by their resolution status.

Available options:
unresolved,
resolved

Response

A paginated list of faults.

data
object[]
meta
object