Retrieve a website's uptime settings

GET

https://api.modulards.com/api/public/v1/uptime-services/:site_preset_uptime

GET

/api/public/v1/uptime-services/:site_preset_uptime

curl https://api.modulards.com/api/public/v1/uptime-services/site_preset_uptime \
     -H "Authorization: Bearer <token>"

{
  "data": {
    "attributes": {
      "created_at": "2026-09-01T08:30:00.000000Z",
      "keyword": {
        "keys": [
          "Welcome",
          "Dashboard"
        ],
        "status": "enabled",
        "type": "some"
      },
      "next_request": "2026-09-17T10:08:00.000000Z",
      "path": "/shop",
      "redirects": {
        "expected_url": null,
        "max_redirects": 3,
        "status": "disabled"
      },
      "site_status": "up",
      "status": "enabled",
      "updated_at": "2026-09-17T10:03:10.000000Z"
    },
    "id": "553",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/uptime-services/553"
    },
    "relationships": {
      "current_change": {
        "data": {
          "id": "231",
          "type": "uptime-changes"
        }
      },
      "preset": {
        "data": {
          "id": "9",
          "type": "preset-uptimes"
        }
      }
    },
    "type": "site-preset-uptimes"
  },
  "included": [
    {
      "attributes": {
        "created_at": "2026-09-17T09:12:44.000000Z",
        "interval": 300,
        "is_default": false,
        "method": "HEAD",
        "name": "Shops",
        "region": "eu-west-1",
        "status": "enabled",
        "status_codes": [
          "2xx"
        ],
        "timeout": 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"
    },
    {
      "attributes": {
        "created_at": "2026-09-10T06:15:00.000000Z",
        "duration": null,
        "ended_at": null,
        "started_at": "2026-09-10T06:15:00.000000Z",
        "status": "up",
        "updated_at": "2026-09-10T06:15:00.000000Z"
      },
      "id": "231",
      "type": "uptime-changes"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  }
}

Returns how one website is monitored: whether monitoring is on, its keyword check (type some needs at least one keyword on the page, every needs all of them; plan-dependent), its redirect check, the path checked (null for the website root), the website’s last known reachability (site_status: up, down or unknown, read only) and when the next check runs. The values read back under the same keys “Update a website’s uptime settings” accepts.

The id is the website’s uptime settings id: read it from the site_preset_uptime include of “Retrieve a website” (?include=site_preset_uptime) or from meta.updated of “Assign websites to an uptime global configuration”.

A website that was never assigned a global configuration has no uptime settings.

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.

Response

200 - Uptime service

dataobjectOptional

includedlist of objectsOptional

jsonapiobjectOptional

Errors

400

Bad Request Error