On-Call API › Maintenance windows
Edit an update
PATCH/api/v1/maintenance-windows/{id}/updates/{updateID}
Replaces an update's text, on the status page too when it was posted there.
Permission (API-key scope): oncall:maintenance:write.
Authorization
bearerAuth(oncall:maintenance:write)apiKeyHeader(oncall:maintenance:write)
Parameters
Path parameters
idstring requiredThe maintenance window's id.updateIDstring requiredThe update's id.
Request body required
bodystring required
Responses
200
The update after the change.
dataMaintenanceUpdate requiredShow MaintenanceUpdate properties
idstringwindow_idstringauthor_idstringbodystringcreated_atstring (date-time)
successboolean required
400
The body is not JSON (INVALID_BODY) or body is empty (VALIDATION_ERROR).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
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.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
404
No such update on this window (NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
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.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
Example request
curl -X PATCH 'https://evohub.io/api/v1/maintenance-windows/c1d2e3f4-a5b6-4c7d-8e9f-0a1b2c3d4e5f/updates/d5e6f7a8-b9c0-4d1e-a2f3-b4c5d6e7f8a9' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"body": "Replica promoted; traffic switched."
}'