checks

Get a single check

Changed on

Return a detailed response for a single check.

get/v1/deployments/{deploymentId}/checks/{checkId}

Request

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

Path parameters

deploymentIdstring required

The deployment to get the check for.

Example:dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6
checkIdstring required

The check to fetch

Example:check_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.

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

Changes