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.

Servers

Path parameters

Name Type Required Description
idOrUrl String Yes

The unique identifier or hostname of the deployment.

Query parameters

Name Type Required Description
teamId String No

The Team identifier to perform the request on behalf of.

limit Number No

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

name String No

Deployment build ID.

direction String No

Order of the returned events based on the timestamp.

Possible values:

  • "backward"
  • "forward"

Default value: "forward"

statusCode No

HTTP status code range to filter events by.

slug String No

The Team slug to perform the request on behalf of.

until Number No

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

builds Number No

Possible values:

  • 0
  • 1
since Number No

Timestamp for when build logs should be pulled from.

follow Number No

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

Possible values:

  • 0
  • 1
delimiter Number No

Possible values:

  • 0
  • 1

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.