API reference

Status

Public platform status, incidents and maintenance.

8 operationsBase URL https://packetexchange.io/api/v1Postman collection

BrowseStatus

Get the public status page

GET/api/v1/status/page

Access: Public. No key needed.
Rate limit: 120 requests per minute

Overall state, component groups with 90-day history, active and recent incidents, and scheduled maintenance. Cached for 15 seconds.

Response 200

Field	Type	Description
`data`required	object	-
`generatedAt`requireddata.generatedAt	string (date-time)	ISO-8601 timestamp (UTC)
`overall`requireddata.overall	object	-
`state`requireddata.overall.state	string	-One of `operational`, `degraded`, `partial_outage`, `major_outage`, `maintenance`
`message`requireddata.overall.message	string	-
`groups`requireddata.groups	object[]	-
`id`requireddata.groups[].id	string	-
`name`requireddata.groups[].name	string	-
`components`requireddata.groups[].components	object[]	-
`id`requireddata.groups[].components[].id	string	-
`name`requireddata.groups[].components[].name	string	-
`description`requireddata.groups[].components[].description	string	-
`state`requireddata.groups[].components[].state	string	-One of `operational`, `degraded`, `partial_outage`, `major_outage`, `maintenance`
`uptime90d`requireddata.groups[].components[].uptime90d	number \| null	Percent over 90 days; null when there is no data
`dataSince`requireddata.groups[].components[].dataSince	string \| null	-
`days`requireddata.groups[].components[].days	object[]	-
`date`requireddata.groups[].components[].days[].date	string	YYYY-MM-DD
`state`requireddata.groups[].components[].days[].state	string	-
`uptimePct`requireddata.groups[].components[].days[].uptimePct	number \| null	-
`downtimeMinutes`requireddata.groups[].components[].days[].downtimeMinutes	number \| null	-
`incidents`requireddata.groups[].components[].days[].incidents	object[]	-
`id`requireddata.groups[].components[].days[].incidents[].id	string	-
`title`requireddata.groups[].components[].days[].incidents[].title	string	-
`impact`requireddata.groups[].components[].days[].incidents[].impact	string	-One of `none`, `minor`, `major`, `critical`
`activeIncidents`requireddata.activeIncidents	object[]	-
`id`requireddata.activeIncidents[].id	string	-
`title`requireddata.activeIncidents[].title	string	-
`impact`requireddata.activeIncidents[].impact	string	-One of `none`, `minor`, `major`, `critical`
`status`requireddata.activeIncidents[].status	string	-One of `investigating`, `identified`, `monitoring`, `resolved`
`componentIds`requireddata.activeIncidents[].componentIds	string[]	-
`startedAt`requireddata.activeIncidents[].startedAt	string (date-time)	ISO-8601 timestamp (UTC)
`resolvedAt`requireddata.activeIncidents[].resolvedAt	string (date-time) \| null	ISO-8601 timestamp (UTC)
`updates`requireddata.activeIncidents[].updates	object[]	-
`id`requireddata.activeIncidents[].updates[].id	string	-
`status`requireddata.activeIncidents[].updates[].status	string	-One of `investigating`, `identified`, `monitoring`, `resolved`
`body`requireddata.activeIncidents[].updates[].body	string	-
`createdAt`requireddata.activeIncidents[].updates[].createdAt	string (date-time)	ISO-8601 timestamp (UTC)
`scheduledMaintenance`requireddata.scheduledMaintenance	object[]	-
`id`requireddata.scheduledMaintenance[].id	string	-
`title`requireddata.scheduledMaintenance[].title	string	-
`body`requireddata.scheduledMaintenance[].body	string	-
`componentIds`requireddata.scheduledMaintenance[].componentIds	string[]	-
`scheduledStart`requireddata.scheduledMaintenance[].scheduledStart	string (date-time)	ISO-8601 timestamp (UTC)
`scheduledEnd`requireddata.scheduledMaintenance[].scheduledEnd	string (date-time)	ISO-8601 timestamp (UTC)
`status`requireddata.scheduledMaintenance[].status	string	-One of `scheduled`, `in_progress`, `completed`
`pastIncidents`requireddata.pastIncidents	object[]	Same fields as StatusIncident, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

List past incidents

GET/api/v1/status/incidents

Access: Public. No key needed.
Rate limit: 120 requests per minute

Parameters

Name	In	Type	Description
`cursor`	query	string	The `nextCursor` from the previous page

Response 200

Field	Type	Description
`data`required	object	-
`items`requireddata.items	object[]	Same fields as StatusIncident, shown earlier on this page.
`nextCursor`requireddata.nextCursor	string \| null	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Get one incident with its updates

GET/api/v1/status/incidents/{id}

Access: Public. No key needed.
Rate limit: 120 requests per minute

Parameters

Name	In	Type	Description
`id`required	path	string	-

Response 200

Field	Type	Description
`data`required	object	Same fields as StatusIncident, shown earlier on this page.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
404NOT_FOUND: no such resource on your account.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Subscribe to status updates as an RSS feed

GET/api/v1/status/feed.xml

Access: Public. No key needed.
Rate limit: 120 requests per minute

Response 200 (application/rss+xml)

RSS 2.0 feed of incidents and maintenance.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Subscribe an email address to status updates

POST/api/v1/status/subscribe

Access: Public. No key needed.
Rate limit: 5 requests per hour

Sends a confirmation email. The answer is the same whether or not the address was already subscribed.

Request body (application/json)

Field	Type	Description
`email`required	string (email)	-max 254 chars

Response 200

Field	Type	Description
`data`required	object	-
`message`requireddata.message	string	-

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

HTTP

curl -X POST "https://packetexchange.io/api/v1/status/subscribe" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "you@example.com"
}'

Run it here, no key needed.

Confirm a status subscription from the email link

GET/api/v1/status/subscribe/confirm

Access: Public. No key needed.
Rate limit: 30 requests per 10 minutes

Parameters

Name	In	Type	Description
`token`	query	string	-

Response 302

Redirects to the status page with the outcome.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Unsubscribe from status updates from the email link

GET/api/v1/status/unsubscribe

Access: Public. No key needed.
Rate limit: 30 requests per 10 minutes

Parameters

Name	In	Type	Description
`token`	query	string	-

Response 302

Redirects to the status page with the outcome.

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.

Unsubscribe from status updates in one click

POST/api/v1/status/unsubscribe

Access: Public. No key needed.
Rate limit: 120 requests per minute

The RFC 8058 one-click unsubscribe target used by mail clients.

Parameters

Name	In	Type	Description
`token`	query	string	-

Response 200

Field	Type	Description
`data`required	object	-
`result`requireddata.result	string	Outcome, e.g. unsubscribed or invalid

Errors

400VALIDATION_ERROR, INVALID_INPUT or BAD_REQUEST. For VALIDATION_ERROR, error.details is an array of { path, message }.
409CONFLICT (or a code-specific 409): the change clashes with existing state.
429RATE_LIMITED: slow down and retry after the Retry-After seconds.
500INTERNAL_ERROR: unexpected failure. Quote X-Request-Id to support.