---
title: "Get deployment events"
method: GET
path: "/v3/deployments/{idOrUrl}/events"
tags: ["deployments"]
---

# Get deployment events

`GET /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.

## Path parameters

- `idOrUrl` string, required — The unique identifier or hostname of the deployment.

## Query parameters

- `direction` 'backward' | 'forward' — Order of the returned events based on the timestamp.
- `follow` 0 | 1 — When enabled, this endpoint will return live events as they happen.
- `limit` number — Maximum number of events to return. Provide `-1` to return all available logs.
- `name` string — Deployment build ID.
- `since` number — Timestamp for when build logs should be pulled from.
- `until` number — Timestamp for when the build logs should be pulled up until.
- `statusCode` union — HTTP status code range to filter events by.
  - number
  - string
- `delimiter` 0 | 1
- `builds` 0 | 1
- `teamId` string
- `slug` string

## Response `200`

- union[], nullable
  - union
    - object
      - `type` 'command' | 'delimiter' | 'deployment-state' | 'edge-function-invocation' | 'exit' | 'fatal' | 'metric' | 'middleware' | 'middleware-invocation' | 'report' | 'stderr' | 'stdout', required
      - `created` number, required
      - `payload` object, required
        - `deploymentId` string, required
        - `info` object
          - `type` string, required
          - `name` string, required
          - `entrypoint` string
          - `path` string
          - `step` string
          - `readyState` string
        - `text` string
        - `id` string, required
        - `date` number, required
        - `serial` string, required
        - `created` number
        - `statusCode` number
        - `requestId` string
        - `proxy` object
          - `timestamp` number, required
          - `method` string, required
          - `host` string, required
          - `path` string
          - `statusCode` number
          - `userAgent` string[]
          - `referer` string
          - `clientIp` string
          - `region` string
          - `scheme` string
          - `responseByteSize` number
          - `cacheId` string
          - `pathType` string
          - `pathTypeVariant` string
          - `vercelId` string
          - `vercelCache` 'BYPASS' | 'HIT' | 'MISS' | 'PRERENDER' | 'REVALIDATED' | 'STALE'
          - `lambdaRegion` string
          - `wafAction` 'bypass' | 'challenge' | 'deny' | 'log' | 'rate_limit'
          - `wafRuleId` string
    - object
      - `created` number, required
      - `date` number, required
      - `deploymentId` string, required
      - `id` string, required
      - `info` object, required
        - `type` string, required
        - `name` string, required
        - `entrypoint` string
        - `path` string
        - `step` string
        - `readyState` string
      - `serial` string, required
      - `text` string
      - `type` 'command' | 'delimiter' | 'deployment-state' | 'edge-function-invocation' | 'exit' | 'fatal' | 'metric' | 'middleware' | 'middleware-invocation' | 'report' | 'stderr' | 'stdout', required
      - `level` 'error' | 'warning'
    - object
      - `type` 'command' | 'delimiter' | 'deployment-state' | 'edge-function-invocation' | 'exit' | 'fatal' | 'metric' | 'middleware' | 'middleware-invocation' | 'report' | 'stderr' | 'stdout', required
      - `created` number, required
      - `payload` object, required
        - `deploymentId` string, required
        - `info` object
          - `type` string, required
          - `name` string, required
          - `entrypoint` string
          - `path` string
          - `step` string
          - `readyState` string
        - `text` string
        - `id` string, required
        - `date` number, required
        - `serial` string, required
        - `created` number
        - `statusCode` number
        - `requestId` string
        - `proxy` object
          - `timestamp` number, required
          - `method` string, required
          - `host` string, required
          - `path` string
          - `statusCode` number
          - `userAgent` string[]
          - `referer` string
          - `clientIp` string
          - `region` string
          - `scheme` string
          - `responseByteSize` number
          - `cacheId` string
          - `pathType` string
          - `pathTypeVariant` string
          - `vercelId` string
          - `vercelCache` 'BYPASS' | 'HIT' | 'MISS' | 'PRERENDER' | 'REVALIDATED' | 'STALE'
          - `lambdaRegion` string
          - `wafAction` 'bypass' | 'challenge' | 'deny' | 'log' | 'rate_limit'
          - `wafRuleId` string
    - object
      - `created` number, required
      - `date` number, required
      - `deploymentId` string, required
      - `id` string, required
      - `info` object, required
        - `type` string, required
        - `name` string, required
        - `entrypoint` string
        - `path` string
        - `step` string
        - `readyState` string
      - `serial` string, required
      - `text` string
      - `type` 'command' | 'delimiter' | 'deployment-state' | 'edge-function-invocation' | 'exit' | 'fatal' | 'metric' | 'middleware' | 'middleware-invocation' | 'report' | 'stderr' | 'stdout', required
      - `level` 'error' | 'warning'
    - object
      - `type` 'alias-assigned', required
      - `deploymentId` string, required
      - `date` number, required
      - `alias` string[], required
      - `aliasError` object, nullable, required
        - `code` string, required
        - `message` string, required
      - `aliasWarning` object, nullable, required
        - `code` string, required
        - `message` string, required
        - `link` string
        - `action` string

## Other responses

- `400` — One of the provided values in the request query is invalid.
- `401` — The request is not authorized.
- `403` — You do not have permission to access this resource.
- `410`
- `500`

---

[API](https://skmtc.net/vercel/apis/api.md) · [All operations](https://skmtc.net/vercel/apis/api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/vercel/api/versions/61d1ba3f6dac/schema)