Status API › Components
Reorder components
Sets the order of the page's components, in the console and on the public
page. component_ids must name every component of the page exactly once. A
group sits where its first component does. Answers with the reordered list.
Permission (API-key scope): status:component:write.
Authorization
bearerAuth(status:component:write)apiKeyHeader(status:component:write)
Parameters
Path parameters
pageIDstring (uuid) requiredThe status page's id (a UUID).
Request body required
component_idsarray of string (uuid) required
Responses
200
The components in their new order.
dataarray of Component requiredShow Component properties
idstring (uuid) requiredorg_idstring requiredpage_idstring (uuid) requirednamestring requireddescriptionstringsourcestring requiredmonitor_idstringThe Uptime monitor it mirrors (sourceuptime_monitor).current_statusComponentStatus requiredpositioninteger requiredgroupstringThe group (product) it appears under; absent when ungrouped.shown_statusComponentStatusIn the page's component list only, and only when a live incident or maintenance shows it differently fromcurrent_statuson the public page.shown_becausestringThe live incident's or maintenance's title that makes visitors seeshown_status.created_atstring (date-time) requiredupdated_atstring (date-time) required
successboolean required
400
The list does not name every component exactly once (VALIDATION_ERROR), or the body is not valid (INVALID_BODY).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
404
No such item, or one the caller cannot see (NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThis request's id, also inX-Request-ID.
Example request
curl -X PUT 'https://evohub.io/api/v1/pages/3f6c2a1e-8b4d-4f7a-9c21-5d0e7a9b1c42/components/order' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"component_ids": [
"b8d2f4a6-3c5e-4d7f-9a1b-2c4e6a8b0d3f",
"a7c1e3f5-2b4d-4c6e-8f0a-1b3d5f7a9c2e"
]
}'