How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Oxide System/alerts API

Alerts deliver notifications for events that occur on the Oxide rack

Oxide System/alerts API is one of 30 APIs that Oxide publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include system/alerts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 16 operations across 14 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 2026081901.0.0.

Requests are made against the base URL https://{oxide-control-plane-host}.

16 operations 14 paths 31 schemas 3 DELETE7 GET5 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2026081901.0.0
Base URL
https://{oxide-control-plane-host}
Resource Areas
1

Paths & Operations 16

Across 14 paths, the API surfaces 16 operations — 3 DELETE, 7 GET, 5 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

system/alerts 16

Alerts deliver notifications for events that occur on the Oxide rack

GET
/v1/alert-classes
List alert classes
alert_class_list 3 params → 2004XX5XX
GET
/v1/alert-receivers
List alert receivers
alert_receiver_list 3 params → 2004XX5XX
GET
/v1/alert-receivers/{receiver}
Fetch alert receiver
alert_receiver_view 1 param → 2004XX5XX
DELETE
/v1/alert-receivers/{receiver}
Delete alert receiver
alert_receiver_delete 1 param → 2044XX5XX
GET
/v1/alert-receivers/{receiver}/deliveries
List delivery attempts to alert receiver
alert_delivery_list 7 params → 2004XX5XX
POST
/v1/alert-receivers/{receiver}/probe
Send liveness probe to alert receiver
alert_receiver_probe 2 params → 2004XX5XX
POST
/v1/alert-receivers/{receiver}/subscriptions
Add alert receiver subscription
alert_receiver_subscription_add 1 param body → 2014XX5XX
DELETE
/v1/alert-receivers/{receiver}/subscriptions/{subscription}
Remove alert receiver subscription
alert_receiver_subscription_remove 2 params → 2044XX5XX
GET
/v1/alerts
List alerts
alert_list 6 params → 2004XX5XX
GET
/v1/alerts/{alert_id}
Fetch alert
alert_view 1 param → 2004XX5XX
POST
/v1/alerts/{alert_id}/resend
Request re-delivery of alert
alert_delivery_resend 2 params → 2014XX5XX
POST
/v1/webhook-receivers
Create webhook receiver
webhook_receiver_create body → 2014XX5XX
PUT
/v1/webhook-receivers/{receiver}
Update webhook receiver
webhook_receiver_update 1 param body → 2044XX5XX
GET
/v1/webhook-secrets
List webhook receiver secret IDs
webhook_secrets_list 1 param → 2004XX5XX
POST
/v1/webhook-secrets
Add secret to webhook receiver
webhook_secrets_add 1 param body → 2014XX5XX
DELETE
/v1/webhook-secrets/{secret_id}
Remove secret from webhook receiver
webhook_secrets_delete 1 param → 2044XX5XX

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are AlertDelivery (8 properties), WebhookReceiver (8 properties), AlertReceiver (7 properties), Alert (6 properties). Each schema is shown below with its type and property counts.

AlertSubscriptionCreated
object
1 property 1 required
AlertReceiverResultsPage
object
A single page of results
2 properties 1 required
AlertDeliveryResultsPage
object
A single page of results
2 properties 1 required
WebhookDeliveryAttemptResult
AlertSubscriptionCreate
object
1 property 1 required
NameOrIdSortMode
Supported set of sort modes for scanning by name or id
AlertReceiverKind
The possible alert delivery mechanisms for an alert receiver.
WebhookSecrets
object
A list of the IDs of secrets associated with a webhook receiver.
1 property 1 required
WebhookSecret
object
A view of a shared secret key assigned to a webhook receiver. Once a secret is created, the value of the secret is not available in the API, as it must remain…
2 properties 2 required
AlertDelivery
object
A delivery of a webhook event.
8 properties 8 required
AlertClassResultsPage
object
A single page of results
2 properties 1 required
AlertResultsPage
object
A single page of results
2 properties 1 required
AlertDeliveryAttempts
A list of attempts to deliver an alert to a receiver. The type of the delivery attempt model depends on the receiver type, as it may contain information specif…
WebhookCreate
object
Create-time identity-related parameters
5 properties 4 required
Error
object
Error information from a response.
3 properties 2 required
AlertDeliveryState
The state of a webhook delivery attempt.
AlertDeliveryTrigger
The reason an alert was delivered
WebhookDeliveryResponse
object
The response received from a webhook receiver endpoint.
2 properties 2 required
WebhookSecretCreate
object
1 property 1 required
NameOrId
WebhookReceiverUpdate
object
Parameters to update a webhook configuration.
3 properties
AlertDeliveryId
object
1 property 1 required
WebhookReceiver
object
The configuration for a webhook alert receiver.
8 properties 8 required
Name
string
Names must begin with a lower case ASCII letter, be composed exclusively of lowercase ASCII, uppercase ASCII, numbers, and '-', and may not end with a '-'. Nam…
AlertSubscription
string
A webhook event class subscription matches either a single event class exactly, or a glob pattern including wildcards that may match multiple event classes
AlertClass
object
An alert class.
2 properties 2 required
WebhookDeliveryAttempt
object
An individual delivery attempt for a webhook event. This represents a single HTTP request that was sent to the receiver, and its outcome.
4 properties 3 required
AlertProbeResult
object
Data describing the result of an alert receiver liveness probe attempt.
2 properties 1 required
TimeAndIdSortMode
Supported set of sort modes for scanning by timestamp and ID
AlertReceiver
object
The configuration for an alert receiver.
7 properties 7 required
Alert
object
An alert. Alerts provide notifications about events that occurred in the system at a point in time. See the guide-level documentation on alerts for details.
6 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

oxide-computer-system-alerts-api-openapi.yml Raw ↑

Other APIs Oxide publishes across the network.

Oxide Affinity API
Oxide Console Auth API
Oxide Current User API
Oxide Disks API
Oxide Experimental API
Oxide External Subnets API
Oxide Floating Ips API
Oxide Images API
Oxide Instances API
Oxide Ip Pools API
Oxide Login API
Oxide Metrics API
Where this information came from

This is an independent, third-party profile of Oxide System/alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.