Skip to navigation

Update a website's uptime settings

View as MarkdownOpen in Claude

Changes how one website is monitored. Send only the fields you want to change, and at least one.

keyword and redirects merge field by field over the stored section, so a partial object keeps the fields you do not send. keyword.keys is the only field replaced whole rather than merged.

It does not change the global configuration itself (interval, timeout): use “Update an uptime global configuration”.

Body

  • status (enabled or disabled, optional): turns monitoring on or pauses it. Enabling runs a check right away.
  • preset (integer, optional): id of another Uptime Monitor global configuration to move the website to. The website keeps its status, unlike “Assign websites to an uptime global configuration”, which always switches it on.
  • keyword (object, optional):
    • status (enabled or disabled, optional): turns the keyword check on or off. An enabled keyword check needs at least one keyword.
    • type (some or every, optional): plan-dependent.
    • keys (array of strings, optional): the keywords.
  • path (string or null, optional): path checked on the website, for example /status; null checks the website root.
  • redirects (object, optional):
    • status (enabled or disabled, optional): turns the redirect check on or off.
    • max_redirects (integer, optional): 1 to 10.
    • expected_url (URL or null, optional): the URL the redirects must end on; null accepts any.

Errors

  • 422: no field is sent, or redirects.expected_url is not a valid URL.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

site_preset_uptimestringRequired

Query parameters

includestringOptional

Relations to add to the answer, comma separated: preset (the global configuration the website uses) and current_change (the current status change). Without include both are answered; an include narrows the answer to the ones it names, and an empty include= answers none. Any other name, including the camelCase currentChange, answers 400.

Request

This endpoint expects an object.
redirectsobjectOptional

Response

200 - Uptime service updated

dataobjectOptional
includedlist of objectsOptional
jsonapiobjectOptional

Errors

422
Unprocessable Entity Error