DovaFM Documentation
WebsiteAdd Discord Bot
  • Welcome to the DovaFM Documentation!
  • DovaFM Stream
    • Embed Widgets
    • Public Pages
    • Radio & Playlist Streams
  • DovaFM API
    • Now Playing
    • Stations
      • General
      • Broadcasting
      • Song Requests
      • Service Control
      • History
      • HLS Streams
      • Listeners
      • Schedules
      • Media
      • Mount Points
      • Playlists
      • Podcasts
      • Queue
      • Remote Relays
      • SFTP Users
      • Streamers/DJs
      • Web Hooks
    • Administration
      • Custom Fields
      • Users
      • Relays
      • Roles
      • Settings
      • Stations
      • Storage Locations
      • CPU Status
    • Miscellaneous
      • Status
      • Time
  • DovaFM Discord Bot
    • Information
    • Commands
  • DovaFM Staff
    • Staff Members
Powered by GitBook
On this page
  1. DovaFM API
  2. Administration

Stations

PreviousSettingsNextStorage Locations

Last updated 7 months ago

get

Retrieve details for a single station.

Authorizations
Path parameters
idinteger ยท int64Required

ID

Responses
200
Success
application/json
Responseall of
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
get
GET /api/admin/station/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "id": 1,
  "name": "AzuraTest Radio",
  "short_name": "azuratest_radio",
  "is_enabled": true,
  "frontend_type": "icecast",
  "frontend_config": {},
  "backend_type": "liquidsoap",
  "backend_config": {},
  "description": "A sample radio station.",
  "url": "https://demo.azuracast.com/",
  "genre": "Various",
  "radio_base_dir": "/var/azuracast/stations/azuratest_radio",
  "enable_requests": true,
  "request_delay": 5,
  "request_threshold": 15,
  "disconnect_deactivate_streamer": 0,
  "enable_streamers": false,
  "is_streamer_live": false,
  "enable_public_page": true,
  "enable_on_demand": true,
  "enable_on_demand_download": true,
  "enable_hls": true,
  "api_history_items": 5,
  "timezone": "UTC",
  "branding_config": {}
}
delete

Delete a single station.

Authorizations
Path parameters
idinteger ยท int64Required

ID

Responses
200
Success
application/json
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
delete
DELETE /api/admin/station/{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>"
}
  • GET/admin/stations
  • POST/admin/stations
  • GET/admin/station/{id}
  • PUT/admin/station/{id}
  • DELETE/admin/station/{id}
get

List all current stations in the system.

Authorizations
Responses
200
Success
application/json
Responseall of[]
403
Access denied.
application/json
500
A generic exception has occurred.
application/json
get
GET /api/admin/stations HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
[
  {
    "id": 1,
    "name": "AzuraTest Radio",
    "short_name": "azuratest_radio",
    "is_enabled": true,
    "frontend_type": "icecast",
    "frontend_config": {},
    "backend_type": "liquidsoap",
    "backend_config": {},
    "description": "A sample radio station.",
    "url": "https://demo.azuracast.com/",
    "genre": "Various",
    "radio_base_dir": "/var/azuracast/stations/azuratest_radio",
    "enable_requests": true,
    "request_delay": 5,
    "request_threshold": 15,
    "disconnect_deactivate_streamer": 0,
    "enable_streamers": false,
    "is_streamer_live": false,
    "enable_public_page": true,
    "enable_on_demand": true,
    "enable_on_demand_download": true,
    "enable_hls": true,
    "api_history_items": 5,
    "timezone": "UTC",
    "branding_config": {}
  }
]
post

Create a new station.

Authorizations
Body
all ofOptional
Responses
200
Success
application/json
Responseall of
403
Access denied.
application/json
500
A generic exception has occurred.
application/json
post
POST /api/admin/stations HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 640

{
  "id": 1,
  "name": "AzuraTest Radio",
  "short_name": "azuratest_radio",
  "is_enabled": true,
  "frontend_type": "icecast",
  "frontend_config": {},
  "backend_type": "liquidsoap",
  "backend_config": {},
  "description": "A sample radio station.",
  "url": "https://demo.azuracast.com/",
  "genre": "Various",
  "radio_base_dir": "/var/azuracast/stations/azuratest_radio",
  "enable_requests": true,
  "request_delay": 5,
  "request_threshold": 15,
  "disconnect_deactivate_streamer": 0,
  "enable_streamers": false,
  "is_streamer_live": false,
  "enable_public_page": true,
  "enable_on_demand": true,
  "enable_on_demand_download": true,
  "enable_hls": true,
  "api_history_items": 5,
  "timezone": "UTC",
  "branding_config": {}
}
{
  "id": 1,
  "name": "AzuraTest Radio",
  "short_name": "azuratest_radio",
  "is_enabled": true,
  "frontend_type": "icecast",
  "frontend_config": {},
  "backend_type": "liquidsoap",
  "backend_config": {},
  "description": "A sample radio station.",
  "url": "https://demo.azuracast.com/",
  "genre": "Various",
  "radio_base_dir": "/var/azuracast/stations/azuratest_radio",
  "enable_requests": true,
  "request_delay": 5,
  "request_threshold": 15,
  "disconnect_deactivate_streamer": 0,
  "enable_streamers": false,
  "is_streamer_live": false,
  "enable_public_page": true,
  "enable_on_demand": true,
  "enable_on_demand_download": true,
  "enable_hls": true,
  "api_history_items": 5,
  "timezone": "UTC",
  "branding_config": {}
}
put

Update details of a single station.

Authorizations
Path parameters
idinteger ยท int64Required

ID

Body
all ofOptional
Responses
200
Success
application/json
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
put
PUT /api/admin/station/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 640

{
  "id": 1,
  "name": "AzuraTest Radio",
  "short_name": "azuratest_radio",
  "is_enabled": true,
  "frontend_type": "icecast",
  "frontend_config": {},
  "backend_type": "liquidsoap",
  "backend_config": {},
  "description": "A sample radio station.",
  "url": "https://demo.azuracast.com/",
  "genre": "Various",
  "radio_base_dir": "/var/azuracast/stations/azuratest_radio",
  "enable_requests": true,
  "request_delay": 5,
  "request_threshold": 15,
  "disconnect_deactivate_streamer": 0,
  "enable_streamers": false,
  "is_streamer_live": false,
  "enable_public_page": true,
  "enable_on_demand": true,
  "enable_on_demand_download": true,
  "enable_hls": true,
  "api_history_items": 5,
  "timezone": "UTC",
  "branding_config": {}
}
{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}