checks-v2

Create a check

Changed on

Creates a new check for a project.

post/v2/projects/{projectIdOrName}/checks

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v2/projects/{projectIdOrName}/checks
  • Auth: HTTP bearer

Path parameters

projectIdOrNamestring required

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
isRerequestableboolean
requires'build-ready' | 'deployment-url' | 'none' required
targetsstring[]
blocks'build-start' | 'deployment-start' | 'deployment-alias' | 'deployment-promotion' | 'none'
timeoutnumber

Response

blocks'build-start' | 'deployment-alias' | 'deployment-promotion' | 'deployment-start' | 'none' required
createdAtnumber required
deletedAtnumber
idstring required
isRerequestablefalse | true required
namestring required
ownerIdstring required
projectIdstring required
requires'build-ready' | 'deployment-url' | 'none' required
sourceIntegrationConfigurationIdstring
sourceKind'git-provider' | 'integration' | 'vercel' | 'webhook' | 'integration' | 'webhook' | 'git-provider' required
targetsstring[] required
timeoutnumber required
updatedAtnumber required

Changes

  • d8abdc297e36Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

  • 099fbe1f521cRevision changes
    • info

      added the non-success response with the status