Skip to content
Docs

Get a check

GEThttps://api.vercel.com/v2/projects/{projectIdOrName}/checks/{checkId}
Return a detailed response for a single check.
Request
import { Vercel } from "@vercel/sdk";


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


async function run() {
  const result = await vercel.checksV2.getProjectCheck({
    projectIdOrName: "<value>",
    checkId: "stf_89ha9sdhh9a9",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


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

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

projectIdOrNamestringRequired
checkIdstringRequired
The ID of the resource that will be updated.

Query parameters

teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success
idstringRequired
namestringRequired
ownerIdstringRequired
projectIdstringRequired
isRerequestablebooleanRequired
requiresstringRequired
sourceobjectRequired3 variants
blocksstringRequired
targetsarrayRequired
sourceKindstringRequired
sourceIntegrationConfigurationIdstringOptional
timeoutnumberRequired
createdAtnumberRequired
updatedAtnumberRequired
deletedAtnumberOptional

Errors

400One of the provided values in the request query is invalid.
401The request is not authorized.
403You do not have permission to access this resource.
410Error
500Error