deployments.createStream

POST

/deployments/stream

const url = 'https://example.com/api/deployments/stream';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"projectId":"example","serverId":"example","destinationId":"example","environmentId":"example","resourceId":"example"}'
};

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

curl --request POST \
  --url https://example.com/api/deployments/stream \
  --header 'Content-Type: application/json' \
  --data '{ "projectId": "example", "serverId": "example", "destinationId": "example", "environmentId": "example", "resourceId": "example" }'

Request Body^required

application/json

object

projectId

required

string

>= 1 characters

serverId

required

string

>= 1 characters

destinationId

string

>= 1 characters

environmentId

required

string

>= 1 characters

resourceId

required

string

>= 1 characters

Example ^generated

{
  "projectId": "example",
  "serverId": "example",
  "destinationId": "example",
  "environmentId": "example",
  "resourceId": "example"
}

Responses

200

text/event-stream

One of:

object

event

required

Allowed value: message

data

required

object

timestamp

required

string

source

required

string

Allowed values: appaloft application

phase

required

string

Allowed values: detect plan package deploy verify rollback

level

required

string

Allowed values: debug info warn error

message

required

string

deploymentId

string

status

string

Allowed values: running succeeded failed

step

required

object

current

required

number

total

required

number

label

required

string

stream

string

Allowed values: stdout stderr

string

retry

number

deployments.createStream

Request Body required

Example generated

Responses

200

Request Body^required

Example ^generated