Skip to main content
GET
/
faults
/
{faultId}
Retrieve a fault
curl --request GET \
  --url https://api.altostrat.io/faults/{faultId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "flt_31pkd1t8FvW7qZv0jG2a9kH5mB1",
  "resource_id": "dev_2j4k2l2j3k4l2j3k4",
  "customer_id": "cus_1i2j3k4l5m6n7o8p",
  "microservice_id": "wantunnel-monitor",
  "type": "wantunnel",
  "status": "unresolved",
  "severity": "CRITICAL",
  "message": "WAN link failover: Primary link (WAN1) is down",
  "cause": "Probe failed: Latency exceeded 500ms threshold",
  "created_at": "2025-10-21T12:00:00.000000Z",
  "resolved_at": null,
  "resource_ancestry_path": "site_8a7b6c5d4e3f2g1h|dev_2j4k2l2j3k4l2j3k4",
  "ttl": 1797825595,
  "comments": [
    {
      "user_id": "user_a1b2c3d4e5f6g7h8",
      "comment": "Contacted ISP, they are investigating a local outage.",
      "created_at": "2025-10-21T12:05:30.000000Z"
    }
  ]
}

Authorizations

โ€‹
Authorization
string
header
required

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

Path Parameters

โ€‹
faultId
string
required

The unique identifier of the fault to retrieve.

Example:

"flt_31pkd1t8FvW7qZv0jG2a9kH5mB1"

Response

The fault object.

The Fault object represents a detected issue or event within the network.

โ€‹
id
string

A unique identifier for the fault object, prefixed with flt_.

Example:

"flt_31pkd1t8FvW7qZv0jG2a9kH5mB1"

โ€‹
resource_id
string

The unique identifier of the resource that experienced the fault.

Example:

"dev_2j4k2l2j3k4l2j3k4"

โ€‹
customer_id
string

The unique identifier of the customer account this fault belongs to.

Example:

"cus_1i2j3k4l5m6n7o8p"

โ€‹
microservice_id
string

The identifier of the microservice that reported the fault.

Example:

"wantunnel-monitor"

โ€‹
type
string

The category or type of the fault.

Example:

"wantunnel"

โ€‹
status
enum<string>

The current status of the fault.

Available options:
unresolved,
resolved
Example:

"unresolved"

โ€‹
severity
enum<string>

The severity level of the fault.

Available options:
LOW,
MEDIUM,
HIGH,
CRITICAL,
WARNING
Example:

"CRITICAL"

โ€‹
message
string

A concise, human-readable summary of the fault.

Example:

"WAN link failover: Primary link (WAN1) is down"

โ€‹
cause
string

A detailed explanation of the probable cause of the fault.

Example:

"Probe failed: Latency exceeded 500ms threshold"

โ€‹
created_at
string<date-time>

The timestamp when the fault was first detected and created.

Example:

"2025-10-21T12:00:00.000000Z"

โ€‹
resolved_at
string<date-time> | null

The timestamp when the fault was resolved. Null if the fault is still active.

Example:

null

โ€‹
resource_ancestry_path
string | null

A pipe-delimited | string representing the hierarchical location of the resource, used for filtering faults by a parent resource (e.g., a specific site).

Example:

"site_8a7b6c5d4e3f2g1h|dev_2j4k2l2j3k4l2j3k4"

โ€‹
ttl
integer | null

A Unix timestamp indicating when the fault record will automatically expire from the database.

Example:

1797825595

โ€‹
comments
object[]

A list of comments associated with the fault, ordered from oldest to newest.