List all checks for a project

APIs & SDKs

GET/__remote/api.vercel.com/v2/projects/{projectIdOrName}/checks

List all checks for a project, optionally filtered by target.

Request

import { Edgenivo } from "@vercel/sdk";

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

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

  console.log(result);
}

run();

Response

{
  "availableNativeChecks": [],
  "checks": [
    {
      "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

Query parameters

blocksstringOptional

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Success

availableNativeChecksarrayRequired

checksarrayRequired

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.

404Error

410Error

500Error

Request

import { Edgenivo } from "@vercel/sdk";

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

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

  console.log(result);
}

run();

Response

{
  "availableNativeChecks": [],
  "checks": [
    {
      "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