WebsiteAdd Discord Bot

HLS Streams

get

List all current HLS streams.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
Responses
200
Success
application/json
Responseall of[]
get
GET /api/station/{station_id}/hls_streams HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "id": 1,
    "name": "/radio.mp3",
    "display_name": "128kbps MP3",
    "is_visible_on_public_pages": true,
    "is_default": false,
    "is_public": false,
    "fallback_mount": "/error.mp3",
    "relay_url": "https://radio.example.com:8000/radio.mp3",
    "authhash": "",
    "max_listener_duration": 43200,
    "enable_autodj": true,
    "autodj_format": "mp3",
    "autodj_bitrate": 128,
    "custom_listen_url": "https://custom-listen-url.example.com/stream.mp3",
    "frontend_config": [],
    "listeners_unique": 10,
    "listeners_total": 12
  }
]
post

Create a new HLS stream.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
Body
all ofOptional
Responses
200
Success
application/json
Responseall of
post
POST /api/station/{station_id}/hls_streams HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 456

{
  "id": 1,
  "name": "/radio.mp3",
  "display_name": "128kbps MP3",
  "is_visible_on_public_pages": true,
  "is_default": false,
  "is_public": false,
  "fallback_mount": "/error.mp3",
  "relay_url": "https://radio.example.com:8000/radio.mp3",
  "authhash": "",
  "max_listener_duration": 43200,
  "enable_autodj": true,
  "autodj_format": "mp3",
  "autodj_bitrate": 128,
  "custom_listen_url": "https://custom-listen-url.example.com/stream.mp3",
  "frontend_config": [],
  "listeners_unique": 10,
  "listeners_total": 12
}
{
  "id": 1,
  "name": "/radio.mp3",
  "display_name": "128kbps MP3",
  "is_visible_on_public_pages": true,
  "is_default": false,
  "is_public": false,
  "fallback_mount": "/error.mp3",
  "relay_url": "https://radio.example.com:8000/radio.mp3",
  "authhash": "",
  "max_listener_duration": 43200,
  "enable_autodj": true,
  "autodj_format": "mp3",
  "autodj_bitrate": 128,
  "custom_listen_url": "https://custom-listen-url.example.com/stream.mp3",
  "frontend_config": [],
  "listeners_unique": 10,
  "listeners_total": 12
}
get

Retrieve details for a single HLS stream.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
idinteger · int64Required

HLS Stream ID

Responses
200
Success
application/json
Responseall of
get
GET /api/station/{station_id}/hls_stream/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "name": "/radio.mp3",
  "display_name": "128kbps MP3",
  "is_visible_on_public_pages": true,
  "is_default": false,
  "is_public": false,
  "fallback_mount": "/error.mp3",
  "relay_url": "https://radio.example.com:8000/radio.mp3",
  "authhash": "",
  "max_listener_duration": 43200,
  "enable_autodj": true,
  "autodj_format": "mp3",
  "autodj_bitrate": 128,
  "custom_listen_url": "https://custom-listen-url.example.com/stream.mp3",
  "frontend_config": [],
  "listeners_unique": 10,
  "listeners_total": 12
}
put

Update details of a single HLS stream.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
idinteger · int64Required

HLS Stream ID

Body
all ofOptional
Responses
200
Success
application/json
put
PUT /api/station/{station_id}/hls_stream/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 456

{
  "id": 1,
  "name": "/radio.mp3",
  "display_name": "128kbps MP3",
  "is_visible_on_public_pages": true,
  "is_default": false,
  "is_public": false,
  "fallback_mount": "/error.mp3",
  "relay_url": "https://radio.example.com:8000/radio.mp3",
  "authhash": "",
  "max_listener_duration": 43200,
  "enable_autodj": true,
  "autodj_format": "mp3",
  "autodj_bitrate": 128,
  "custom_listen_url": "https://custom-listen-url.example.com/stream.mp3",
  "frontend_config": [],
  "listeners_unique": 10,
  "listeners_total": 12
}
{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}
delete

Delete a single HLS stream.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
idinteger · int64Required

HLS Stream ID

Responses
200
Success
application/json
delete
DELETE /api/station/{station_id}/hls_stream/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}
PreviousHistoryNextListeners

Last updated