> 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 broken link scan GET https://api.modulards.com/api/public/v1/site-broken-link-scans/{siteBrokenLinkScan} Returns one Broken Links Checker scan, with the same information as "List broken link scans". Use the id that "Launch broken link scans" returned, or one from the list. Reference: https://api.docs.modulards.com/modular-ds-public-api/broken-links-checker/broken-links-scans/retrieve-a-broken-link-scan ## 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 - `siteBrokenLinkScan` (string, required) ## Response ### 200 200 - scan - `data` (ApiPublicV1SiteBrokenLinkScansSiteBrokenLinkScanGetResponsesContentApplicationJsonSchemaData, optional) - `jsonapi` (ApiPublicV1SiteBrokenLinkScansSiteBrokenLinkScanGetResponsesContentApplicationJsonSchemaJsonapi, optional) ## Types ### ApiPublicV1SiteBrokenLinkScansSiteBrokenLinkScanGetResponsesContentApplicationJsonSchemaData - `attributes` (ApiPublicV1SiteBrokenLinkScansSiteBrokenLinkScanGetResponsesContentApplicationJsonSchemaDataAttributes, optional) - `id` (string, optional) - `links` (ApiPublicV1SiteBrokenLinkScansSiteBrokenLinkScanGetResponsesContentApplicationJsonSchemaDataLinks, optional) - `type` (string, optional) ### ApiPublicV1SiteBrokenLinkScansSiteBrokenLinkScanGetResponsesContentApplicationJsonSchemaJsonapi - `version` (string, optional) ### ApiPublicV1SiteBrokenLinkScansSiteBrokenLinkScanGetResponsesContentApplicationJsonSchemaDataAttributes - `created_at` (datetime, optional) — When the scan was created. - `current_batch` (integer, optional) — Batch being processed; 0 until the plugin reports. - `error_code` (string, optional, nullable) — Failure code; null unless the scan failed. - `error_message` (string, optional, nullable) — Failure message; null unless the scan failed. - `finished_at` (datetime, optional, nullable) — When the scan ended; null while it runs. - `links_enumerated` (integer, optional) — Links found by discovery. - `links_planned` (integer, optional) — Links planned for checking, updated while the scan runs. - `method` (enum, optional) — How the scan started: `manual`, `automatic` for a scheduled one, or `force_first` for the first automatic scan of a website. - Allowed values: `manual`, `automatic`, `force_first` - `pages_enumerated` (integer, optional) — Pages found by discovery. - `pages_planned` (integer, optional) — Pages planned for checking, updated while the scan runs. - `parts_done` (integer, optional) — Crawl parts finished. - `parts_empty` (integer, optional) — Crawl parts that found nothing to check. - `parts_failed` (integer, optional) — Crawl parts that failed. - `parts_total` (integer, optional) — Crawl parts planned. - `site_id` (integer, optional) — Id of the website that was scanned. - `status` (enum, optional) — How the scan ended: pending while it runs, done, failed, or failed_partial when some content types finished and others failed. - Allowed values: `pending`, `done`, `failed`, `failed_partial` - `total_batches` (integer, optional) — Batches the scan is split in. - `type` (enum, optional) — Scope of the scan: full covers every published content type, page only the pages named when it was launched. - Allowed values: `full`, `page` - `updated_at` (string, optional) ### ApiPublicV1SiteBrokenLinkScansSiteBrokenLinkScanGetResponsesContentApplicationJsonSchemaDataLinks - `self` (string, optional) ## Examples **Response** ```json { "data": { "attributes": { "created_at": "2026-09-16T09:00:00.000000Z", "current_batch": 5, "error_code": null, "error_message": null, "finished_at": "2026-09-16T09:14:00.000000Z", "links_enumerated": 1830, "links_planned": 0, "method": "manual", "pages_enumerated": 240, "pages_planned": 0, "parts_done": 4, "parts_empty": 0, "parts_failed": 0, "parts_total": 4, "site_id": 12, "status": "done", "total_batches": 5, "type": "full", "updated_at": "2026-09-16T09:14:00.000000Z" }, "id": "5001", "links": { "self": "https://api.modulards.com/api/public/v1/site-broken-link-scans/5001" }, "type": "site-broken-link-scans" }, "jsonapi": { "version": "1.1" } } ``` **SDK Code** ```python 200 - scan import requests url = "https://api.modulards.com/api/public/v1/site-broken-link-scans/siteBrokenLinkScan" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - scan const url = 'https://api.modulards.com/api/public/v1/site-broken-link-scans/siteBrokenLinkScan'; 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 - scan package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/site-broken-link-scans/siteBrokenLinkScan" 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 - scan require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/site-broken-link-scans/siteBrokenLinkScan") 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 - scan import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/site-broken-link-scans/siteBrokenLinkScan") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - scan request('GET', 'https://api.modulards.com/api/public/v1/site-broken-link-scans/siteBrokenLinkScan', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - scan using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/site-broken-link-scans/siteBrokenLinkScan"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - scan import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/site-broken-link-scans/siteBrokenLinkScan")! 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() ```