> 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. # List websites' uptime GET https://api.modulards.com/api/public/v1/uptime Lists the current uptime status of your monitored websites, one row per website, so a single call answers "is anything down right now?". Each row shows whether the monitor is on, the website's status (`up`, `down` or `unknown`), since when it has had that status and its last ping. `last_ping` is null when the monitor has not pinged in the last 30 days. Outages come first by default. The rolling availability of one website is in "Retrieve a website's uptime". Your role must be allowed to read uptime; without it the request answers 404. Reference: https://api.docs.modulards.com/modular-ds-public-api/uptime-monitor/monitoring-results/list-websites-uptime ## Authentication - `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints. ## Request ### Query parameters - `filter[site][]` (string, optional) — Exact website ids. Repeat the parameter for several: any of them matches. - `filter[status][]` (string, optional) — The website's current status: `up`, `down` or `unknown`. Repeat the parameter for several: any of them matches. - `filter[service_status][]` (string, optional) — Whether the monitor is on: `enabled` or `disabled`. Repeat the parameter for several. - `filter[s]` (string, optional) — Free-text search over the website name, slug or URL (max 255 characters). - `sort` (string, optional) — `status` or `site_name`; prefix with `-` for descending. Default: `-status` (outages first). - `page[number]` (string, optional) — Page number, starting at 1. Default 1. - `page[size]` (string, optional) — Items per page, 1 to 50. Default 15. ## Response ### 200 200 - Uptime portfolio, one website down - `data` (list of ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaDataItems, optional) - `jsonapi` (ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaJsonapi, optional) - `links` (ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaLinks, optional) - `meta` (ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaMeta, optional) ## Types ### ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaDataItems - `attributes` (ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaDataItemsAttributes, optional) - `id` (string, optional) — Id of the website's uptime settings. - `links` (ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaDataItemsLinks, optional) - `type` (string, optional) ### ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaJsonapi - `version` (string, optional) ### ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaLinks - `first` (string, optional) - `last` (string, optional) - `next` (any, optional, nullable) - `prev` (any, optional, nullable) ### ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaMeta - `current_page` (double, optional) - `from` (double, optional) - `last_page` (double, optional) - `links` (list of ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaMetaLinksItems, optional) - `path` (string, optional) - `per_page` (double, optional) - `to` (double, optional) - `total` (double, optional) ### ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaDataItemsAttributes - `enabled` (boolean, optional) — Whether the monitor is on. - `last_ping` (ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaDataItemsAttributesLastPing, optional, nullable) — The last ping in the last 30 days; null when there is none. - `site` (ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaDataItemsAttributesSite, optional) - `status` (enum, optional) — The website's current status: up, down or unknown. - Allowed values: `up`, `down`, `unknown` - `status_since` (string, optional, nullable) — When the website entered its current status (ISO 8601). ### ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaDataItemsLinks - `self` (string, optional) ### ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaMetaLinksItems - `active` (boolean, optional) - `label` (string, optional) - `url` (string, optional, nullable) ### ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaDataItemsAttributesLastPing The last ping in the last 30 days; null when there is none. - `at` (string, optional) — When the ping ran (ISO 8601). - `error` (string, optional, nullable) — Error recorded for a failed ping. - `response_time_ms` (integer, optional, nullable) — Response time in milliseconds; null when there was no answer. - `status` (enum, optional) — up, down or unknown. - Allowed values: `up`, `down`, `unknown` - `status_code` (integer, optional, nullable) — HTTP status the website answered; null when it did not answer. ### ApiPublicV1UptimeGetResponsesContentApplicationJsonSchemaDataItemsAttributesSite - `id` (integer, optional) — Website id. - `name` (string, optional) — Website name. ## Examples **Response** ```json { "data": [ { "attributes": { "enabled": true, "last_ping": { "at": "2026-02-10T11:00:00.000000Z", "error": "Server error", "response_time_ms": null, "status": "down", "status_code": 503 }, "site": { "id": 1, "name": "Portfolio site" }, "status": "down", "status_since": "2026-02-10T11:00:00.000000Z" }, "id": "1", "links": { "self": "{{base_url}}/api/public/v1/uptime-services/1" }, "type": "site-uptimes" }, { "attributes": { "enabled": true, "last_ping": { "at": "2026-09-21T10:00:00.000000Z", "error": null, "response_time_ms": 312, "status": "up", "status_code": 200 }, "site": { "id": 5, "name": "Marketing site" }, "status": "up", "status_since": "2026-08-01T06:00:00.000000Z" }, "id": "2", "links": { "self": "{{base_url}}/api/public/v1/uptime-services/2" }, "type": "site-uptimes" } ], "jsonapi": { "version": "1.1" }, "links": { "first": "{{base_url}}/api/public/v1/uptime?page%5Bnumber%5D=1", "last": "{{base_url}}/api/public/v1/uptime?page%5Bnumber%5D=1", "next": null, "prev": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "active": false, "label": "« Previous", "url": null }, { "active": true, "label": "1", "url": "{{base_url}}/api/public/v1/uptime?page%5Bnumber%5D=1" }, { "active": false, "label": "Next »", "url": null } ], "path": "{{base_url}}/api/public/v1/uptime", "per_page": 15, "to": 2, "total": 2 } } ``` **SDK Code** ```python 200 - Uptime portfolio, one website down import requests url = "https://api.modulards.com/api/public/v1/uptime" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - Uptime portfolio, one website down const url = 'https://api.modulards.com/api/public/v1/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 portfolio, one website down package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/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 portfolio, one website down require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/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 portfolio, one website down import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/uptime") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Uptime portfolio, one website down request('GET', 'https://api.modulards.com/api/public/v1/uptime', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Uptime portfolio, one website down using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/uptime"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Uptime portfolio, one website down import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/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() ```