Create uptime configuration

POST

https://api.modulards.com/api/public/v1/preset-uptimes

POST

/api/public/v1/preset-uptimes

curl -X POST https://api.modulards.com/api/public/v1/preset-uptimes \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "interval": 900,
  "name": "Shops",
  "region": "eu-west-1",
  "status_codes": [
    "2xx",
    "3xx"
  ]
}'

201Create uptime configuration

{
  "data": {
    "attributes": {
      "created_at": "2026-09-17T09:12:44.000000Z",
      "interval_seconds": 900,
      "is_default": false,
      "method": "HEAD",
      "name": "Shops",
      "region": "eu-west-1",
      "status": "enabled",
      "status_codes": [
        "2xx",
        "3xx"
      ],
      "timeout_ms": 30000,
      "updated_at": "2026-09-17T09:12:44.000000Z"
    },
    "id": "9",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/preset-uptimes/9"
    },
    "type": "preset-uptimes"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

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

Body (JSON):

name (string, required, max 255).
region (string, required) - where the checks run from: eu-west-1, us-east-1, ap-southeast-1.
interval (integer, optional) - seconds between checks: 120, 300, 900 or 1800; default 300. 120 and 300 depend on the 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 (string, optional) - HTTP method of the check: GET, HEAD; default HEAD.
status_codes (array of string, optional) - HTTP status codes that count as working: 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.

Requires a full-access token (read-only tokens answer 403). Validation failures answer 422 with a JSON:API errors document.

Creates an Uptime Monitor global configuration: the check settings a group of websites shares. Answers **201** with the configuration document and a `Location` header. Creating it monitors nothing yet - assign websites with "Assign websites to an uptime configuration". **Body** (JSON): - `name` (string, required, max 255). - `region` (string, required) - where the checks run from: `eu-west-1`, `us-east-1`, `ap-southeast-1`. - `interval` (integer, optional) - seconds between checks: 120, 300, 900 or 1800; default 300. 120 and 300 depend on the 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` (string, optional) - HTTP method of the check: `GET`, `HEAD`; default `HEAD`. - `status_codes` (array of string, optional) - HTTP status codes that count as working: 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. Requires a full-access token (read-only tokens answer 403). Validation failures answer 422 with a JSON:API `errors` document.

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