Skip to content

Channel Stop

To stop a channel that is currently in a running state call the URI http(s)://<qie_server>:<management_api_port>/channel/stop with the following payload:

{
   "zoneName": "<desired zone>",
   "channelName": "<desired channel>",
   "formatOutput": true | false
}

Base JSON Payload Definition

Node Description
zoneName REQUIRED: The name of the zone containing the channel.
channelName REQUIRED: The name of the channel.
formatOutput True if the response JSON should be formatted as human readable (default=false).

The following response is received if the zone and channel are found, and the channel was successfully able to stop:

HTTP Status: 200

{
   "message": "<response_message>"
}
Node Description
message This message indicates whether the channel was stopped or if it was already stopped.

If there is an error finding the zone or channel or an error stopping the channel, then the following response is received:

HTTP Status: 400

{
   "error": "<error message>"
}

Example curl command:

curl -H "apiToken:abc123" --request POST http://qieserver:9999/channel/stop -d '{"zoneName":"myZoneName","channelName":"myChannelName"}'

curl -H "apiToken:abc123" --request POST http://qieserver:9999/channel/stop -d "{\"zoneName\":\"myZoneName\",\"channelName\":\"myChannelName\"}"

curl -H @{"apiToken"="abc123"} -Method POST http://qieserver:9999/channel/stop -Body '{"zoneName":"myZoneName","channelName":"myChannelName"}' | Select-Object -Expand RawContent