Link Validator

POST Parameters

NameTypeDescription
name
Required
StringThe name of the action.
type
Required
StringThe type of the action. Should be set to LINK_VALIDATOR.
website
Required
StringThe address of the site to be checked by the validator.
depth
Required
IntegerMaximum crawl depth. By default it is set to 1. If depth = 0, only the main page will be audited.
ignored_prefixesString[]The list of URLs with prefixes that will be ignored.

Example

Request

POST https://api.buddy.works/workspaces/buddy/projects/company-website/pipelines/1/actions

JSON

{
  "name": "Link validator",
  "type": "LINK_VALIDATOR",
  "website": "https://buddy.works",
  "depth": 1,
  "ignored_prefixes": [
    "https://buddy.works/assets"
  ]
}

Sample Response

HTTP

Status: 201 Created
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

JSON

{
  "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 validator",
  "type": "LINK_VALIDATOR",
  "website": "https://buddy.works",
  "depth": 1,
  "ignored_prefixes": [
    "https://buddy.works/assets"
  ],
    "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"
  }
}