PATCH
Update multistream target
PATCH /multistream/target/{id}
updates an existing multistream target
object. You can change any user-defined field in the current object,
specifically name
, url
and disabled
.
All fields are optional, and if any field is not included in the request payload it will be kept unchanged from the saved object.
You cannot access the current url
field for updating it since we redact it
from GET responses. If you want to update the URL you have to build it from
scratch. You can also omit it from the PATCH
payload to keep it as is.
A 204 No Content
status response indicates the multistream target
was
successfully updated.
Disabling a target
curl -X PATCH 'https://livepeer.studio/api/multistream/target/{id}' \
-H 'content-type: application/json' \
-H 'authorization: Bearer {api-key}' \
-d '{
"disabled": true
}'
Changing the target URL
curl -X PATCH 'https://livepeer.studio/api/multistream/target/{id}' \
-H 'content-type: application/json' \
-H 'authorization: Bearer {api-key}' \
-d '{
"url": "srt://rtmp.service.com/live?streamId=SECRET"
}'
Updating all fields
curl -X PATCH 'https://livepeer.studio/api/multistream/target/{id}' \
-H 'content-type: application/json' \
-H 'authorization: Bearer {api-key}' \
-d '{
"name": "Not My Original Target Anymore",
"url": "rtmp://rtmp.real.service.com/SECRET"
"disabled": false
}'