> 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. # Show site GET https://api.modulards.com/api/public/v1/sites/{site} Reads one website in full. `note` decrypts and appears by default here even without naming it in `fields[sites]` - unlike "List sites", where it stays out unless requested. Query params: `include` (`team`, `tags`, `site_preset_backup`, `site_preset_uptime`, `site_preset_malware_scan`, `site_preset_broken_link`) and `fields[sites]` (sparse fieldset - when present, only the named attributes are returned). Answers **200** with the resource document; `included` carries whatever `include` named. Sites of other organizations answer 404. Reference: https://api.docs.modulards.com/modular-ds-public-api/websites/show-site ## 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) — site_preset_uptime embeds the website's Uptime Monitor settings (status, configuration, keyword, path, redirects) - the id "Show uptime service" and "Update uptime service" take - `fields[sites]` (string, optional) — note answers by default on show even without this param; named here to show it opts into the index too ## Response ### 200 200 - Website - `data` (object, optional) - `attributes` (object, optional) - `host` (string, optional) - `name` (string, optional) - `note` (string, optional) - `id` (string, optional) - `links` (object, optional) - `self` (string, optional) - `relationships` (object, optional) - `site_preset_uptime` (object, optional) - `data` (object, optional) - `id` (string, optional) - `type` (string, optional) - `tags` (object, optional) - `data` (list of object, optional) - `id` (string, optional) - `type` (string, optional) - `team` (object, optional) - `data` (object, optional) - `id` (string, optional) - `type` (string, optional) - `type` (string, optional) - `included` (list of object, optional) - `attributes` (object, optional) - `color` (string, optional) - `created_at` (string, optional) - `keyword` (object, optional) - `keys` (list of any, optional) - `status` (string, optional) - `type` (any, optional, nullable) - `name` (string, optional) - `next_request` (string, optional) - `order` (double, optional) - `path` (any, optional, nullable) - `redirects` (object, optional) - `expected_url` (any, optional, nullable) - `max_redirects` (double, optional) - `status` (string, optional) - `site_status` (string, optional) - `slug` (string, optional) - `status` (string, optional) - `updated_at` (string, optional) - `id` (string, optional) - `links` (object, optional) - `self` (string, optional) - `type` (string, optional) - `jsonapi` (object, optional) - `version` (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" }, "type": "site-preset-uptimes" } ], "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() ```