POST /v2/projects/{projectIdOrName}/checks

Creates a new check for a project.

Servers

Path parameters

Name Type Required Description
projectIdOrName String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
teamId String No

The Team identifier to perform the request on behalf of.

slug String No

The Team slug to perform the request on behalf of.

Request body fields

Name Type Required Description
isRerequestable Boolean No
source Object No
requires String Yes

Valid values:

  • "deployment-url"
  • "none"
  • "build-ready"

Default value: "deployment-url"

name String Yes
targets[] Array No
timeout Number No

Default value: 300

blocks String No

Valid values:

  • "deployment-alias"
  • "build-start"
  • "deployment-start"
  • "none"
  • "deployment-promotion"

Default value: "deployment-alias"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.