AzuraCast
v0.23.8Base URL
https://demo.azuracast.com/apiAzuraCast Public Demo ServerAzuraCast is a standalone, turnkey web radio management tool. Radio stations hosted by AzuraCast expose a public API for viewing now playing data, making requests and more.
Authentication
ApiKeyapiKeyAPI Key: X-API-Key in header
Public: Now Playing
Endpoints that provide full summaries of the current state of stations.
Public: Stations
- GETReturns the album art for a song, or a generic image.
- GETReturns a list of stations.
- GETReturn information about a single station.
- GETDownload an on-demand playlist file by media unique ID.
- GETList all tracks available on-demand for this station.
- GETGets the album art for a podcast.
- GETGets the album art for a podcast episode.
- GETGet information for a public episode of a public podcast.
- GETList all visible episodes for a given podcast.
- GETGets the media for a podcast episode.
- GETGet the public information for a given podcast.
- GETList all visible public podcasts.
- GETReturn a list of requestable songs.
- POSTSubmit a song request.
- GETReturn upcoming and currently ongoing schedule entries.
- GETGets the default album art for a streamer.
Public: Miscellaneous
Stations: General
- GETGet the details of the custom asset of the specified type.
- POSTUpload a new custom asset of the specified type.
- DELETERemoves the custom asset of the specified type.
- GETGet the custom fallback track for a station.
- POSTUpdate the custom fallback track for the station.
- DELETERemoves the custom fallback track for a station.
- GETGet the current usage and quota for a given station storage location.
- GETGet the current usage and quota for a given station storage location.
- GETReturn a list of available logs for the given station.
- GETView a specific log contents for the given station.
- GETRetrieve the profile of the given station.
- GETGet the editable profile for the current station.
- PUTSave the station profile for the current station.
- POSTManually update the Now Playing metadata for the station.
Stations: Broadcasting
- GETGenerate an archive of all Liquidsoap configuration on your station, including custom config.
- GETGet the generated and editable sections of the station Liquidsoap configuration.
- PUTSave the editable sections of the station Liquidsoap configuration.
- POSTImport a previously exported Liquidsoap configuration archive and replace custom config sections.
- GETRetrieve the current status of all serivces associated with the radio broadcast.
- POSTRestart all services associated with the radio broadcast.
- POSTPerform service control actions on the radio frontend (Icecast, Shoutcast, etc.)
- POSTPerform service control actions on the radio backend (Liquidsoap)
- GETGet the Stereo Tool configuration file for a station.
- POSTUpdate the Stereo Tool configuration file for a station.
- DELETERemoves the Stereo Tool configuration file for a station.
Stations: HLS Streams
Stations: Media
- POSTSets the album art for a track.
- DELETERemoves the album art for a track.
- GETDownload a CSV containing details about all station media.
- POSTUpload a CSV containing details about all station media.
- POSTPreview changes from a CSV containing details about all station media.
- PUTPerform a batch action on a collection of files/directories.
- GETDownload a file by relative path.
- POSTUpload and process a new media file.
- GETList files in the media directory by path.
- GETList directories in a station media library for moving/renaming.
- POSTCreate a directory in a station media directory.
- GETDownload or play a given file by ID.
- GETDownload or play a given file by song_id.
- PUTRename the specified files in the station media directory.
- GETList all current uploaded files.
- POSTUpload a new file.
- GETRetrieve details for a single file.
- PUTUpdate details of a single file.
- DELETEDelete a single file.
- GETGet waveform data for a media ID (for the Visual Cue Editor).
- POSTSave cached waveform data for a media ID (for the Visual Cue Editor).
Stations: Mount Points
- GETGet the intro track for a mount point.
- POSTUpdate the intro track for a mount point.
- DELETERemoves the intro track for a mount point.
- GETList all current mount points.
- POSTCreate a new mount point.
- GETRetrieve details for a single mount point.
- PUTUpdate details of a single mount point.
- DELETEDelete a single mount point.
Stations: Playlists
- POSTCreate a copy of the specified playlist.
- GETGet the current playback queue for the specified playlist.
- DELETEReset the internal playback queue of a shuffled, song-based playlist.
- DELETEEmpty the contents of a song-based playlist.
- GETExport a playlist contents in standard media player playlist format.
- GETExport all of a station's playlists as a JSON configuration dump.
- GETExport a single playlist (and any group members) as a JSON configuration dump.
- GETGet a list of directories that the given playlist can apply to.
- PUTApply the specified playlist to the specified directories.
- GETGet the current order of sequential tracks in the specified playlist.
- PUTSet the order of sequential tracks in the specified playlist.
- POSTImport the contents of an uploaded playlist (PLS/M3U) file into the specified playlist.
- POSTImport playlists from a JSON configuration dump, creating new playlists on the station.
- PUTSet the member playlists of the specified playlist group.
- PUTRe-shuffle a playlist whose playback order is "shuffled".
- PUTToggle a playlist between enabled and disabled status.
- GETList all current playlists.
- POSTCreate a new playlist.
- GETRetrieve details for a single playlist.
- PUTUpdate details of a single playlist.
- DELETEDelete a single playlist.
- GETReturn calendar events for the station's playlist schedule.
- POSTImport the contents of an uploaded playlist (PLS/M3U) file into the specified playlist.
Stations: Podcasts
- GETList all current episodes for a given podcast ID.
- POSTCreate a new podcast episode.
- GETRetrieve details for a single podcast episode.
- PUTUpdate details of a single podcast episode.
- DELETEDelete a single podcast episode.
- POSTSets the album art for a podcast.
- DELETERemoves the album art for a podcast.
- POSTSets the album art for a podcast episode.
- DELETERemoves the album art for a podcast episode.
- POSTSets the media for a podcast episode.
- DELETERemoves the media for a podcast episode.
- GETGet a list of playlists that can be associated with a podcast.
- GETList all current podcasts.
- POSTCreate a new podcast.
- GETRetrieve details for a single podcast.
- PUTUpdate details of a single podcast.
- DELETEDelete a single podcast.
Stations: Queue
Stations: Remote Relays
Stations: Reports
- GETReturn song playback history items for a given station.
- GETReturn detailed information about current listeners.
- GETGet the "Best and Worst Performing Songs" report for a station.
- GETGet the "Listeners by Browser" report for a station.
- GETGet the "Listeners by Client" report for a station.
- GETGet the "Listeners by Country" report for a station.
- GETGet the "Listeners by Listening Time" report for a station.
- GETGet the "Listeners by Stream" report for a station.
- GETGet chart data for the station reports.
- GETList station requests.
- POSTClear all unplayed station requests.
- DELETEDelete an individual station request.
- GETGenerate a SoundExchange royalty report.
Stations: SFTP Users
Stations: Streamers/DJs
- POSTSets the default album art for a streamer.
- DELETERemoves the default album art for a streamer.
- POSTPerform batch actions on the specified broadcasts.
- GETList all broadcasts associated with the station.
- GETList all broadcasts associated with the specified streamer.
- GETDownload a single broadcast from a streamer.
- DELETERemove a single broadcast from a streamer.
- GETList all current Streamer/DJ accounts for the specified station.
- POSTCreate a new Streamer/DJ account.
- GETRetrieve details for a single Streamer/DJ account.
- PUTUpdate details of a single Streamer/DJ account.
- DELETEDelete a single Streamer/DJ account.
- GETReturn calendar events for the station's streamer/DJ schedule.
Stations: Web Hooks
- PUTSend a test dispatch of a webhook with the current Now Playing data for the station.
- GETView a specific webhook test dispatch log contents.
- PUTToggle the enabled/disabled status of a webhook.
- GETList all current web hooks.
- POSTCreate a new web hook.
- GETRetrieve details for a single web hook.
- PUTUpdate details of a single web hook.
- DELETEDelete a single web hook.
- POSTDuplicate a single web hook.
Administration: General
- GETView the logs of a manually run ACME certificate renewal.
- PUTGenerate or renew ACME certificate.
- GETList all current API keys across the system.
- POSTCreate a new API key for a specified user.
- DELETEDelete a single API key.
- GETList all Audit Log actions that have taken place on the installation.
- GETGet the details of the custom asset of the specified type.
- POSTUpload a new custom asset of the specified type.
- DELETERemoves the custom asset of the specified type.
- GETGet the current MaxMindDB GeoLite Database status.
- POSTSet the GeoLite MaxMindDB Database license key.
- GETList all available log types for viewing.
- GETView a specific log contents.
- GETReturn a list of all currently active AzuraRelay instances.
- GETGet the current Rocket Streaming Audio Server (RSAS) status.
- POSTUpload a new Rocket Streaming Audio Server (RSAS) binary.
- DELETERemoves the Rocket Streaming Audio Server (RSAS) installation.
- POSTUpload a new Rocket Streaming Audio Server (RSAS) license key.
- DELETERemoves the Rocket Streaming Audio Server (RSAS) license.
- POSTSend a test e-mail to confirm mail delivery settings.
- GETReturn a list of all CPU usage stats.
- GETList the status of essential system services.
- POSTRestart the specified service.
- GETGet details about the Shoutcast installation.
- POSTUpload a new Shoutcast binary.
- DELETERemoves the installed Shoutcast binary.
- GETGet information about the Stereo Tool installation.
- POSTUpload a new Stereo Tool binary.
- DELETERemoves the installed Stereo Tool binary.
- GETShow information about this installation and its update status.
- PUTAttempts to trigger a web-based update.
- GET/internal/relays
Administration: Debugging
- PUTClear the application cache (Redis).
- PUTClear the specified message queue.
- PUTClear the upcoming song queue and generate a new one.
- GETList all message queues.
- GETList all stations with their debug links.
- GETList all sync tasks and details about their run times.
- PUTGet the next song to be played by the AutoDJ for a given station.
- PUTGenerate the raw Now Playing data for a given station.
- PUTManually run a scheduled synchronized task by name.
- PUTManually run a Telnet command on a station backend.
Administration: Backups
Administration: Custom Fields
Administration: Users
- GETList all current unexpired login tokens in the system.
- POSTCreate a new login token.
- GETRetrieve details for a single login token.
- DELETEDelete a single login token.
- GETList all current users in the system.
- POSTCreate a new user.
- GETRetrieve details for a single current user.
- PUTUpdate details of a single user.
- DELETEDelete a single user.
Administration: Roles
Administration: Settings
Administration: Stations
Administration: Storage Locations
My Account
- GETList all API keys associated with your account.
- POSTCreate a new API key associated with your account.
- GETRetrieve details for a single API key.
- DELETEDelete a single API key associated with your account.
- GETGet the current two-factor authentication status of your account.
- PUTRegister a new two-factor authentication method.
- DELETERemove two-factor authentication from your account.
- GETShow the details for your current logged-in account.
- PUTSave changes to your logged in account.
- GETList currently registered passkeys.
- GETGet the details of a single passkey.
- DELETEDelete a specified passkey by ID.
- PUTChange the password of your account.
- GETGet registration details for WebAuthn registration.
- PUTSubmit a new registration request for WebAuthn.
Miscellaneous
Models
- Api_Account_ChangePassword
- Api_Account_NewApiKey
- Api_Account_TwoFactorStatus
- Api_Admin_AuditLogChangeset
- Api_Admin_Backup
- Api_Admin_Debug_Queue
- Api_Admin_Debug_Station
- Api_Admin_Debug_LogEntry
- Api_Admin_Debug_LogResult
- Api_Admin_Debug_SyncTask
- Api_Admin_GeoLiteStatus
- Api_Admin_LogList
- Api_Admin_NewApiKey
- Api_Admin_NewLoginToken
- Api_Admin_NewLoginTokenResponse
- Api_Admin_Permission
- Api_Admin_Permissions
- Api_Admin_Relay
- Api_Admin_Role
- Api_Admin_RolePermissions
- Api_Admin_RoleStationPermission
- Api_Admin_RsasStatus
- Api_Admin_ServerStats_CpuStats
- Api_Admin_ServerStats_CpuStatsSection
- Api_Admin_ServerStats_MemoryStats
- Api_Admin_ServerStats_NetworkInterfaceReceived
- Api_Admin_ServerStats_NetworkInterfaceStats
- Api_Admin_ServerStats_NetworkInterfaceTransmitted
- Api_Admin_ServerStats
- Api_Admin_ServerStats_StorageStats
- Api_Admin_ServiceData
- Api_Admin_ShoutcastStatus
- Api_Admin_StationLogList
- Api_Admin_StereoToolStatus
- Api_Admin_StorageLocation
- Api_Admin_UpdateDetails
- Api_Admin_UserWithDetails
- Api_Admin_Vue_BackupProps
- Api_Admin_Vue_CustomFieldProps
- Api_Admin_Vue_PermissionsProps
- Api_Admin_Vue_SettingsProps
- Api_Admin_Vue_StationsFormProps
- Api_Admin_Vue_StationsProps
- Api_Admin_Vue_UpdateProps
- Api_Admin_Vue_UsersProps
- Api_BatchResult
- Api_DetailedSongHistory
- Api_Error
- Api_FileList
- Api_FileListDir
- Api_Form_Option
- Api_Form_OptionGroup
- Api_GenericForm
- Api_Form_NestedOptions
- Api_Form_SimpleOptions
- Api_GenericBatchResult
- HashMapA hash-map array represented as an object.
- Api_Listener
- Api_LogContents
- Api_LogType
- Api_MediaBatchResult
- Api_Notification
- Api_NowPlaying_CurrentSong
- Api_NowPlaying_Listeners
- Api_NowPlaying_Live
- Api_NowPlaying
- Api_NowPlaying_SongHistory
- Api_NowPlaying_Station
- Api_NowPlaying_StationMount
- Api_NowPlaying_StationQueue
- Api_NowPlaying_StationRemote
- Api_NowPlaying_Vue_Props
- Api_PlaylistConfigurationImportResult
- Api_Podcast
- Api_PodcastBatchResult
- Api_PodcastCategory
- Api_PodcastEpisode
- Api_PodcastMedia
- Api_ResolvableUrl
- Api_Song
- Api_StationMedia
- Api_StationMediaPlaylist
- Api_StationOnDemand
- Api_StationPlaylistComputedFields
- Api_StationPlaylistParentGroup
- Api_StationPlaylistQueue
- Api_StationProfile
- Api_StationQueueDetailed
- Api_StationQuota
- Api_StationRequest
- Api_StationSchedule
- Api_StationScheduleGroupMember
- Api_StationSchedulePlaylistEvent
- Api_StationScheduleStreamerEvent
- Api_StationServiceStatus
- Api_StationStreamer
- Api_StationStreamerBroadcast
- Api_StationStreamerBroadcastRecording
- Api_Stations_Vue_FilesProps
- Api_Stations_Vue_PodcastsProps
- Api_Stations_Vue_ProfileProps
- Api_Stations_Vue_SftpUsersProps
- Api_Stations_Vue_StreamersProps
- Api_Status
- Api_SystemStatus
- Api_TaskWithLog
- Api_Time
- Api_ToastNotification
- HasLinks
- Api_HasSongFields
- Api_UploadFile
- Api_UploadedRecordStatus
- Vue_AppGlobals
- Vue_DashboardGlobals
- Vue_StationFeatures
- Vue_StationGlobals
- Vue_UserGlobals
- Api_WidgetCustomization
- ApiKey
- AuditLog
- CustomField
- AnalyticsLevel
- FileTypes
- IpSources
- LoginTokenTypes
- PlaylistGroupAllowedRequests
- PlaylistOrders
- PlaylistRemoteTypes
- PlaylistSources
- PlaylistTypes
- PodcastSources
- StationBackendPerformanceModes
- StorageLocationAdapters
- StorageLocationTypes
- Api_ListenerDevice
- Api_ListenerLocation
- PodcastBrandingConfiguration
- Relay
- Settings
- SftpUser
- Station
- StationBackendConfiguration
- StationBrandingConfiguration
- StationFrontendConfiguration
- StationHlsStream
- StationMediaMetadata
- StationMount
- StationPlaylist
- StationPlaylistGroup
- StationRemote
- StationSchedule
- StationStreamerStation streamers (DJ accounts) allowed to broadcast to a station.
- StationStreamerBroadcastEach individual broadcast associated with a streamer.
- StationWebhook
- StorageLocation
- HasAutoIncrementId
- HasSongFields
- HasSplitTokenFields
- HasUniqueId
- User
- UserLoginToken
- FlashLevels
- GlobalPermissions
- ReleaseChannel
- StationPermissions
- SupportedLocales
- SupportedThemes
- AudioProcessingMethods
- BackendAdapters
- CrossfadeModes
- FrontendAdapters
- HlsStreamProfiles
- MasterMePresets
- RemoteAdapters
- StreamFormats
- WebhookTriggers
- WebhookTypes