> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api.docs.modulards.com/modular-ds-public-api/websites/maintenance/retrieve-a-website-s-maintenance-mode-settings/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server. # Retrieve a website's maintenance mode settings GET https://api.modulards.com/api/public/v1/sites/{site}/maintenance 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`. Reference: https://api.docs.modulards.com/modular-ds-public-api/websites/maintenance/retrieve-a-website-s-maintenance-mode-settings ## Authentication - `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints. ## Request ### Path parameters - `site` (string, required) ## Response ### 200 200 - Maintenance settings - `data` (ApiPublicV1SitesSiteMaintenanceGetResponsesContentApplicationJsonSchemaData, optional) - `jsonapi` (ApiPublicV1SitesSiteMaintenanceGetResponsesContentApplicationJsonSchemaJsonapi, optional) ## Types ### ApiPublicV1SitesSiteMaintenanceGetResponsesContentApplicationJsonSchemaData - `attributes` (ApiPublicV1SitesSiteMaintenanceGetResponsesContentApplicationJsonSchemaDataAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1SitesSiteMaintenanceGetResponsesContentApplicationJsonSchemaDataLinks, optional) - `type` (string, optional) ### ApiPublicV1SitesSiteMaintenanceGetResponsesContentApplicationJsonSchemaJsonapi - `version` (string, optional) ### ApiPublicV1SitesSiteMaintenanceGetResponsesContentApplicationJsonSchemaDataAttributes - `connection_status` (string, optional) - `connector_version` (string, optional) - `core_version` (string, optional) - `created_at` (string, optional) - `created_by` (double, optional) - `db_engine` (string, optional) - `db_engine_version` (string, optional) - `deleted_at` (any, optional, nullable) - `display_host` (string, optional) - `ecommerce_engine` (string, optional) - `ecommerce_version` (string, optional) - `engine` (string, optional) - `engine_version` (string, optional) - `host` (string, optional) - `is_connected` (boolean, optional) - `is_main_site` (boolean, optional) - `is_multisite` (boolean, optional) - `locale` (string, optional) - `maintenance_background` (string, optional) - `maintenance_description` (string, optional) - `maintenance_noindex` (boolean, optional) - `maintenance_status` (string, optional) - `maintenance_title` (string, optional) - `name` (string, optional) - `path` (any, optional, nullable) - `provider` (string, optional) - `scheme` (string, optional) - `slug` (string, optional) - `synced_at` (string, optional) - `timezone` (string, optional) - `updated_at` (string, optional) - `uri` (string, optional) ### ApiPublicV1SitesSiteMaintenanceGetResponsesContentApplicationJsonSchemaDataLinks - `self` (string, optional) ## Examples **Response** ```json { "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" } } ``` **SDK Code** ```python 200 - Maintenance settings import requests url = "https://api.modulards.com/api/public/v1/sites/site/maintenance" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - Maintenance settings const url = 'https://api.modulards.com/api/public/v1/sites/site/maintenance'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 - Maintenance settings package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/sites/site/maintenance" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby 200 - Maintenance settings require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/sites/site/maintenance") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 - Maintenance settings import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/sites/site/maintenance") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Maintenance settings request('GET', 'https://api.modulards.com/api/public/v1/sites/site/maintenance', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Maintenance settings using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/sites/site/maintenance"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Maintenance settings import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/sites/site/maintenance")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```