Link Checker

  • POST
  • /workspaces
  • /:domain
  • /projects
  • /:project_name
  • /pipelines
  • /:pipeline_id
  • /actions

Request

URL PARAMETERS
domainrequired string
The workspace domain.
pipeline_idrequired integer
The numerical ID of the desired pipeline.
project_namerequired string
The name ID of the project.
POST PARAMETERS
namerequired string
The name of the action.
typerequired string
The type of the action. Should be set to LINK_CHECKER.
scan_urlrequired string
The address of the site to be checked by the validator.
ba_usernameoptional string
The basic auth username value.
ba_passwordoptional string
The basic auth password value.
html_form_auth_usernameoptional string
The HTML form username value.
html_form_auth_passwordoptional string
The HTML form password value.
html_form_auth_username_input_nameoptional string
The name attribute of the username input element.
html_form_auth_password_input_nameoptional string
The name attribute of the password input element.
html_form_auth_urloptional 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.
depthoptional integer
Check recursively all links up to the given depth. A negative depth will enable infinite recursion. The default depth is infinite.
cookiesoptional Cookie[]
Set the cookie name/value. Can be given more than once.
connection_timeoutoptional integer
Set the timeout for connection attempts in seconds. The default timeout is 60 seconds.
respect_robot_exclusionsoptional 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.
check_ssl_certificateoptional 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_linksoptional string
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_linksoptional boolean
Check external links. The default is to check internal links only.
ignore_urlsoptional string[]
Only check the syntax of URLs matching the given regular expressions.
no_follow_urlsoptional string[]
Check but do not recurse into URLs matching the given regular expressions.
warning_regexoptional string
Only check syntax of URLs matching the given regular expressions.
user_agentoptional 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.
threadsoptional integer
Generate no more than the given number of threads. The default number of threads is 10. To disable threading specify a non-positive number.
requests_per_hostoptional integer
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.

Last modified on Sep 27, 2024

Example:

curl -X POST "https://api.buddy.works/workspaces/:domain/projects/:project_name/pipelines/:pipeline_id/actions" \
  -H "Authorization: Bearer <YOUR-TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Link checker",
  "type": "LINK_CHECKER",
  "trigger_time": "ON_EVERY_EXECUTION",
  "ba_username": "basicAuthUsername",
  "ba_password": "secure!ucaApNnkABxsQuyAQJ4sXQ==.QPJaybamhxXg2j9ICwoSKw==",
  "html_form_auth_username": "htmlFormAuthUsername",
  "html_form_auth_password": "secure!ucaApNnkABxsQuyAQJ4sXQ==.QPJaybamhxXg2j9ICwoSKw==",
  "html_form_auth_username_input_name": "htmlFormAuthUsernameInput",
  "html_form_auth_password_input_name": "htmlFormAuthPasswordInput",
  "html_form_auth_url": "https://linktocheck.com",
  "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)"
}'
EXAMPLE RESPONSE
{ "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2/actions/2", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2/action/2/edit", "id": 2, "name": "Link checker", "type": "LINK_CHECKER", "trigger_time": "ON_EVERY_EXECUTION", "ba_username": "basicAuthUsername", "ba_password": "secure!ucaApNnkABxsQuyAQJ4sXQ==.QPJaybamhxXg2j9ICwoSKw==", "html_form_auth_username": "htmlFormAuthUsername", "html_form_auth_password": "secure!ucaApNnkABxsQuyAQJ4sXQ==.QPJaybamhxXg2j9ICwoSKw==", "html_form_auth_username_input_name": "htmlFormAuthUsernameInput", "html_form_auth_password_input_name": "htmlFormAuthPasswordInput", "html_form_auth_url": "https://linktocheck.com", "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)", "pipeline": { "url": "https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/2", "html_url": "https://app.buddy.works/buddy/company-website/pipelines/pipeline/2", "id": 2, "name": "test server", "on": "CLICK", "refs": [ "refs/heads/master" ], "last_execution_status": "SUCCESSFUL", "last_execution_revision": "506a3963507943d6908154f4bc9646e829128a08" } }
STATUS
201 Created
LIMITS
X-Rate-Limit-Limit: 1 X-Rate-Limit-Remaining: 999