checks

Update a check

Changed on

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

patch/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 update the check for.

Example:dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6
checkIdstring required

The check being updated

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.

Request body

namestring

The name of the check being created

pathstring

Path of the page that is being checked

status'running' | 'completed'

The current status of the check

conclusion'canceled' | 'failed' | 'neutral' | 'succeeded' | 'skipped'

The result of the check being run

detailsUrlstring

A URL a user may visit to see more information about the check

externalIdstring

An identifier that can be used as an external reference

Example request

{
  "name": "Performance Check",
  "path": "/",
  "detailsUrl": "https://example.com/check/run/1234abc",
  "output": {
    "metrics": {
      "FCP": {
        "value": 1200,
        "previousValue": 900
      },
      "LCP": {
        "value": 1200,
        "previousValue": 1000
      },
      "CLS": {
        "value": 4,
        "previousValue": 2
      },
      "TBT": {
        "value": 3000,
        "previousValue": 3500
      },
      "virtualExperienceScore": {
        "value": 30,
        "previousValue": 35
      }
    }
  },
  "externalId": "1234abc"
}

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