checks

Creates a new Check

Changed on

Creates a new check. This endpoint must be called with an OAuth2 or it will produce a 400 error.

post/v1/deployments/{deploymentId}/checks

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v1/deployments/{deploymentId}/checks
  • Auth: HTTP bearer

Path parameters

deploymentIdstring required

The deployment to create the check for.

Example:dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6

Query parameters

teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Request body

namestring required

The name of the check being created

pathstring

Path of the page that is being checked

blockingboolean required

Whether the check should block a deployment from succeeding

detailsUrlstring

URL to display for further details

externalIdstring

An identifier that can be used as an external reference

rerequestableboolean

Whether a user should be able to request for the check to be rerun if it fails

Example request

{
  "name": "Performance Check",
  "path": "/",
  "blocking": true,
  "detailsUrl": "http://example.com",
  "externalId": "1234abc",
  "rerequestable": true
}

Response

blockingfalse | true required
completedAtnumber
conclusion'canceled' | 'failed' | 'neutral' | 'skipped' | 'stale' | 'succeeded'
createdAtnumber required
deploymentIdstring required
detailsUrlstring
externalIdstring
idstring required
integrationIdstring required
namestring required
pathstring
rerequestablefalse | true
startedAtnumber
status'completed' | 'registered' | 'running' required
updatedAtnumber required

Example response

{
  "conclusion": "succeeded",
  "id": "chk_1a2b3c4d5e6f7g8h9i0j",
  "name": "Performance Check",
  "path": "/api/users",
  "status": "completed"
}

Changes