Get log lines for a specific task run attempt

APIs & SDKs

GET

https://api.vercel.com/v1/vercel-ci/invocations/{invocationId}/attempts/{attempt}/job-definitions/{jobDefinitionId}/runs/{runAttempt}/task-definitions/{taskDefinitionId}/runs/{taskRunAttempt}/logs

Get Task Run Logs With follow=1 the response is a newline-delimited JSON stream of log lines that ends once the task run has finished and its logs are flushed, or when the stream reaches its maximum duration.

Request

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

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

async function run() {
  const result = await vercel.vercelCi.getVercelCiTaskRunLogs({
    invocationId: "<id>",
    attempt: "<value>",
    jobDefinitionId: "<id>",
    runAttempt: "<value>",
    taskDefinitionId: "<id>",
    taskRunAttempt: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

{
  "lines": [
    {
      "level": "string",
      "timestamp": "123",
      "message": "string"
    }
  ]
}

Errors

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

invocationIdstringRequired

attemptstringRequired

jobDefinitionIdstringRequired

runAttemptstringRequired

taskDefinitionIdstringRequired

taskRunAttemptstringRequired

Query parameters

follownumberOptional

When 1, stream log lines as newline-delimited JSON until the task run finishes.

sincenumberOptional

levelarrayOptional

Only return log lines with one of these levels.

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200Successfully fetched task run log lines.

linesarrayRequired

Errors

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

401The request is not authorized.

errorobjectRequired

403You do not have permission to access this resource.

errorobjectRequired

404Error

410Error

429Error

errorobjectRequired

500Error

errorobjectRequired

Request

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

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

async function run() {
  const result = await vercel.vercelCi.getVercelCiTaskRunLogs({
    invocationId: "<id>",
    attempt: "<value>",
    jobDefinitionId: "<id>",
    runAttempt: "<value>",
    taskDefinitionId: "<id>",
    taskRunAttempt: "<value>",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

{
  "lines": [
    {
      "level": "string",
      "timestamp": "123",
      "message": "string"
    }
  ]
}

Errors

{
  "error": {
    "code": "string",
    "message": "string"
  }
}

OpenAPI Specification