Check link (detailed) | Doc Detective

Check if an HTTP or HTTPS URL returns an acceptable status code from a GET request.

Referenced In

Field	Type	Description	Default
url	string	Required. URL to check. Can be a full URL or a path. If a path is provided, `origin` must be specified. Pattern: `(^(http://	https://
origin	string	Optional. Protocol and domain to navigate to. Prepended to `url`.	—
params	object	Optional. Query parameters to append to the resolved URL. Merged on top of `originParams` from config; step keys win on collision. If `url` already contains a colliding query key, the value here replaces it. Values support environment variable substitution via `$VAR` syntax. WARNING: values are embedded in the request URL and appear in test results, logs, and reports.	`{}`
statusCodes	one of: - integer - array of integer	Optional. Accepted status codes. If the specified URL returns a code other than what is specified here, the action fails.	`[200,301,302,307,308]`
headers	one of: - object(Request headers (object)) - string	Optional. Additional HTTP headers to include in the request. Merged on top of Doc Detective’s default browser-mimicking headers. Useful for sites behind bot protection or WAFs that allowlist specific headers (for example, a Cloudflare Access service token or a `Cookie` with a `cf_clearance` value).	`{}`

{
  "url": "example",
  "origin": "example",
  "params": {},
  "statusCodes": [
    200,
    301,
    302,
    307,
    308
  ],
  "headers": {}
}