Actions141
- Auto DJ Actions
- Auto DJ > Events Actions
- Auto DJ > Media Actions
- Auto DJ > Playing Playlist Actions
- Auto DJ > Playlist Actions
- Encoder Events Actions
- Hls Stream Actions
- Mediapulse Actions
- Notifications Actions
- Options Actions
- Packs Actions
- Players Actions
- Radio Product Options Actions
- Radio Products Actions
- Server Events Actions
- Stations Actions
- Stats > Hls Stream Actions
- Stats > Radio Products Actions
- Stats > Stations Actions
- Get Status
- Get Instant Listeners
- Get Stats Listeners
- Get Mediastats
- Set Metadata To Station
- Get Listeners
- Get Listeners Per Minute
- Get Listeners Per Minute Per Stream
- Get Countries
- Get Countries By Continent
- Get Listeners By Stream
- Get Consumption
- Get Total Consumption
- Get Consumption By Stream
- Get Players
- Get Total Players
- Get Stats By Streams
- Export Stats
- Export Stats By Stream
- List Stats Links
- Stats > Streams Actions
- Streams Actions
- Transcodings Actions
Streams → Update Stream
AI-generatedSummary
Update an Infomaniak streaming radio stream by sending custom configuration fields to the API.
Inputs
- authentication — Authentication method to use, either OAuth2 or API Key.
- path_radio_product_id (required) — The unique identifier (ID) of the radio product to request.
- path_station_id (required) — The unique identifier (ID) of the station to request.
- path_stream_id (required) — The unique identifier (ID) of the stream to request.
- body_bitrate — Specify the bitrate of the stream; options include 24,32,...,512.
- body_codec — Specify the codec of the stream; options include 1,2,3,4.
- body_country_list — Specify the country list not allow accessing to the stream.
- body_fallback_is_active_relay — Specify if the fallback is a relay stream.
- body_fallback_relay_mountpoint — Specify the relay mountpoint for the fallback.
- body_fallback_relay_port — Specify the relay server port for the fallback.
- body_fallback_relay_server — Specify the relay server domain for the fallback.
- body_hash_key — Specify the token to protect the stream.
- body_ip_exclude_list — Specify the ip list not allow accessing to the stream.
- body_ip_include_list — Specify the ip list allow accessing to the stream.
- body_is_active_relay — Specify if this is a relay stream.
- body_is_allow_country — Specify if the access restriction rules is enabled.
- body_is_fallback — Specify is the new stream have a fallback.
- body_is_hash_restriction — Specify if the access restriction rules is enabled.
- body_mountpoint — Specify the mountpoint of the stream.
- body_password — Specify the password of the stream.
- body_relay_mountpoint — Specify the relay mountpoint.
- body_relay_port — Specify the relay server port.
- body_relay_server — Specify the relay server domain.
- returnFullResponse — If true, the full HTTP response body is returned; otherwise only a status indication.
Output shape
A JSON response object indicating success or error; when returnFullResponse is true the full HTTP response body is included, otherwise only a status.
The response may be empty on success if returnFullResponse is false; errors return an error object with details.
Examples
Example 1: Update stream bitrate using API Key
authentication=apiKey, path_radio_product_id=12, path_station_id=5, path_stream_id=3, body_bitrate=128, returnFullResponse=false
Example 2: Modify mountpoint and enable fallback
authentication=apiKey, path_radio_product_id=12, path_station_id=5, path_stream_id=3, body_mountpoint=/new, body_is_fallback=true, returnFullResponse=true
Example 3: Set hash key to protect stream
authentication=apiKey, path_radio_product_id=12, path_station_id=5, path_stream_id=3, body_hash_key=ABC123, returnFullResponse=false