Skip to content
Docs

Get deployment events

GEThttps://api.vercel.com/v3/deployments/{idOrUrl}/events
Get the build logs of a deployment by deployment ID and build ID. It can work as an infinite stream of logs or as a JSON endpoint depending on the input parameters.
Request
import { Vercel } from "@vercel/sdk";


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


async function run() {
  const result = await vercel.deployments.getDeploymentEvents({
    idOrUrl: "dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd",
    direction: "backward",
    follow: 1,
    limit: 100,
    name: "bld_cotnkcr76",
    since: 1540095775941,
    until: 1540106318643,
    statusCode: "5xx",
    delimiter: 1,
    builds: 1,
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });


  console.log(result);
}


run();
Response
[
  {
    "created": "123",
    "payload": {
      "created": "123",
      "date": "123",
      "deploymentId": "example_id",
      "id": "icfg_1234567890",
      "info": {
        "entrypoint": "string",
        "name": "Example Name",
        "path": "string",
        "readyState": "string",
        "serviceName": "Example Name",
        "step": "string",
        "type": "string"
      },
      "proxy": {
        "cacheId": "example_id",
        "clientIp": "string",
        "host": "string",
        "lambdaRegion": "string",
        "method": "string",
        "path": "string",
        "pathType": "string",
        "pathTypeVariant": "string",
        "referer": "string",
        "region": "string",
        "responseByteSize": "123",
        "scheme": "string",
        "statusCode": "123",
        "timestamp": "123",
        "userAgent": [],
        "vercelCache": "BYPASS",
        "vercelId": "example_id",
        "wafAction": "bypass",
        "wafRuleId": "example_id"
      },
      "requestId": "example_id",
      "serial": "string",
      "statusCode": "123",
      "text": "string"
    },
    "type": "command"
  }
]

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

idOrUrlstringRequired
The unique identifier or hostname of the deployment.

Query parameters

directionstringOptional
Order of the returned events based on the timestamp.
follownumberOptional
When enabled, this endpoint will return live events as they happen.
limitnumberOptional
Maximum number of events to return. Provide -1 to return all available logs.
namestringOptional
Deployment build ID.
sincenumberOptional
Timestamp for when build logs should be pulled from.
untilnumberOptional
Timestamp for when the build logs should be pulled up until.
statusCodeanyOptional
HTTP status code range to filter events by.
delimiternumberOptional
buildsnumberOptional
teamIdstringOptional
The Team identifier to perform the request on behalf of.
slugstringOptional
The Team slug to perform the request on behalf of.

Response

200Success

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