Update a check | Vercel REST API

APIs & SDKs

Update a check

PATCHhttps://api.vercel.com/v2/projects/{projectIdOrName}/checks/{checkId}

Update an existing check.

https://api.vercel.com/v2/projects/{projectIdOrName}/checks/{checkId}

const response = await fetch('https://api.vercel.com/v2/projects/projectIdOrName/checks/checkId?teamId=string&slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Example Name",
    "isRerequestable": "true",
    "requires": "build-ready",
    "targets": [],
    "blocks": "build-start",
    "timeout": "123"
  }),
});

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

Response

{
  "blocks": "build-start",
  "createdAt": "123",
  "deletedAt": "123",
  "id": "icfg_1234567890",
  "isRerequestable": "false",
  "name": "Example Name",
  "ownerId": "example_id",
  "projectId": "example_id",
  "requires": "build-ready",
  "source": {
    "externalResourceId": "example_id",
    "integrationConfigurationId": "example_id",
    "integrationId": "example_id",
    "kind": "integration",
    "resourceId": "example_id"
  },
  "sourceIntegrationConfigurationId": "example_id",
  "sourceKind": "git-provider",
  "targets": [],
  "timeout": "123",
  "updatedAt": "123"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

projectIdOrNamestringRequired

checkIdstringRequired

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

namestringOptional

isRerequestablebooleanOptional

requiresstringOptional

targetsarrayOptional

blocksstringOptional

timeoutnumberOptional

Response

200Success

blocksstringRequired

createdAtnumberRequired

deletedAtnumberOptional

idstringRequired

isRerequestablebooleanRequired

namestringRequired

ownerIdstringRequired

projectIdstringRequired

requiresstringRequired

sourceobjectRequired3 variants

sourceIntegrationConfigurationIdstringOptional

sourceKindstringRequired

targetsarrayRequired

timeoutnumberRequired

updatedAtnumberRequired

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: Update a check (/docs/rest-api/checks-v2/update-a-check)

From the Vercel docs graph (built 2026-10-10T05:32:43.016Z), 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

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

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/projects/{projectIdOrName}/checks/{checkId}

const response = await fetch('https://api.vercel.com/v2/projects/projectIdOrName/checks/checkId?teamId=string&slug=string', {
  method: 'PATCH',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "name": "Example Name",
    "isRerequestable": "true",
    "requires": "build-ready",
    "targets": [],
    "blocks": "build-start",
    "timeout": "123"
  }),
});

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

Response

{
  "blocks": "build-start",
  "createdAt": "123",
  "deletedAt": "123",
  "id": "icfg_1234567890",
  "isRerequestable": "false",
  "name": "Example Name",
  "ownerId": "example_id",
  "projectId": "example_id",
  "requires": "build-ready",
  "source": {
    "externalResourceId": "example_id",
    "integrationConfigurationId": "example_id",
    "integrationId": "example_id",
    "kind": "integration",
    "resourceId": "example_id"
  },
  "sourceIntegrationConfigurationId": "example_id",
  "sourceKind": "git-provider",
  "targets": [],
  "timeout": "123",
  "updatedAt": "123"
}

OpenAPI Specification