Retrieve the build output of a deployment as a list of log entries, in the order the build printed them. A log entry is one chunk of build output, and can contain several lines or part of a line.

Poll this endpoint to follow a running build:

• Send the pagination.cursor of the last response as cursor. The response contains only the entries after it.
• When hasMore is true, request again now.
• When hasMore is false, you have all entries so far. Wait, then request again with the same cursor.
• The cursor is absent only when the request had no cursor and the build has no entries yet.
• A response can contain fewer than limit entries and still have hasMore: true when the entries are large.

New entries become visible up to a few seconds after the build prints them. To know that a build is done, check the deployment status with getDeployment. After the status is no longer building, request until you get an empty response at least 5 seconds later.

When a build attempt is retried, an entry from the earlier attempt can arrive after the cursor has moved past it, and a poll does not return it. A request without a cursor returns it. A deployment from a prebuilt image has no build and returns no entries. Build logs are kept for 3 months.

Required Permissions

Your root key must have the following permission:

• unkey:v1:<workspace_id>:projects/<project_id>/apps/<app_id>/environments/<environment_id>/deployments/<deployment_id>/buildLogs#read

{
  "deploymentId": "proj_1234abcd",
  "stepId": "sha256:3f9c2b7e1d4a6f8c0b5e9d2a7c4f1e8b3d6a9c2f5e8b1d4a7c0f3e6b9d2a5c8f",
  "cursor": "1704067201000001"
}

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "time": 1704067201000,
      "stepId": "sha256:3f9c2b7e1d4a6f8c0b5e9d2a7c4f1e8b3d6a9c2f5e8b1d4a7c0f3e6b9d2a5c8f",
      "step": "[3/7] RUN npm ci",
      "output": "stdout",
      "message": "added 412 packages in 12s\n"
    }
  ],
  "pagination": {
    "cursor": "eyJrZXkiOiJrZXlfMTIzNCIsInRzIjoxNjk5Mzc4ODAwfQ==",
    "hasMore": true
  }
}