Sign in

v13

OpenAPI 3.0.32026-07-31359869.4 MB
deployments

Get deployment 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.

get/v3/deployments/{idOrUrl}/events

Path parameters

idOrUrlstring required

The unique identifier or hostname of the deployment.

Example:dpl_5WJWYSyB7BpgTj3EuwF37WMRBXBtPQ2iTMJHJBJyRfd

The unique identifier or hostname of the deployment.

Query parameters

direction'backward' | 'forward'

Order of the returned events based on the timestamp.

Example:backward

Order of the returned events based on the timestamp.

follow0 | 1

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

Example:1

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

limitnumber

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

Example:100

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

namestring

Deployment build ID.

Example:bld_cotnkcr76

Deployment build ID.

sincenumber

Timestamp for when build logs should be pulled from.

Example:1540095775941

Timestamp for when build logs should be pulled from.

untilnumber

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

Example:1540106318643

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

number
OR
string

HTTP status code range to filter events by.

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