Link Checker with YAML

Name Type Description
action Required String The name of the action.
type Required String The type of the action. Should be set to LINK_CHECKER.
scan_url Required String The address of the site to be checked by the validator.
ba_username String The basic auth username value.
ba_password String The basic auth password value.
htmlformauth_username String The HTML form username value.
htmlformauth_password String The HTML form password value.
htmlformauthusernameinput_name String The name attribute of the username input element.
htmlformauthpasswordinput_name String The name attribute of the password input element.
htmlformauth_url String 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. 
depth Integer Check recursively all links up to the given depth. A negative depth will enable infinite recursion. The default depth is infinite.
cookies Cookie[] Set the cookie name/value. Can be given more than once.
connection_timeout Int Set the timeout for connection attempts in seconds. The default timeout is 60 seconds.
respectrobotexclusions Boolean When using HTTP, fetch robots.txt, and confirm whether each URL should be accessed before checking. The default is to use robots.txt files.
checksslcertificate Boolean 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_links String The regular expression to add more URLs recognized as internal links. The default is that URLs given on the command line are internal.
checkexternallinks Boolean Check external links. The default is to check internal links only. 
ignore_urls String[] Only check the syntax of URLs matching the given regular expressions. 
nofollowurls String[] Check but do not recurse into URLs matching the given regular expressions.
warning_regex String Only check syntax of URLs matching the given regular expressions.
user_agent String 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.
threads Int Generate no more than the given number of threads. The default number of threads is 10. To disable threading specify a non-positive number.
requestsperhost Int 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.
yaml
actions: - action: "Link checker" type: "LINK_CHECKER" ba_username: "basicAuthUsername" ba_password: "secure!ucaApNnkABxsQuyAQJ4sXQ==.QPJaybamhxXg2j9ICwoSKw==" html_form_auth_username: "htmlFormAuthUsername" html_form_auth_password: "secure!hC6TxvHj6rb8gliFZ0Tu1w==.D0X13mMAvxaGigoon78FQw==" html_form_auth_username_input_name: "htmlFormAuthUsernameInput" html_form_auth_password_input_name: "htmlFormAuthPasswordInput" html_form_auth_url: "https://linktocheck.com" user_agent: "Mozilla/5.0" depth: 1 scan_url: "https://linktocheck.com" cookies: - name: "header" value: "value" threads: 5 connection_timeout: 11 requests_per_host: 5 respect_robot_exclusions: false check_ssl_certificate: true internal_links: "Scan_url/*" check_external_links: true ignore_urls: - "https://example.com/.*" no_follow_urls: - "https://example.com/.*" warning_regex: "(This page has moved|Oracle Application error)"

Last modified on Mar 4, 2025