Docs

Type a word or a question. Esc closes the search.

Sign in Start free

Update a status page update

Updates an existing status-page update's timing, recurrence, visibility, affected resources or publication behavior.

PUT https://app.upfour.io/v1/status-pages/{pageID}/updates/{updateID}
PUT https://app.upfour.io/v1/status-pages/{pageID}/updates/{updateID}

A real request. Sending it changes data in your up4 account.

Authorization
AuthorizationA pls_ key. It stays in this browser tab. Needs status_page.write.
Path
Body
visibility
notify_on_publish When this request turns a draft public, sends its latest entry to subscribers.
Affected services1
monitor_mode pause_checks pauses the affected monitors for the window and needs starts_at and ends_at. Only for maintenance.
Timing6
recurrence Needs starts_at and ends_at. Only for maintenance.
Automation2
auto_start
auto_end

2 more fields are only available in JSON.

Sent directly from your browser to https://app.upfour.io/v1. Mutating calls get an automatic Idempotency-Key when the field is empty.

Request
Responsenot sent yet
Fill in a key and press Send request (⌘↵).
The answer appears here.
scope status_page.write stable returns 200

Parameters

FieldTypeDescription
pageID required uuid path parameter
updateID required uuid path parameter

Body

The 3 fields most calls use come first; the rest are grouped below.

application/json required 14 fields

titlestring · nullable
visibilitystring · nullable
publicdraft
notify_on_publishboolean

When this request turns a draft public, sends its latest entry to subscribers.

Affected services3 fields
affected_monitor_idsuuid[] · nullable
affected_resource_idsuuid[] · nullable
monitor_modestring · nullable

pause_checks pauses the affected monitors for the window and needs starts_at and ends_at. Only for maintenance.

nonepause_checks
Timing6 fields
starts_atstring (date-time) · nullable

Omitted leaves it unchanged; the zero time (0001-01-01T00:00:00Z) clears it.

ends_atstring (date-time) · nullable

Omitted leaves it unchanged; the zero time (0001-01-01T00:00:00Z) clears it.

timezonestring · nullable

IANA time zone of the planned window. Only for maintenance.

recurrencestring · nullable

Needs starts_at and ends_at. Only for maintenance.

noneweeklymonthly
recurrence_untilstring (date) · nullable

Last day of the series (YYYY-MM-DD); empty means no end.

reminder_minutesinteger · nullable

5 to 20160 minutes before the window starts; 0 switches the reminder off. Needs starts_at. Only for maintenance.

Automation2 fields
auto_startboolean · nullable
auto_endboolean · nullable

Returns

A successful request returns 200 with application/json.

Response fields 1 top-level fields
FieldTypeDescription
data StatusPageUpdate
StatusPageUpdate · 38 fields
FieldTypeDescription
affected_monitor_ids uuid[] · nullable Monitors behind the affected components.
affected_resource_ids uuid[] · nullable
auto_end boolean
auto_start boolean
created_at string (date-time)
ends_at string (date-time) · nullable
entries StatusPageUpdateEntry[] · nullable
Each item · 9 fields
FieldTypeDescription
created_at string (date-time)
id uuid
message string
notify_subscribers boolean
published_at string (date-time)
source string one ofmanualautomatic
status string one ofinvestigatingidentifiedmonitoringresolvedscheduledin_progresscompletedcancelledpublished
update_id uuid
updated_at string (date-time)
id uuid
message string Mirrors the latest entry.
monitor_mode string one ofnonepause_checks
notify_subscribers boolean
published_at string (date-time)
recurrence string one ofnoneweeklymonthly
recurrence_until string (date) · nullable Last day of a recurring series (YYYY-MM-DD); null for no end.
reminder_minutes integer · nullable
source string one ofmanualautomatic
starts_at string (date-time) · nullable
status string one ofinvestigatingidentifiedmonitoringresolvedscheduledin_progresscompletedcancelledpublished Mirrors the latest entry.
status_page_id uuid
timezone string IANA time zone of a planned maintenance window; empty for other types.
title string
update_type string one ofincidentmaintenancereport
updated_at string (date-time)
visibility string one ofpublicdraft
closed_unmeasured boolean Resolved, but the incident ended because monitoring resumed after a billing pause: nobody measured the recovery.
incident_group_id uuid
incident_id uuid
reminder_sent_at string (date-time)
series_id uuid

Errors

Only the errors this operation can return. Every error uses the same envelope.

Status Code Meaning
400 bad_request The request is malformed or fails validation.
404 not_found The requested resource does not exist or is outside the caller's scope.
403 permission_denied The credentials do not permit this action.

Every call can also return unauthorized (401), rate_limit_exceeded (429) or internal_error (500 / 502). See Responses and errors.