> 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 Broken Links service GET https://api.modulards.com/api/public/v1/broken-link-services/{site_preset_broken_link} Read one website's Broken Links Checker settings. The id is the website's Broken Links Checker service id: read it from the `site_preset_broken_link` include of a website (`GET /api/public/v1/sites/{site}?include=site_preset_broken_link`, which also carries the global configuration the website uses) or from `meta.updated` of "Assign websites to a Broken Links configuration". Response attributes: `status` (enabled, disabled - a paused website can still be scanned on demand), `schedule` (the schedule inherited from the configuration), `max_pages` (the page cap), `excluded` (object with `url_patterns` and `source_types` arrays, what discovery leaves out), `scan_status`, `last_scan_at`, `issues_count`, `broken_links_count`, `mixed_content_count`, `pages_scanned` (the results of the last scan), `last_request`, `next_request` (null while the website is paused) and the timestamps. The `preset` relationship carries the global configuration this website uses (canonical shape, its own nested `schedule`), included by default. A website that was never assigned a configuration has no Broken Links Checker service. A service of another organization answers 404. Reference: https://api.docs.modulards.com/modular-ds-public-api/broken-links-checker/show-broken-links-service ## 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_broken_link` (string, required) ## Response ### 200 200 - Broken Links service - `data` (object, optional) - `attributes` (object, optional) - `broken_links_count` (double, optional) - `created_at` (string, optional) - `excluded` (object, optional) - `source_types` (list of string, optional) - `url_patterns` (list of string, optional) - `issues_count` (double, optional) - `last_request` (string, optional) - `last_scan_at` (string, optional) - `max_pages` (double, optional) - `mixed_content_count` (double, optional) - `next_request` (string, optional) - `pages_scanned` (double, optional) - `scan_status` (string, optional) - `schedule` (object, optional) - `day_month` (double, optional) - `day_week` (any, optional, nullable) - `frequency` (string, optional) - `start_hour` (string, optional) - `timezone` (string, optional) - `status` (string, optional) - `updated_at` (string, optional) - `id` (string, optional) - `links` (object, optional) - `self` (string, optional) - `relationships` (object, optional) - `preset` (object, optional) - `data` (object, optional) - `id` (string, optional) - `type` (string, optional) - `type` (string, optional) - `included` (list of object, optional) - `attributes` (object, optional) - `check_external` (boolean, optional) - `check_internal` (boolean, optional) - `check_mixed_content` (boolean, optional) - `created_at` (string, optional) - `is_default` (boolean, optional) - `mode` (string, optional) - `name` (string, optional) - `resource_types` (list of string, optional) - `schedule` (object, optional) - `day_month` (double, optional) - `day_week` (any, optional, nullable) - `frequency` (string, optional) - `start_hour` (string, optional) - `timezone` (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": { "broken_links_count": 10, "created_at": "2026-08-01T09:00:00.000000Z", "excluded": { "source_types": [ "attachment" ], "url_patterns": [ "/tag/" ] }, "issues_count": 12, "last_request": "2026-09-10T03:00:00.000000Z", "last_scan_at": "2026-09-10T03:12:00.000000Z", "max_pages": 500, "mixed_content_count": 2, "next_request": "2026-10-04T03:17:00.000000Z", "pages_scanned": 240, "scan_status": "done", "schedule": { "day_month": 4, "day_week": null, "frequency": "monthly", "start_hour": "03:00", "timezone": "UTC" }, "status": "enabled", "updated_at": "2026-09-17T10:00:00.000000Z" }, "id": "901", "links": { "self": "https://api.modulards.com/api/public/v1/broken-link-services/901" }, "relationships": { "preset": { "data": { "id": "42", "type": "preset-broken-links" } } }, "type": "site-preset-broken-links" }, "included": [ { "attributes": { "check_external": false, "check_internal": true, "check_mixed_content": true, "created_at": "2026-09-17T10:00:00.000000Z", "is_default": true, "mode": "plain", "name": "Monthly check", "resource_types": [ "link", "image", "script", "stylesheet" ], "schedule": { "day_month": 4, "day_week": null, "frequency": "monthly", "start_hour": "03:00", "timezone": "UTC" }, "status": "enabled", "updated_at": "2026-09-17T10:00:00.000000Z" }, "id": "42", "links": { "self": "https://api.modulards.com/api/public/v1/preset-broken-links/42" }, "type": "preset-broken-links" } ], "jsonapi": { "version": "1.1" } } ``` **SDK Code** ```python 200 - Broken Links service import requests url = "https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - Broken Links service const url = 'https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link'; 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 - Broken Links service package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link" 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 - Broken Links service require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link") 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 - Broken Links service import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - Broken Links service request('GET', 'https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - Broken Links service using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - Broken Links service import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/broken-link-services/site_preset_broken_link")! 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() ```