Retrieve a website's maintenance mode settings

GET

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

GET

/api/public/v1/sites/:site/maintenance

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

200200 - Maintenance settings

{
  "data": {
    "attributes": {
      "connection_status": "established",
      "connector_version": "3.4.2",
      "core_version": "6.6.2",
      "created_at": "2026-01-14T09:30:00.000000Z",
      "created_by": 42,
      "db_engine": "mysql",
      "db_engine_version": "8.0.36",
      "deleted_at": null,
      "display_host": "acme-corp.com",
      "ecommerce_engine": "woocommerce",
      "ecommerce_version": "9.2.3",
      "engine": "php",
      "engine_version": "8.3.10",
      "host": "acme-corp.com",
      "is_connected": true,
      "is_main_site": true,
      "is_multisite": false,
      "locale": "en_US",
      "maintenance_background": "#1a1a2e",
      "maintenance_description": "Scheduled maintenance in progress.",
      "maintenance_noindex": false,
      "maintenance_status": "disabled",
      "maintenance_title": "We will be right back",
      "name": "Acme Corp",
      "path": null,
      "provider": "wp",
      "scheme": "https",
      "slug": "acme-corp",
      "synced_at": "2026-09-16T08:12:00.000000Z",
      "timezone": "Europe/Madrid",
      "updated_at": "2026-09-16T08:12:00.000000Z",
      "uri": "https://acme-corp.com"
    },
    "id": "101",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/sites/101"
    },
    "type": "sites"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Returns a website’s maintenance mode settings: whether the mode is on and what the maintenance page shows. It is the website with five extra attributes that only this request and “Update a website’s maintenance mode” return: maintenance_status (enabled or disabled), maintenance_noindex, maintenance_background, maintenance_description and maintenance_title.

Authentication

AuthorizationBearer

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

Path parameters

sitestringRequired

Response

200 - Maintenance settings

dataobjectOptional

jsonapiobjectOptional