Skip to navigation

Create an uptime global configuration

View as MarkdownOpen in Claude

Creates an Uptime Monitor global configuration: the check settings a group of websites shares. Creating it monitors nothing yet: assign websites with “Assign websites to an uptime global configuration”.

Body

  • name (string, required): the configuration’s name, at most 255 characters.
  • region (string, required): where the checks run from: eu-west-1, us-east-1 or ap-southeast-1.
  • interval (integer, optional): seconds between checks: 120, 300, 900 or 1800. Default 300. The values 120 and 300 depend on your plan and are refused without it.
  • timeout (integer, optional): milliseconds a check waits for the answer: 1000, 2000, 5000, 10000, 20000, 30000 or 45000. Default 30000.
  • method (GET or HEAD, optional): HTTP method of the check. Default HEAD.
  • status_codes (array of strings, optional): HTTP status codes that count as working, either a range such as 2xx or an exact code such as 503. Default ["2xx"].
  • default (boolean, optional): true makes it the configuration new websites receive.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
intervaldoubleOptional
namestringOptional
regionstringOptional
status_codeslist of stringsOptional

Response headers

LocationstringOptional

Response

201 - Uptime configuration created

dataobjectOptional
jsonapiobjectOptional