API docs

zpe-status

mount / · base https://status.zpe.vc · v3.0.1 · 1 operation · 0 write · 0 need no account · stable

the document this app serves now. Contract: https://status.zpe.vc/_/api/v1/openapi.json · sha256 29dd2a01a282

GET /_/api/v1/universe Every app the registry declares, joined to this account's monitor and its last check getUniverse

Every app the registry declares, joined to this account's monitor and its last check

Parameters

nameinrequiredtypenotes
accessquerynostringOnly rows whose declared access is this one (a public app, a gated one, the owner's own).
categoryquerynostringOnly rows carrying this category in their list of categories.
checkqueryno"up" | "down" | "none"Only rows whose last check answered this word (`up`, `down`, `none`), which is the word the cell shows.
kindquerynostringOnly rows of this kind, as the registry declares it (a worker, a page, a service).
licensequerynostringOnly rows whose declared licence is this one.
lifecyclequerynostringOnly rows whose declared lifecycle is this one (`live`, `wip`, `plan`, …), as the registry spells it.

Request body

None: this operation takes its arguments in the path and the query.

Responses

statusmeaningbody
200Every app the registry declares, as rows, joined to this account's monitor and the last check of each, narrowed by the filters the query names.object
401The credential is missing, or the door did not recognise it.object
403This credential may not read this board: the key is not granted this app, or the board was claimed by another account and it is not shared.object
429Too many requests: this key has spent its request ceiling.object
500This app failed while answeringobject
503The door did not answer, so the request could not be checked.object

Example

Every app the registry declares, joined to this account's monitor and its last check, with a token from the door.

GET /_/api/v1/universe
curl -X GET 'https://status.zpe.vc/_/api/v1/universe?access=string&category=string&check=up&kind=string&license=string&lifecycle=string' \
  -H 'Authorization: Bearer $ZPE_TOKEN'
200 application/json
{}

The example is generated from the schema in the contract: the shape is the document's, the values are placeholders.