Skip to main content

Module api

Module api 

Source
Expand description

The push service’s HTTP API (JSON).

Method and pathBodyAnswer
POST /v1/registerRegisterRegistered
POST /v1/rotateControlRegistered (the old handle is revoked)
POST /v1/unregisterControl204
POST /v1/wakeWakeRequest202, or 410 if the handle is unknown or revoked
GET /v1/relay/announcementsbearer relay tokenNDJSON stream of Announcement
GET /v1/health200 ok

Structs§

Announcement
One line of GET /v1/relay/announcements.
Control
POST /v1/rotate and POST /v1/unregister.
ErrorBody
An error body.
Register
POST /v1/register.
Registered
A new handle and its control secret.
WakeRequest
POST /v1/wake.

Enums§

Transport
How the service reaches a device.