Cluster Source Command

Executes a command on a specific stream source.

Request

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

Request

bash

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

Path Parameters

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

Request

bash

curl -X POST "{BASE_URL}/api/cluster/streams/{streamKey}/sources/{sourceId}/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 (see available commands below)

Available Commands

Command	Description
`delete`	Removes the source from the stream
`moveToTop`	Moves the source to the highest priority position
`moveUp`	Moves the source one position up in the priority list
`moveDown`	Moves the source one position down in the priority list

Example Request Body

json

{
  "data": {
    "attributes": {
      "command": "delete"
    }
  }
}

Response Body

Parameter	Type	Description
`message`	string	Response status message

Metadata

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

Successful Response (200)

json

{
  "meta": {
    "executionTime": 12,
    "generatedAt": 1770287210383
  },
  "message": "Source has been deleted"
}

Error Responses

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

Source Not Found (404)

json

{
  "message": "Source not found"
}

Other Errors (4xx/5xx)

json

{
  "message": "Error message"
}

Support Needed?

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