Get deployment events | Vercel REST API

APIs & SDKs

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.

https://api.vercel.com/v3/deployments/{idOrUrl}/events

const response = await fetch('https://api.vercel.com/v3/deployments/idOrUrl/events?direction=string&follow=123&limit=123&name=string&since=123&until=123&statusCode=value&delimiter=123&builds=123&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

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

Cross-link map: Get deployment events (/docs/rest-api/deployments/get-deployment-events)

From the Vercel docs graph (built 2026-10-08T05:38:39.548Z), spanning vercel.com docs + KB, nextjs.org, ai-sdk.dev, and other Vercel documentation sites. Full graph as JSON: https://vercel.com/docs/graph.json

Semantically closest pages

List deployments — GET /v7/deployments — List deployments under the authenticated user or team. If a deployment hasn't finished uploading \
Get logs for a deployment — GET /v1/projects/{projectId}/deployments/{deploymentId}/runtime-logs — Returns a stream of logs for a given deployment.
List Deployment Files — GET /v6/deployments/{id}/files — Allows to retrieve the file structure of the source code of a deployment by supplying t
List check runs for a deployment — GET /v2/deployments/{deploymentId}/check-runs — List all check runs for a deployment.
Get microfrontends config for a deployment — GET /v1/microfrontends/{deploymentId}/config — Get the microfrontends config for a deployment.

This page links to (1)

Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

Pages that link here (2)

By site: vercel-docs (2)

Managing Deployments — Learn how to manage your current and previously deployed projects to Vercel through the dashboard. You can redeploy at a
Vercel REST API Reference — Interact programmatically with your Vercel account using the SDK or direct HTTP requests.

https://api.vercel.com/v3/deployments/{idOrUrl}/events

const response = await fetch('https://api.vercel.com/v3/deployments/idOrUrl/events?direction=string&follow=123&limit=123&name=string&since=123&until=123&statusCode=value&delimiter=123&builds=123&teamId=string&slug=string', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    'Content-Type': 'application/json',
  },
});

const data = await response.json();
console.log(data);

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"
  }
]

OpenAPI Specification