Retrieve a website

GET

https://api.modulards.com/api/public/v1/sites/:site

GET

/api/public/v1/sites/:site

curl https://api.modulards.com/api/public/v1/sites/30 \
     -H "Authorization: Bearer <token>"

200200 - Website

{
  "data": {
    "attributes": {
      "host": "acme-corp.com",
      "name": "Acme Corp",
      "note": "<p>Client prefers deployments on Tuesdays.</p>"
    },
    "id": "101",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/sites/101"
    },
    "relationships": {
      "site_preset_uptime": {
        "data": {
          "id": "553",
          "type": "site-preset-uptimes"
        }
      },
      "tags": {
        "data": [
          {
            "id": "1",
            "type": "tags"
          }
        ]
      },
      "team": {
        "data": {
          "id": "7",
          "type": "teams"
        }
      }
    },
    "type": "sites"
  },
  "included": [
    {
      "attributes": {
        "created_at": "2026-01-14T09:30:00.000000Z",
        "name": "Default team",
        "slug": "default-team",
        "updated_at": "2026-01-14T09:30:00.000000Z"
      },
      "id": "7",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/teams/7"
      },
      "type": "teams"
    },
    {
      "attributes": {
        "color": "#FF5733",
        "created_at": "2026-01-20T10:00:00.000000Z",
        "name": "Production",
        "order": 1,
        "updated_at": "2026-01-20T10:00:00.000000Z"
      },
      "id": "1",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/tags/1"
      },
      "type": "tags"
    },
    {
      "attributes": {
        "created_at": "2026-09-01T08:30:00.000000Z",
        "keyword": {
          "keys": [],
          "status": "disabled",
          "type": null
        },
        "next_request": "2026-09-17T10:08:00.000000Z",
        "path": null,
        "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"
    },
    {
      "attributes": {
        "created_at": "2026-09-17T09:12:44.000000Z",
        "interval": 300,
        "is_default": false,
        "method": "HEAD",
        "name": "Shops",
        "region": "eu-west-1",
        "sites_count": 12,
        "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 one website with its details and its private note. Add related records with include, or trim the attributes with fields[sites].

The note is returned by default, unlike in “List websites”; naming fields[sites] without note leaves it out. Only include and fields apply: filter, sort and page are ignored.

Authentication

AuthorizationBearer

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

Path parameters

sitestringRequired

Query parameters

includestringOptional

Related records to embed, comma-separated: team, tags, site_preset_backup, site_preset_uptime, site_preset_malware_scan, site_preset_broken_link, site_preset_patchstack. site_preset_uptime embeds the website's Uptime Monitor settings with their global configuration and current state; its id is the one "Retrieve a website's uptime settings" and "Update a website's uptime settings" take. site_preset_backup does the same for backups, and site_preset_patchstack for Patch & Protect: its id is the one "Retrieve a website's Patch & Protect settings" takes, and it is null for a website without protection.

fields[sites]stringOptional

Attributes to return, comma-separated; only those are returned. Computed attributes are left out unless named: note, is_favorite, updatable_items_count, vulnerable_items_count and has_patchstack.

Response

200 - Website

dataobjectOptional

includedlist of objectsOptional

jsonapiobjectOptional