deployments

Get deployment events

Changed on

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.

get/v3/deployments/{idOrUrl}/events

Request

  • Base URL: https://api.vercel.com
  • URL: https://api.vercel.com/v3/deployments/{idOrUrl}/events
  • Auth: HTTP bearer

Path parameters

idOrUrlstring required

The unique identifier or hostname of the deployment.

Example:dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd

Query parameters

direction'backward' | 'forward'

Order of the returned events based on the timestamp.

Example:backward
follow0 | 1

When enabled, this endpoint will return live events as they happen.

Example:1
limitnumber

Maximum number of events to return. Provide -1 to return all available logs.

Example:100
namestring

Deployment build ID.

Example:bld_cotnkcr76
sincenumber

Timestamp for when build logs should be pulled from.

Example:1540095775941
untilnumber

Timestamp for when the build logs should be pulled up until.

Example:1540106318643
number
OR
string
delimiter0 | 1
Example:1
builds0 | 1
Example:1
teamIdstring
Example:team_1a2b3c4d5e6f7g8h9i0j1k2l

The Team identifier to perform the request on behalf of.

slugstring
Example:my-team-url-slug

The Team slug to perform the request on behalf of.

Response

Changes

  • 099fbe1f521cRevision changes
    • info

      added the non-success response with the status

  • 284e10c18f4dRevision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 to the response body oneOf list for the response status (media type: application/stream+json)

    • breaking

      added subschema #1 subschema #2 subschema #3 to the response property oneOf list for the response status (media type: application/json)

    • info

      removed subschema #1 subschema #2 subschema #3 from the response body oneOf list for the response status (media type: application/stream+json)

    • info

      removed subschema #1 subschema #2 subschema #3 from the response property oneOf list for the response status (media type: application/json)