Cluster Stream Propagate

Distributes a specific stream to all configured destinations.

Request

Property	Value
Method	`POST`
URL	`/api/cluster/streams/{streamKey}/command`
Content-Type	`application/json`
Authentication	Bearer Token

Request

bash

curl -X POST "{BASE_URL}/api/cluster/streams/{streamKey}/command" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"data":{"attributes":{"command":"propagate"}}}'

Path Parameters

Parameter	Type	Required	Description
`streamKey`	string	Yes	Unique identifier of the stream

Request With Parameters

bash

curl -X POST "{BASE_URL}/api/cluster/streams/{streamKey}/command" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json"

Request Body

Parameter	Type	Required	Description
`data.attributes.command`	string	Yes	Command to execute (always `"propagate"`)

Request Body

json

{
  "data": {
    "attributes": {
      "command": "propagate"
    }
  }
}

Response Body

Parameter	Type	Description
`meta.executionTime`	integer	Request processing time in milliseconds
`meta.generatedAt`	integer	Response generation timestamp (Unix timestamp in ms)
`message`	string	Response status message

Successful Response (200)

json

{
  "meta": {
    "executionTime": 15,
    "generatedAt": 1770287210383
  },
  "message": "Stream has been propagated"
}

Error Response (4xx/5xx)

Parameter	Type	Description
`message`	string	Human-readable error message

Stream Not Found (404)

json

{
  "message": "Stream not found"
}

Error Response

json

{
  "message": "Error message"
}

Support Needed?

Create a free ticket and our support team will provide you necessary assistance.