> 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 configuration

GET https://api.modulards.com/api/public/v1/preset-broken-links/{preset_broken_link}

Read one Broken Links Checker global configuration in full: its schedule, what it checks, how the plugin reads page content and whether it is the default for new websites. Ids come from "List broken link presets".

Response attributes: `name`, `status` (enabled, disabled - the configuration itself is always enabled; scans are paused per website), `is_default`, `schedule` (object: `frequency` - weekly, monthly; `start_hour` - HH:MM; `timezone`; `day_week`; `day_month`), `check_internal`, `check_external`, `check_mixed_content`, `resource_types` (`link`, `image`, `script`, `stylesheet`, `og_image`, `canonical`), `mode` (`plain`, `render`), `created_at`, `updated_at`. `sites_count`, how many websites use the configuration, is opt in with `fields[preset-broken-links]=sites_count`.

A configuration of another organization answers 404.

Reference: https://api.docs.modulards.com/modular-ds-public-api/broken-links-configurations/show-broken-links-configuration

## 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

- `preset_broken_link` (string, required)

### Query parameters

- `fields[preset-broken-links]` (string, optional) — Opt into the computed website count

## Response

### 200

200 - Broken Links configuration

- `data` (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": {
      "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 configuration
import requests

url = "https://api.modulards.com/api/public/v1/preset-broken-links/preset_broken_link"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript 200 - Broken Links configuration
const url = 'https://api.modulards.com/api/public/v1/preset-broken-links/preset_broken_link';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 - Broken Links configuration
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.modulards.com/api/public/v1/preset-broken-links/preset_broken_link"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	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 configuration
require 'uri'
require 'net/http'

url = URI("https://api.modulards.com/api/public/v1/preset-broken-links/preset_broken_link")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 200 - Broken Links configuration
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.modulards.com/api/public/v1/preset-broken-links/preset_broken_link")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 - Broken Links configuration
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.modulards.com/api/public/v1/preset-broken-links/preset_broken_link', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp 200 - Broken Links configuration
using RestSharp;

var client = new RestClient("https://api.modulards.com/api/public/v1/preset-broken-links/preset_broken_link");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 - Broken Links configuration
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/preset-broken-links/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()
```