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. Stations

General

PreviousStationsNextBroadcasting

Last updated 7 months ago

get

Get the custom fallback track for a station.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
Responses
200
Success
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
get
GET /api/station/{station_id}/fallback HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

No content

post

Update the custom fallback track for the station.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
Responses
200
Success
application/json
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
post
POST /api/station/{station_id}/fallback 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>"
}
delete

Removes the custom fallback track for a station.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
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/station/{station_id}/fallback 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

Returns a list of stations.

Responses
200
Success
application/json
get
GET /api/stations HTTP/1.1
Host: listen.dovafm.xyz
Accept: */*
200

Success

[
  {
    "id": 1,
    "name": "AzuraTest Radio",
    "shortcode": "azuratest_radio",
    "description": "An AzuraCast station!",
    "frontend": "shoutcast2",
    "backend": "liquidsoap",
    "timezone": "America/Chicago",
    "listen_url": "http://localhost:8000/radio.mp3",
    "url": "https://example.com/",
    "public_player_url": "https://example.com/public/example_station",
    "playlist_pls_url": "https://example.com/public/example_station/playlist.pls",
    "playlist_m3u_url": "https://example.com/public/example_station/playlist.m3u",
    "is_public": true,
    "mounts": [
      {
        "id": 1,
        "name": "/radio.mp3",
        "url": "http://localhost:8000/radio.mp3",
        "bitrate": 128,
        "format": "mp3",
        "listeners": {
          "total": 20,
          "unique": 15,
          "current": 20
        },
        "path": "/radio.mp3",
        "is_default": true
      }
    ],
    "remotes": [
      {
        "id": 1,
        "name": "/radio.mp3",
        "url": "http://localhost:8000/radio.mp3",
        "bitrate": 128,
        "format": "mp3",
        "listeners": {
          "total": 20,
          "unique": 15,
          "current": 20
        }
      }
    ],
    "hls_enabled": true,
    "hls_is_default": true,
    "hls_url": "https://example.com/hls/azuratest_radio/live.m3u8",
    "hls_listeners": 1
  }
]
get

Return information about a single station.

Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
Responses
200
Success
application/json
404
Record not found.
application/json
get
GET /api/station/{station_id} HTTP/1.1
Host: listen.dovafm.xyz
Accept: */*
{
  "id": 1,
  "name": "AzuraTest Radio",
  "shortcode": "azuratest_radio",
  "description": "An AzuraCast station!",
  "frontend": "shoutcast2",
  "backend": "liquidsoap",
  "timezone": "America/Chicago",
  "listen_url": "http://localhost:8000/radio.mp3",
  "url": "https://example.com/",
  "public_player_url": "https://example.com/public/example_station",
  "playlist_pls_url": "https://example.com/public/example_station/playlist.pls",
  "playlist_m3u_url": "https://example.com/public/example_station/playlist.m3u",
  "is_public": true,
  "mounts": [
    {
      "id": 1,
      "name": "/radio.mp3",
      "url": "http://localhost:8000/radio.mp3",
      "bitrate": 128,
      "format": "mp3",
      "listeners": {
        "total": 20,
        "unique": 15,
        "current": 20
      },
      "path": "/radio.mp3",
      "is_default": true
    }
  ],
  "remotes": [
    {
      "id": 1,
      "name": "/radio.mp3",
      "url": "http://localhost:8000/radio.mp3",
      "bitrate": 128,
      "format": "mp3",
      "listeners": {
        "total": 20,
        "unique": 15,
        "current": 20
      }
    }
  ],
  "hls_enabled": true,
  "hls_is_default": true,
  "hls_url": "https://example.com/hls/azuratest_radio/live.m3u8",
  "hls_listeners": 1
}
  • GET/station/{station_id}/fallback
  • POST/station/{station_id}/fallback
  • DELETE/station/{station_id}/fallback
  • GET/stations
  • GET/station/{station_id}