Get Started on Cloud
BasicsPipelinesActions & ServicesEnvironmentsIntegrationsTargetsTestsDomainsSandboxesAgents & TunnelsYAML

YAML for Link Checker

View as Markdown

Check website for broken links using LinkChecker.

YAML parameters for Link Checker

PARAMETERS
scan_urlrequiredstring
The address of the site to be checked by the validator.
typerequiredstring

Value: LINK_CHECKER

actionrequiredstring
Unique identifier for the action within the pipeline.
ba_usernamestring
The basic auth username value.
ba_passwordstring
The basic auth password value.
max_resultsinteger
The maximum number of results to return
cookiesCookieYaml[]
Set the cookie name/value. Can be given more than once.
threadsinteger
Generate no more than the given number of threads. The default number of threads is 10. To disable threading specify a non-positive number.
depthinteger
Check recursively all links up to the given depth. A negative depth will enable infinite recursion. The default depth is infinite.
connection_timeoutinteger
Set the timeout for connection attempts in seconds. The default timeout is 60 seconds.
user_agentstring
Specify the User-Agent string to send to the HTTP server, for example Mozilla/4.0. The default is LinkChecker/X.Y where X.Y is the current version of LinkChecker.
requests_per_hostinteger
Limit the maximum number of HTTP requests per second to one host. The average number of requests per second is approximately one third of the maximum. Values less than 1 and at least 0.001 can be used. To use values greater than 10, the HTTP server must return a "LinkChecker" response header. The default is 10.
respect_robot_exclusionsboolean
When using HTTP, fetch robots.txt, and confirm whether each URL should be accessed before checking. The default is to use robots.txt files.
check_ssl_certificateboolean
If set to zero, it disables the SSL certificate checking. If set to one, it enables the SSL certificate checking with the provided CA certificate file. If a filename is specified, it will be used as the certificate file.
internal_linksstring
The regular expression to add more URLs recognized as internal links. The default is that URLs given on the command line are internal.
check_external_linksboolean
Check external links. The default is to check internal links only.
ignore_urlsstring[]
Only check the syntax of URLs matching the given regular expressions.
no_follow_urlsstring[]
Check but do not recurse into URLs matching the given regular expressions.
warning_regexstring
Only check syntax of URLs matching the given regular expressions.
html_form_auth_username_input_namestring
The name attribute of the username input element.
html_form_auth_password_input_namestring
The name attribute of the password input element.
html_form_auth_usernamestring
The HTML form username value.
html_form_auth_passwordstring
The HTML form password value.
html_form_auth_urlstring
The URL of a login page to be visited before link checking. The page is expected to contain an HTML form to collect credentials and submit them to the address in its action attribute using an HTTP POST request.
trigger_timestring enum
Specifies when the action should be executed.
Allowed enum:
ON_EVERY_EXECUTION,
ON_SUCCESS,
ON_FAILURE,
ON_BACK_TO_SUCCESS,
ON_WARNING,
ON_WAIT_FOR_APPROVE,
ON_TERMINATE
loopstring[]
The list of variables for dynamic action execution. The action runs once for each value.
run_only_on_first_failureboolean
Defines whether the action should be executed on each failure. Restricted to and required if the trigger_time is ON_FAILURE.
disabledboolean
When set to true the action is disabled. By default it is set to false.
timeoutinteger
The timeout in seconds.
ignore_errorsboolean
If set to true the execution will proceed, mark action as a warning and jump to the next action. Doesn't apply to deployment actions.
retry_intervalinteger
Delay time between auto retries in seconds.
retry_countinteger
Number of retries if the action fails.
run_nextstring enum
Defines whether the action should run in parallel with the next one.
Allowed enum:
WAIT_ON_SUCCESS,
IN_SOFT_PARALLEL,
IN_HARD_PARALLEL
trigger_conditionsTriggerConditionYaml[]
The list of trigger conditions to meet so that the action can be triggered.
variablesVariableYaml[]
The list of variables you can use in the action.

Last modified on Apr 27, 2026

Previous pageLighthouseNext pageLinux

YAML examples for Link Checker

Check broken links with options

yaml
  - action: "Check broken links"
    type: "LINK_CHECKER"
    trigger_time: "ON_EVERY_EXECUTION"
    scan_url: "https://example.com"
    max_results: 100
    threads: 5
    depth: 3
    connection_timeout: 30
    check_external_links: true
    check_ssl_certificate: true
    respect_robot_exclusions: true