checks

PUT /api/v1/checks/{pk}/

Update a check

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/checks/:pk/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

pkstring required

Request body

pkinteger

urlstring

stats_urlstring uri

alerts_urlstring uri

share_urlstring uri

namestring

cached_response_timenumber

contact_groupsstring[] required

Array of contact names or IDs associated with this check. Use GET /api/v1/contacts/ to list available contacts.

created_atstring date-time

modified_atstring date-time

locationsstring[]

Array of locations associated with this check. Use GET /api/v1/checks/locations/ to list available locations.

tagsstring[]

Array of tag names or IDs associated with this check. Use GET /api/v1/check-tags/ to list available tags.

check_typestring

escalationsstring

monitoring_service_typestring

is_pausedboolean

send_resolved_notificationsboolean

Send resolve notifications when pausing the check

is_under_maintenancestring

state_is_upboolean

state_changed_atstring date-time

maintenance_schedulesinteger[]

Array of maintenance schedule IDs associated with this check.

msp_intervalinteger

msp_addressstring required

msp_portinteger nullable

msp_usernamestring

msp_passwordstring

msp_proxystring

msp_dns_serverstring

msp_dns_record_type'A' | 'AAAA' | 'CNAME' | 'MX' | 'NS' | 'PTR' | 'SOA' | 'TXT' | 'ANY'

msp_status_codestring

msp_send_stringstring

msp_expect_stringstring

msp_expect_string_type'STRING' | 'REGEX' | 'INVERSE_REGEX'

msp_encryption'' | 'SSL_TLS'

msp_thresholdinteger nullable

msp_headersstring

msp_scriptstring

msp_versioninteger

msp_sensitivityinteger

msp_num_retriesinteger

msp_use_ip_version'' | 'IPV4' | 'IPV6'

msp_uptime_slastring decimal

msp_response_time_slastring decimal nullable

msp_notesstring

msp_include_in_global_metricsboolean

webhook_urlstring

heartbeat_urlstring

Response