> 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 GET https://api.modulards.com/api/public/v1/sites/{site} 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. Reference: https://api.docs.modulards.com/modular-ds-public-api/websites/manage-websites/retrieve-a-website ## 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) ### Query parameters - `include` (string, optional) — 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]` (string, optional) — 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 200 - Website - `data` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaData, optional) - `included` (list of ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItems, optional) - `jsonapi` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaJsonapi, optional) ## Types ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaData - `attributes` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataLinks, optional) - `relationships` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationships, optional) - `type` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItems - `attributes` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsLinks, optional) - `relationships` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsRelationships, optional) - `type` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaJsonapi - `version` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataAttributes - `host` (string, optional) - `name` (string, optional) - `note` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataLinks - `self` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationships - `site_preset_uptime` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsSitePresetUptime, optional) - `tags` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsTags, optional) - `team` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsTeam, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsAttributes - `color` (string, optional) - `created_at` (string, optional) - `duration` (any, optional, nullable) - `ended_at` (any, optional, nullable) - `interval` (double, optional) - `is_default` (boolean, optional) - `keyword` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsAttributesKeyword, optional) - `method` (string, optional) - `name` (string, optional) - `next_request` (string, optional) - `order` (double, optional) - `path` (any, optional, nullable) - `redirects` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsAttributesRedirects, optional) - `region` (string, optional) - `site_status` (string, optional) - `sites_count` (double, optional) - `slug` (string, optional) - `started_at` (string, optional) - `status` (string, optional) - `status_codes` (list of string, optional) - `timeout` (double, optional) - `updated_at` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsLinks - `self` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsRelationships - `current_change` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsRelationshipsCurrentChange, optional) - `preset` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsRelationshipsPreset, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsSitePresetUptime - `data` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsSitePresetUptimeData, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsTags - `data` (list of ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsTagsDataItems, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsTeam - `data` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsTeamData, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsAttributesKeyword - `keys` (list of any, optional) - `status` (string, optional) - `type` (any, optional, nullable) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsAttributesRedirects - `expected_url` (any, optional, nullable) - `max_redirects` (double, optional) - `status` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsRelationshipsCurrentChange - `data` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsRelationshipsCurrentChangeData, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsRelationshipsPreset - `data` (ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsRelationshipsPresetData, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsSitePresetUptimeData - `id` (string, optional) - `type` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsTagsDataItems - `id` (string, optional) - `type` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaDataRelationshipsTeamData - `id` (string, optional) - `type` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsRelationshipsCurrentChangeData - `id` (string, optional) - `type` (string, optional) ### ApiPublicV1SitesSiteGetResponsesContentApplicationJsonSchemaIncludedItemsRelationshipsPresetData - `id` (string, optional) - `type` (string, optional) ## Examples **Response** ```json { "data": { "attributes": { "host": "acme-corp.com", "name": "Acme Corp", "note": "

Client prefers deployments on Tuesdays.

" }, "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" } } ``` **SDK Code** ```python 200 - Website import requests url = "https://api.modulards.com/api/public/v1/sites/30" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - Website const url = 'https://api.modulards.com/api/public/v1/sites/30'; 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 - Website package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/sites/30" 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 - Website require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/sites/30") 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 - Website import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/sites/30") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Website request('GET', 'https://api.modulards.com/api/public/v1/sites/30', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Website using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/sites/30"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Website import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/sites/30")! 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() ```