deployments.eventsStream

GET

/deployments/{deploymentId}/events/stream

const url = 'https://example.com/api/deployments/example/events/stream?historyLimit=100';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/api/deployments/example/events/stream?historyLimit=100'

Parameters

Path Parameters

deploymentId

required

string

>= 1 characters

Query Parameters

cursor

string

>= 1 characters

historyLimit

integer

default: 100 <= 200

includeHistory

Any of:

boolean

follow

Any of:

boolean

untilTerminal

Any of:

boolean

Responses

200

text/event-stream

One of:

object

event

required

Allowed value: message

data

required

One of:

object

schemaVersion

required

string

Allowed value: deployments.stream-events/v1

kind

required

string

Allowed value: event

event

required

object

deploymentId

required

string

sequence

required

integer

> 0 <= 9007199254740991

cursor

required

string

emittedAt

required

string

source

required

string

Allowed values: domain-event process-observation progress-projection

eventType

required

string

Allowed values: deployment-requested build-requested deployment-started deployment-succeeded deployment-failed deployment-progress

phase

string

Allowed values: detect plan package deploy verify rollback

status

string

retriable

boolean

summary

string

retry

number