100ms Logo

100ms

Docs

Search docs
/

Update settings

This endpoint is used to update settings.

POSThttps://api.100ms.live/v2/templates/<template_id>/settings
curl --location --request POST 'https://api.100ms.live/v2/<template_id>/settings' \ --header 'Authorization: Bearer <management_token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "region": "eu", "subscribeDegradation": {}, "recording": { "enabled": true, "upload": { "type": "<upload type: supported are s3, gs, oss>", "location": "<Name of the storage bucket>", "prefix": "<Upload prefix path>", "options": { "region": "<region of the storage bucket>" }, "credentials": { "key": "<access key ID for accessing the storage bucket>", "secretKey": "<secret access key for accessing the storage bucket>" } } }, "screenSimulcastLayers": {}, "videoSimulcastLayers": {}, "roomState": { "messageInterval": 5, "sendPeerList": false, "stopRoomStateOnJoin": true, "enabled": false } }'
RESPONSE
Status: 200 OK
{ "region": "eu", "subscribeDegradation": {}, "screenSimulcastLayers": {}, "videoSimulcastLayers": {}, "recording": { "enabled": true, "upload": { "location": "<Name of the storage bucket>", "type": "<upload type: supported are s3, gs, oss>", "prefix": "<Upload prefix path>", "credentials": { "key": "<access key ID for accessing the storage bucket>", "secret": "<secret access key for accessing the storage bucket>" }, "options": { "region": "<region of the storage bucket>" } } }, "roomState": { "messageInterval": 5, "sendPeerList": false, "stopRoomStateOnJoin": true, "enabled": false }, "retry": {} }

Arguments

NameTypeDescriptionRequired
template_id
— path param
stringUnique identifier of the template you wish to update settings details for.
Example: 6316d5ca5a2635a5849a0216
Yes
settingsObject
objectSettings object corresponding to the given template_id.

check the settings object arguments section for the list of arguments supported
Yes

Have a suggestion? Recommend changes ->

Run in postman

Was this helpful?

1234