Set Published

Request to set publish status of the stream.

Request

Property	Value
Method	`PATCH`
URL	`https://api.stormstreaming.com/api/request/stream/{stream_key}/set-published`
Authentication	`x-api-key`

URL Parameters:

Parameter	Description
`{stream_key}`	The stream key of the stream you wish to modify

Request

bash

curl -X PATCH "https://api.stormstreaming.com/api/request/stream/{stream_key}/set-published" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "isPublished": 1
  }'

Request Body

Field	Default	Required	Validation	Description
`isPublished`	1	No	Int 0/1	Decides if stream is published. The maximum number of simultaneously published streams is defined by your subscription plan. 0 = not published, 1 = published

Request Body

json

{
  "isPublished": 1
}

Response

Parameter	Type	Description
`message`	string	Response status message

Successful Response (200)

json

{
  "message": "Stream has been updated."
}

Support Needed?

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