Skip to main content
POST
Check if a webpage contains broken links

Authorizations

x-api-key
string
header
required

API Key required for all endpoints

Body

application/json
url
string
required

Target URL

Example:

"https://example.com"

followRedirect
boolean
default:false

Whether to follow redirects when checking site status

Example:

false

proxyCountry
string

Proxy country code to route the request

Example:

"us"

Response

Successfully checked for broken links

timestamp
number
required

Timestamp of the request in milliseconds

Example:

1783943217189

apiStatus
enum<string>
required

API status message

Available options:
success,
failure
Example:

"success"

apiCode
number
required

API status code

Example:

200

message
string
required

Human-readable message about the broken link scan result

Example:

"No broken links found."

meta
object
required

Metadata about the broken link request

Example:
summary
object
required

Summary of link check results categorized by status

Example:
data
string[]
required

List of links found on the page and their HTTP status

Example: