> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://api.docs.modulards.com/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 uptime settings GET https://api.modulards.com/api/public/v1/uptime-services/{site_preset_uptime} 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. Reference: https://api.docs.modulards.com/modular-ds-public-api/uptime-monitor/uptime-settings/retrieve-a-website-s-uptime-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_preset_uptime` (string, required) ### Query parameters - `include` (string, optional) — 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 200 - Uptime service - `data` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaData, optional) - `included` (list of ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaIncludedItems, optional) - `jsonapi` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaJsonapi, optional) ## Errors ### 400 Bad Request Error 400 - Unknown include - `errors` (list of ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaErrorsItems, optional) - `jsonapi` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaJsonapi, optional) ## Types ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaData - `attributes` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataLinks, optional) - `relationships` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataRelationships, optional) - `type` (string, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaIncludedItems - `attributes` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaIncludedItemsAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaIncludedItemsLinks, optional) - `type` (string, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaJsonapi - `version` (string, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaErrorsItems - `detail` (string, optional) - `source` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaErrorsItemsSource, optional) - `status` (string, optional) - `title` (string, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataAttributes - `created_at` (string, optional) - `keyword` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataAttributesKeyword, optional, nullable) — Keyword check: the monitor looks for these words in the page. - `next_request` (string, optional) - `path` (string, optional, nullable) — Path the monitor checks; null for the website root. - `redirects` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataAttributesRedirects, optional, nullable) — Redirect check. - `site_status` (enum, optional, nullable) — The website's last known reachability. Read only. - Allowed values: `up`, `down`, `unknown` - `status` (string, optional) - `updated_at` (string, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataLinks - `self` (string, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataRelationships - `current_change` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataRelationshipsCurrentChange, optional) - `preset` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataRelationshipsPreset, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaIncludedItemsAttributes - `created_at` (string, optional) - `duration` (any, optional, nullable) - `ended_at` (any, optional, nullable) - `interval` (double, optional) - `is_default` (boolean, optional) - `method` (string, optional) - `name` (string, optional) - `region` (string, optional) - `started_at` (string, optional) - `status` (string, optional) - `status_codes` (list of string, optional) - `timeout` (double, optional) - `updated_at` (string, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaIncludedItemsLinks - `self` (string, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaErrorsItemsSource - `parameter` (string, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataAttributesKeyword Keyword check: the monitor looks for these words in the page. - `keys` (list of string, optional) — Keywords to look for. - `status` (enum, optional) — Whether the keyword check is on. - Allowed values: `enabled`, `disabled` - `type` (string, optional) — some when at least one keyword must appear, every when all of them must (plan-gated); none while no keyword check is set. ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataAttributesRedirects Redirect check. - `expected_url` (string, optional, nullable) — Address the redirects must end on; null when any is accepted. - `max_redirects` (integer, optional) — Redirects the monitor follows before it gives up. - `status` (enum, optional) — Whether the redirect check is on. - Allowed values: `enabled`, `disabled` ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataRelationshipsCurrentChange - `data` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataRelationshipsCurrentChangeData, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataRelationshipsPreset - `data` (ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataRelationshipsPresetData, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataRelationshipsCurrentChangeData - `id` (string, optional) - `type` (string, optional) ### ApiPublicV1UptimeServicesSitePresetUptimeGetResponsesContentApplicationJsonSchemaDataRelationshipsPresetData - `id` (string, optional) - `type` (string, optional) ## Examples **Response** ```json { "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" } } ``` **SDK Code** ```python 200 - Uptime service import requests url = "https://api.modulards.com/api/public/v1/uptime-services/site_preset_uptime" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - Uptime service const url = 'https://api.modulards.com/api/public/v1/uptime-services/site_preset_uptime'; 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 - Uptime service package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/uptime-services/site_preset_uptime" 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 - Uptime service require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/uptime-services/site_preset_uptime") 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 - Uptime service import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/uptime-services/site_preset_uptime") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Uptime service request('GET', 'https://api.modulards.com/api/public/v1/uptime-services/site_preset_uptime', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Uptime service using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/uptime-services/site_preset_uptime"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Uptime service import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/uptime-services/site_preset_uptime")! 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() ```