Get a check run | Edgenivo SDK

APIs & SDKs

Get a check run

GET/__remote/api.vercel.com/v2/deployments/{deploymentId}/check-runs/{checkRunId}

Return a detailed response for a single check run.

Request

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

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

async function run() {
  const result = await vercel.checksV2.getDeploymentCheckRun({
    deploymentId: "<id>",
    checkRunId: "ckr_89ha9sdhh9a9",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

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

checkRunIdstringRequired

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

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 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.getDeploymentCheckRun({
    deploymentId: "<id>",
    checkRunId: "ckr_89ha9sdhh9a9",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

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