alert_view

Fetch alert
get/v1/alerts/{alert_id}

Path Parameters

alert_id

UUID of the alert

Responses

200

successful operation

Object
class

The alert's class.

See the guide-level documentation on alerts for details on alert classes.

id

Unique, immutable, system-controlled identifier for each resource

payload

The alert's data payload.

The schema for this object depends on the alert class and version.

time_created

Timestamp when this resource was created

time_modified

Timestamp when this resource was last modified

version

The schema version of this alert's data payload.

Alert schemas are versioned on a per-alert-class basis. The schema version for a particular alert class does not correspond to an Oxide API version. Clients should expect to encounter earlier schema versions when retrieving alerts recorded by an earlier version of the system software.

See the guide-level documentation on alerts for details.

4XX

Error

Object
message
request_id
5XX

Error

Object
message
request_id