Create a check run | Vercel REST API

APIs & SDKs

Create a check run

POSThttps://api.vercel.com/v2/deployments/{deploymentId}/check-runs

Creates a new check run for a deployment.

https://api.vercel.com/v2/deployments/{deploymentId}/check-runs

const response = await fetch('https://api.vercel.com/v2/deployments/deploymentId/check-runs?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "checkId": "example_id"
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "blocks": "build-start",
  "completedAt": "123",
  "conclusion": "canceled",
  "conclusionText": "string",
  "createdAt": "123",
  "deploymentId": "example_id",
  "expectationRef": {
    "invocationAttempt": "123",
    "invocationId": "example_id",
    "jobDefinitionId": "example_id",
    "jobRunAttempt": "123"
  },
  "expectationRevision": "123",
  "externalId": "example_id",
  "externalUrl": "https://example.com",
  "id": "icfg_1234567890",
  "name": "Example Name",
  "output": "value",
  "ownerId": "example_id",
  "projectId": "example_id",
  "requires": "build-ready",
  "startedAt": "123",
  "status": "completed",
  "targets": [],
  "taskSummary": {
    "failed": "123",
    "pending": "123",
    "succeeded": "123",
    "total": "123"
  },
  "timeout": "123",
  "updatedAt": "123",
  "checkId": "example_id",
  "source": {
    "externalResourceId": "example_id",
    "integrationConfigurationId": "example_id",
    "integrationId": "example_id",
    "kind": "integration",
    "resourceId": "example_id"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

deploymentIdstringRequired

Query parameters

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

checkIdstringRequired

Response

200Success

blocksstringOptional

completedAtnumberOptional

conclusionstringOptional

conclusionTextstringOptional

createdAtnumberRequired

deploymentIdstringRequired

expectationRefobjectOptional

expectationRevisionnumberOptional

Latest aggregate revision applied to this check run.

externalIdstringOptional

externalUrlstringOptional

idstringRequired

namestringRequired

outputobjectOptional

ownerIdstringRequired

projectIdstringOptional

requiresstringOptional

startedAtnumberOptional

statusstringRequired

targetsarrayOptional

taskSummaryobjectOptional

timeoutnumberRequired

updatedAtnumberRequired

checkIdstringRequired

sourceobjectRequired5 variants

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

500Error

Cross-link map: Create a check run (/docs/rest-api/checks-v2/create-a-check-run)

From the Vercel docs graph (built 2026-10-08T05:38:39.548Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

Get a check run — GET /v2/deployments/{deploymentId}/check-runs/{checkRunId} — Return a detailed response for a single check run.
Update a check run — PATCH /v2/deployments/{deploymentId}/check-runs/{checkRunId} — Update an existing check run for a deployment.
List runs for a check — GET /v2/projects/{projectIdOrName}/checks/{checkId}/runs — List all runs associated with a given check.
Create a check — POST /v2/projects/{projectIdOrName}/checks — Creates a new check for a project.
List check runs for a deployment — GET /v2/deployments/{deploymentId}/check-runs — List all check runs for a deployment.

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (1)

By site: vercel-docs (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v2/deployments/{deploymentId}/check-runs

const response = await fetch('https://api.vercel.com/v2/deployments/deploymentId/check-runs?teamId=string&slug=string', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "checkId": "example_id"
  }),
});

const data = await response.json();
console.log(data);

Response

{
  "blocks": "build-start",
  "completedAt": "123",
  "conclusion": "canceled",
  "conclusionText": "string",
  "createdAt": "123",
  "deploymentId": "example_id",
  "expectationRef": {
    "invocationAttempt": "123",
    "invocationId": "example_id",
    "jobDefinitionId": "example_id",
    "jobRunAttempt": "123"
  },
  "expectationRevision": "123",
  "externalId": "example_id",
  "externalUrl": "https://example.com",
  "id": "icfg_1234567890",
  "name": "Example Name",
  "output": "value",
  "ownerId": "example_id",
  "projectId": "example_id",
  "requires": "build-ready",
  "startedAt": "123",
  "status": "completed",
  "targets": [],
  "taskSummary": {
    "failed": "123",
    "pending": "123",
    "succeeded": "123",
    "total": "123"
  },
  "timeout": "123",
  "updatedAt": "123",
  "checkId": "example_id",
  "source": {
    "externalResourceId": "example_id",
    "integrationConfigurationId": "example_id",
    "integrationId": "example_id",
    "kind": "integration",
    "resourceId": "example_id"
  }
}

OpenAPI Specification