POST /v1/deployments/{deploymentId}/checks
Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.
Servers
- https://api.vercel.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
deploymentId |
String | Yes |
The deployment to create the check for. |
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 |
|---|---|---|---|
name |
String | Yes |
The name of the check being created |
externalId |
String | No |
An identifier that can be used as an external reference |
blocking |
Boolean | Yes |
Whether the check should block a deployment from succeeding |
rerequestable |
Boolean | No |
Whether a user should be able to request for the check to be rerun if it fails |
detailsUrl |
String | No |
URL to display for further details |
path |
String | No |
Path of the page that is being checked |
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.