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

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

async function run() {
  const result = await vercel.checks.createCheck({
    deploymentId: "dpl_2qn7PZrx89yxY34vEZPD31Y9XVj6",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "Performance Check",
      path: "/",
      blocking: true,
      detailsUrl: "http://example.com",
      externalId: "1234abc",
      rerequestable: true,
    },
  });

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

run();
{
  "id": "chk_1a2b3c4d5e6f7g8h9i0j",
  "name": "Performance Check",
  "path": "/api/users",
  "status": "completed",
  "conclusion": "succeeded",
  "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 create the check for.

Example:

"dpl_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
required

The name of the check being created

Maximum length: 100
Example:

"Performance Check"

​
blocking
boolean
required

Whether the check should block a deployment from succeeding

Example:

true

​
path
string

Path of the page that is being checked

Maximum length: 255
Example:

"/"

​
detailsUrl
string

URL to display for further details

Example:

"http://example.com"

​
externalId
string

An identifier that can be used as an external reference

Example:

"1234abc"

​
rerequestable
boolean

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

Example:

true

Response

200
application/json
​
id
string
required
Example:

"chk_1a2b3c4d5e6f7g8h9i0j"

​
name
string
required
Example:

"Performance Check"

​
status
enum<string>
required
Available options:
registered,
running,
completed
Example:

"completed"

​
blocking
boolean
required
​
integrationId
string
required
​
deploymentId
string
required
​
createdAt
number
required
​
updatedAt
number
required
​
path
string
Example:

"/api/users"

​
conclusion
enum<string>
Available options:
canceled,
failed,
neutral,
succeeded,
skipped,
stale
Example:

"succeeded"

​
output
object
​
detailsUrl
string
​
externalId
string
​
startedAt
number
​
completedAt
number
​
rerequestable
boolean