PATCH
/
v1
/
deployments
/
{deploymentId}
/
checks
/
{checkId}
import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.checks.updateCheck({
    deploymentId: "dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6",
    checkId: "check_2qn7PZrx89yxY34vEZPD31Y9XVj6",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "Performance Check",
      path: "/",
      detailsUrl: "https://example.com/check/run/1234abc",
      output: {
        metrics: {
          fcp: {
            value: 1200,
            previousValue: 900,
            source: "web-vitals",
          },
          lcp: {
            value: 1200,
            previousValue: 1000,
            source: "web-vitals",
          },
          cls: {
            value: 4,
            previousValue: 2,
            source: "web-vitals",
          },
          tbt: {
            value: 3000,
            previousValue: 3500,
            source: "web-vitals",
          },
          virtualExperienceScore: {
            value: 30,
            previousValue: 35,
            source: "web-vitals",
          },
        },
      },
      externalId: "1234abc",
    },
  });

  // Handle the result
  console.log(result);
}

run();
{
  "id": "<string>",
  "name": "<string>",
  "path": "<string>",
  "status": "registered",
  "conclusion": "canceled",
  "blocking": true,
  "output": {
    "metrics": {
      "FCP": {
        "value": 123,
        "previousValue": 123,
        "source": "web-vitals"
      },
      "LCP": {
        "value": 123,
        "previousValue": 123,
        "source": "web-vitals"
      },
      "CLS": {
        "value": 123,
        "previousValue": 123,
        "source": "web-vitals"
      },
      "TBT": {
        "value": 123,
        "previousValue": 123,
        "source": "web-vitals"
      },
      "virtualExperienceScore": {
        "value": 123,
        "previousValue": 123,
        "source": "web-vitals"
      }
    }
  },
  "detailsUrl": "<string>",
  "integrationId": "<string>",
  "deploymentId": "<string>",
  "externalId": "<string>",
  "createdAt": 123,
  "updatedAt": 123,
  "startedAt": 123,
  "completedAt": 123,
  "rerequestable": true
}

Authorizations

Authorization
string
header
required

Default authentication mechanism

Path Parameters

deploymentId
string
required

The deployment to update the check for.

Example:

"dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6"

checkId
string
required

The check being updated

Example:

"check_2qn7PZrx89yxY34vEZPD31Y9XVj6"

Query Parameters

teamId
string

The Team identifier to perform the request on behalf of.

Example:

"team_1a2b3c4d5e6f7g8h9i0j1k2l"

slug
string

The Team slug to perform the request on behalf of.

Example:

"my-team-url-slug"

Body

application/json
name
string

The name of the check being created

Maximum length: 100
Example:

"Performance Check"

path
string

Path of the page that is being checked

Maximum length: 255
Example:

"/"

status
enum<string>

The current status of the check

Available options:
running,
completed
conclusion
enum<string>

The result of the check being run

Available options:
canceled,
failed,
neutral,
succeeded,
skipped
detailsUrl
string

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

Example:

"https://example.com/check/run/1234abc"

output
object

The results of the check Run

externalId
string

An identifier that can be used as an external reference

Example:

"1234abc"

Response

200
application/json
id
string
required
name
string
required
status
enum<string>
required
Available options:
registered,
running,
completed
blocking
boolean
required
integrationId
string
required
deploymentId
string
required
createdAt
number
required
updatedAt
number
required
path
string
conclusion
enum<string>
Available options:
canceled,
failed,
neutral,
succeeded,
skipped,
stale
output
object
detailsUrl
string
externalId
string
startedAt
number
completedAt
number
rerequestable
boolean