maintenance

PATCH /api/v1/maintenance/schedules/{pk}/

Partially update a maintenance schedule

Only the supplied fields are updated. When changing schedule_type, include the fields required by the new type (see the PUT description above for the per-type requirements: RRULE, ONE_OFF, and MANUAL).

Request

Base URL
https://uptime.com (the document declares no server; this is the origin it was published from)
Auth
none declared
TypeScript
https://skmtc.dev/uptime/apis/uptime-com-openapi-schema/docs/api/v1/maintenance/schedules/:pk/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

pkstring required

Request body

namestring

schedule_type'RRULE' | 'MANUAL' | 'ONE_OFF' required

starts_atstring date-time required

ends_atstring date-time nullable

rrulestring

duration_minutesinteger nullable

is_activeboolean

pause_checks_during_maintenanceboolean

servicesinteger[]

tagsinteger[]

Response

idinteger

namestring

schedule_type'RRULE' | 'MANUAL' | 'ONE_OFF'

starts_atstring date-time

ends_atstring date-time nullable

rrulestring

duration_minutesinteger nullable

is_activeboolean

pause_checks_during_maintenanceboolean

servicesstring

created_atstring date-time

modified_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.