### Get Prometheus Measurements Source: https://www.azuracast.com/api Returns the Prometheus measurements for this installation. ```APIDOC ## GET /prometheus ### Description Returns the Prometheus measurements for this installation. ### Method GET ### Endpoint /prometheus ``` -------------------------------- ### Stations: Playlists - Get Applyable Directories Source: https://www.azuracast.com/api Gets a list of directories to which a specific playlist can be applied. ```APIDOC ## GET /station/{station_id}/playlist/{id}/apply-to ### Description Get a list of directories that the given playlist can apply to. ### Method GET ### Endpoint /station/{station_id}/playlist/{id}/apply-to ``` -------------------------------- ### Get Passkey Details Source: https://www.azuracast.com/api Gets the details of a single passkey. ```APIDOC ## GET /frontend/account/passkey/{id} ### Description Get the details of a single passkey. ### Method GET ### Endpoint /frontend/account/passkey/{id} ``` -------------------------------- ### Get WebAuthn Registration Details Source: https://www.azuracast.com/api Gets registration details for WebAuthn registration. ```APIDOC ## GET /frontend/account/webauthn/register ### Description Get registration details for WebAuthn registration. ### Method GET ### Endpoint /frontend/account/webauthn/register ``` -------------------------------- ### Stations: Podcasts - Get Podcast-Associated Playlists Source: https://www.azuracast.com/api Gets a list of playlists that can be associated with a podcast. ```APIDOC ## GET /station/{station_id}/podcasts/playlists ### Description Get a list of playlists that can be associated with a podcast. ### Method GET ### Endpoint /station/{station_id}/podcasts/playlists ``` -------------------------------- ### Stations: Queue - Get Upcoming Queue Source: https://www.azuracast.com/api Returns information about the upcoming song playback queue for a station. ```APIDOC ## GET /station/{station_id}/queue ### Description Return information about the upcoming song playback queue. ### Method GET ### Endpoint /station/{station_id}/queue ``` -------------------------------- ### Stations: Playlists - Get Playlist Queue Source: https://www.azuracast.com/api Gets the current playback queue for the specified playlist. ```APIDOC ## GET /station/{station_id}/playlist/{id}/queue ### Description Get the current playback queue for the specified playlist. ### Method GET ### Endpoint /station/{station_id}/playlist/{id}/queue ``` -------------------------------- ### Stations: Playlists - Get Playlist Order Source: https://www.azuracast.com/api Gets the current order of sequential tracks in the specified playlist. ```APIDOC ## GET /station/{station_id}/playlist/{id}/order ### Description Get the current order of sequential tracks in the specified playlist. ### Method GET ### Endpoint /station/{station_id}/playlist/{id}/order ``` -------------------------------- ### Stations: Queue - Get Queued Item Details Source: https://www.azuracast.com/api Retrieves details of a single item in the playback queue. ```APIDOC ## GET /station/{station_id}/queue/{id} ### Description Retrieve details of a single queued item. ### Method GET ### Endpoint /station/{station_id}/queue/{id} ``` -------------------------------- ### Get Two-Factor Authentication Status Source: https://www.azuracast.com/api Gets the current two-factor authentication status of your account. ```APIDOC ## GET /frontend/account/two-factor ### Description Get the current two-factor authentication status of your account. ### Method GET ### Endpoint /frontend/account/two-factor ``` -------------------------------- ### Update Dashboard Charts Source: https://www.azuracast.com/api Gets the measurements for the dashboard charts. ```APIDOC ## PUT /frontend/dashboard/charts ### Description Get the measurements for the dashboard charts. ### Method PUT ### Endpoint /frontend/dashboard/charts ``` -------------------------------- ### List All Storage Locations Source: https://www.azuracast.com/api Lists all current storage locations in the system. ```APIDOC ## GET /admin/storage_locations ### Description List all current storage locations in the system. ### Method GET ### Endpoint /admin/storage_locations ``` -------------------------------- ### Stations: Podcasts - Create New Podcast Source: https://www.azuracast.com/api Creates a new podcast for a station. ```APIDOC ## POST /station/{station_id}/podcasts ### Description Create a new podcast. ### Method POST ### Endpoint /station/{station_id}/podcasts ``` -------------------------------- ### List All API Keys Source: https://www.azuracast.com/api Lists all API keys associated with your account. ```APIDOC ## GET /frontend/account/api-keys ### Description List all API keys associated with your account. ### Method GET ### Endpoint /frontend/account/api-keys ``` -------------------------------- ### Create New Station Source: https://www.azuracast.com/api Creates a new station in the system. ```APIDOC ## POST /admin/stations ### Description Create a new station. ### Method POST ### Endpoint /admin/stations ``` -------------------------------- ### Show Account Details Source: https://www.azuracast.com/api Shows the details for your current logged-in account. ```APIDOC ## GET /frontend/account/me ### Description Show the details for your current logged-in account. ### Method GET ### Endpoint /frontend/account/me ``` -------------------------------- ### Stations: Podcasts - List All Podcasts Source: https://www.azuracast.com/api Lists all current podcasts for a station. ```APIDOC ## GET /station/{station_id}/podcasts ### Description List all current podcasts. ### Method GET ### Endpoint /station/{station_id}/podcasts ``` -------------------------------- ### Stations: Podcasts - Create New Podcast Episode Source: https://www.azuracast.com/api Creates a new podcast episode. ```APIDOC ## POST /station/{station_id}/podcast/{podcast_id}/episodes ### Description Create a new podcast episode. ### Method POST ### Endpoint /station/{station_id}/podcast/{podcast_id}/episodes ``` -------------------------------- ### List All Stations Source: https://www.azuracast.com/api Lists all current stations in the system. ```APIDOC ## GET /admin/stations ### Description List all current stations in the system. ### Method GET ### Endpoint /admin/stations ``` -------------------------------- ### List Passkeys Source: https://www.azuracast.com/api Lists currently registered passkeys. ```APIDOC ## GET /frontend/account/passkeys ### Description List currently registered passkeys. ### Method GET ### Endpoint /frontend/account/passkeys ``` -------------------------------- ### Create New API Key Source: https://www.azuracast.com/api Creates a new API key associated with your account. ```APIDOC ## POST /frontend/account/api-keys ### Description Create a new API key associated with your account. ### Method POST ### Endpoint /frontend/account/api-keys ``` -------------------------------- ### Create New Storage Location Source: https://www.azuracast.com/api Creates a new storage location in the system. ```APIDOC ## POST /admin/storage_locations ### Description Create a new storage location. ### Method POST ### Endpoint /admin/storage_locations ``` -------------------------------- ### Stations: Playlists - Create New Playlist Source: https://www.azuracast.com/api Creates a new playlist for a station. ```APIDOC ## POST /station/{station_id}/playlists ### Description Create a new playlist. ### Method POST ### Endpoint /station/{station_id}/playlists ``` -------------------------------- ### Administration: Backups Endpoints Source: https://www.azuracast.com/api Endpoints for managing backups, including listing, deleting, downloading, viewing logs, and initiating manual backups. ```APIDOC ## GET /admin/backups ### Description Return a list of all current backups. ### Method GET ### Endpoint /admin/backups ``` ```APIDOC ## DELETE /admin/backups/delete/{path} ### Description Delete a given backup. ### Method DELETE ### Endpoint /admin/backups/delete/{path} ``` ```APIDOC ## GET /admin/backups/download/{path} ### Description Download a given backup. ### Method GET ### Endpoint /admin/backups/download/{path} ``` ```APIDOC ## GET /admin/backups/log/{path} ### Description View a specific backup log contents. ### Method GET ### Endpoint /admin/backups/log/{path} ``` ```APIDOC ## POST /admin/backups/run ### Description Initialize a manual backup. ### Method POST ### Endpoint /admin/backups/run ``` -------------------------------- ### Stations: Playlists - Clone Playlist Source: https://www.azuracast.com/api Creates a copy of a specified playlist. ```APIDOC ## POST /station/{station_id}/playlist/{id}/clone ### Description Create a copy of the specified playlist. ### Method POST ### Endpoint /station/{station_id}/playlist/{id}/clone ``` -------------------------------- ### Stations: Playlists - Apply Playlist to Directories Source: https://www.azuracast.com/api Applies a specific playlist to the specified directories. ```APIDOC ## PUT /station/{station_id}/playlist/{id}/apply-to ### Description Apply the specified playlist to the specified directories. ### Method PUT ### Endpoint /station/{station_id}/playlist/{id}/apply-to ``` -------------------------------- ### Submit WebAuthn Registration Source: https://www.azuracast.com/api Submits a new registration request for WebAuthn. ```APIDOC ## PUT /frontend/account/webauthn/register ### Description Submit a new registration request for WebAuthn. ### Method PUT ### Endpoint /frontend/account/webauthn/register ``` -------------------------------- ### Administration: Settings Endpoints Source: https://www.azuracast.com/api Endpoints for managing system settings, including listing current settings and updating settings. ```APIDOC ## GET /admin/settings ### Description List the current values of all editable system settings. ### Method GET ### Endpoint /admin/settings ``` ```APIDOC ## PUT /admin/settings ### Description Update settings to modify any settings provided. ### Method PUT ### Endpoint /admin/settings ``` -------------------------------- ### Podcast and Episode Management Source: https://www.azuracast.com/api Endpoints for retrieving podcast information, episodes, and associated media and art. ```APIDOC ## GET /station/{station_id}/podcast/{podcast_id}/art ### Description Gets the album art for a podcast. ### Method GET ### Endpoint /station/{station_id}/podcast/{podcast_id}/art ``` ```APIDOC ## GET /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art ### Description Gets the album art for a podcast episode. ### Method GET ### Endpoint /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art ``` ```APIDOC ## GET /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media ### Description Gets the media for a podcast episode. ### Method GET ### Endpoint /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media ``` ```APIDOC ## GET /station/{station_id}/public/podcast/{podcast_id} ### Description Get the public information for a given podcast. ### Method GET ### Endpoint /station/{station_id}/public/podcast/{podcast_id} ``` ```APIDOC ## GET /station/{station_id}/public/podcast/{podcast_id}/episode/{episode_id} ### Description Get information for a public episode of a public podcast. ### Method GET ### Endpoint /station/{station_id}/public/podcast/{podcast_id}/episode/{episode_id} ``` ```APIDOC ## GET /station/{station_id}/public/podcast/{podcast_id}/episodes ### Description List all visible episodes for a given podcast. ### Method GET ### Endpoint /station/{station_id}/public/podcast/{podcast_id}/episodes ``` ```APIDOC ## GET /station/{station_id}/public/podcasts ### Description List all visible public podcasts. ### Method GET ### Endpoint /station/{station_id}/public/podcasts ``` -------------------------------- ### Now Playing Information Source: https://www.azuracast.com/api Endpoints to retrieve real-time now playing data for stations, including current track, artist, and album art. ```APIDOC ## GET /nowplaying ### Description Retrieves now playing information for all stations. ### Method GET ### Endpoint /nowplaying ``` ```APIDOC ## GET /nowplaying/{station_id} ### Description Retrieves now playing information for a specific station. ### Method GET ### Endpoint /nowplaying/{station_id} ``` ```APIDOC ## GET /nowplaying/{station_id}/art ### Description Always redirects to the current album art for the given station. ### Method GET ### Endpoint /nowplaying/{station_id}/art ``` -------------------------------- ### Stations: Podcasts - Set Podcast Episode Media Source: https://www.azuracast.com/api Sets the media for a podcast episode. ```APIDOC ## POST /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media ### Description Sets the media for a podcast episode. ### Method POST ### Endpoint /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media ``` -------------------------------- ### List Storage Locations for Station Assignment Source: https://www.azuracast.com/api Lists storage locations available for assignment to a station. ```APIDOC ## GET /admin/stations/storage-locations ### Description List storage locations available for assignment to a station. ### Method GET ### Endpoint /admin/stations/storage-locations ``` -------------------------------- ### Stations: Podcasts - Retrieve Podcast Details Source: https://www.azuracast.com/api Retrieves the details for a single podcast. ```APIDOC ## GET /station/{station_id}/podcast/{id} ### Description Retrieve details for a single podcast. ### Method GET ### Endpoint /station/{station_id}/podcast/{id} ``` -------------------------------- ### Stations: Playlists - List All Playlists Source: https://www.azuracast.com/api Lists all current playlists for a station. ```APIDOC ## GET /station/{station_id}/playlists ### Description List all current playlists. ### Method GET ### Endpoint /station/{station_id}/playlists ``` -------------------------------- ### Stations: Playlists - Import Podcast Playlist Source: https://www.azuracast.com/api Imports the contents of an uploaded playlist (PLS/M3U) file into the specified playlist for a podcast. ```APIDOC ## POST /station/{station_id}/podcast/{podcast_id}/batch ### Description Import the contents of an uploaded playlist (PLS/M3U) file into the specified playlist. ### Method POST ### Endpoint /station/{station_id}/podcast/{podcast_id}/batch ``` -------------------------------- ### Stations: Podcasts - Set Podcast Art Source: https://www.azuracast.com/api Sets the album art for a podcast. ```APIDOC ## POST /station/{station_id}/podcast/{podcast_id}/art ### Description Sets the album art for a podcast. ### Method POST ### Endpoint /station/{station_id}/podcast/{podcast_id}/art ``` -------------------------------- ### Stations: Podcasts - List Podcast Episodes Source: https://www.azuracast.com/api Lists all current episodes for a given podcast ID. ```APIDOC ## GET /station/{station_id}/podcast/{podcast_id}/episodes ### Description List all current episodes for a given podcast ID. ### Method GET ### Endpoint /station/{station_id}/podcast/{podcast_id}/episodes ``` -------------------------------- ### Stations: Podcasts - Update Podcast Details Source: https://www.azuracast.com/api Updates the details of a single podcast. ```APIDOC ## PUT /station/{station_id}/podcast/{id} ### Description Update details of a single podcast. ### Method PUT ### Endpoint /station/{station_id}/podcast/{id} ``` -------------------------------- ### Register Two-Factor Authentication Method Source: https://www.azuracast.com/api Registers a new two-factor authentication method for your account. ```APIDOC ## PUT /frontend/account/two-factor ### Description Register a new two-factor authentication method. ### Method PUT ### Endpoint /frontend/account/two-factor ``` -------------------------------- ### Administration: Roles Endpoints Source: https://www.azuracast.com/api Endpoints for managing roles and permissions, including retrieving, updating, deleting, listing, and creating roles, as well as listing available permissions. ```APIDOC ## GET /admin/permissions ### Description Return a list of all available permissions. ### Method GET ### Endpoint /admin/permissions ``` ```APIDOC ## GET /admin/role/{id} ### Description Retrieve details for a single current role. ### Method GET ### Endpoint /admin/role/{id} ``` ```APIDOC ## PUT /admin/role/{id} ### Description Update details of a single role. ### Method PUT ### Endpoint /admin/role/{id} ``` ```APIDOC ## DELETE /admin/role/{id} ### Description Delete a single role. ### Method DELETE ### Endpoint /admin/role/{id} ``` ```APIDOC ## GET /admin/roles ### Description List all current roles in the system. ### Method GET ### Endpoint /admin/roles ``` ```APIDOC ## POST /admin/roles ### Description Create a new role. ### Method POST ### Endpoint /admin/roles ``` -------------------------------- ### Stations: Podcasts - Retrieve Podcast Episode Details Source: https://www.azuracast.com/api Retrieves the details for a single podcast episode. ```APIDOC ## GET /station/{station_id}/podcast/{podcast_id}/episode/{id} ### Description Retrieve details for a single podcast episode. ### Method GET ### Endpoint /station/{station_id}/podcast/{podcast_id}/episode/{id} ``` -------------------------------- ### Show Dashboard Notifications Source: https://www.azuracast.com/api Shows all notifications your current account should see. ```APIDOC ## GET /frontend/dashboard/notifications ### Description Show all notifications your current account should see. ### Method GET ### Endpoint /frontend/dashboard/notifications ``` -------------------------------- ### Station Information and Management Source: https://www.azuracast.com/api Endpoints for retrieving detailed station information, managing custom assets, and handling station profiles. ```APIDOC ## GET /station/{station_id} ### Description Return information about a single station. ### Method GET ### Endpoint /station/{station_id} ``` ```APIDOC ## GET /station/{station_id}/art/{media_id} ### Description Returns the album art for a song, or a generic image. ### Method GET ### Endpoint /station/{station_id}/art/{media_id} ``` ```APIDOC ## GET /station/{station_id}/ondemand ### Description List all tracks available on-demand for this station. ### Method GET ### Endpoint /station/{station_id}/ondemand ``` ```APIDOC ## GET /station/{station_id}/ondemand/download/{media_id} ### Description Download an on-demand playlist file by media unique ID. ### Method GET ### Endpoint /station/{station_id}/ondemand/download/{media_id} ``` ```APIDOC ## GET /station/{station_id}/profile ### Description Retrieve the profile of the given station. ### Method GET ### Endpoint /station/{station_id}/profile ``` ```APIDOC ## GET /station/{station_id}/profile/edit ### Description Get the editable profile for the current station. ### Method GET ### Endpoint /station/{station_id}/profile/edit ``` ```APIDOC ## PUT /station/{station_id}/profile/edit ### Description Save the station profile for the current station. ### Method PUT ### Endpoint /station/{station_id}/profile/edit ``` ```APIDOC ## GET /station/{station_id}/custom_assets/{type} ### Description Get the details of the custom asset of the specified type. ### Method GET ### Endpoint /station/{station_id}/custom_assets/{type} ``` ```APIDOC ## POST /station/{station_id}/custom_assets/{type} ### Description Upload a new custom asset of the specified type. ### Method POST ### Endpoint /station/{station_id}/custom_assets/{type} ``` ```APIDOC ## DELETE /station/{station_id}/custom_assets/{type} ### Description Removes the custom asset of the specified type. ### Method DELETE ### Endpoint /station/{station_id}/custom_assets/{type} ``` ```APIDOC ## GET /station/{station_id}/fallback ### Description Get the custom fallback track for a station. ### Method GET ### Endpoint /station/{station_id}/fallback ``` ```APIDOC ## POST /station/{station_id}/fallback ### Description Update the custom fallback track for the station. ### Method POST ### Endpoint /station/{station_id}/fallback ``` ```APIDOC ## DELETE /station/{station_id}/fallback ### Description Removes the custom fallback track for a station. ### Method DELETE ### Endpoint /station/{station_id}/fallback ``` ```APIDOC ## GET /station/{station_id}/log/{key} ### Description View a specific log contents for the given station. ### Method GET ### Endpoint /station/{station_id}/log/{key} ``` ```APIDOC ## GET /station/{station_id}/logs ### Description Return a list of available logs for the given station. ### Method GET ### Endpoint /station/{station_id}/logs ``` ```APIDOC ## POST /station/{station_id}/nowplaying/update ### Description Manually update the Now Playing metadata for the station. ### Method POST ### Endpoint /station/{station_id}/nowplaying/update ``` ```APIDOC ## GET /station/{station_id}/quota ### Description Get the current usage and quota for a given station storage location. ### Method GET ### Endpoint /station/{station_id}/quota ``` ```APIDOC ## GET /station/{station_id}/quota/{type} ### Description Get the current usage and quota for a given station storage location. ### Method GET ### Endpoint /station/{station_id}/quota/{type} ``` -------------------------------- ### Stations: Mount Points Source: https://www.azuracast.com/api Endpoints for managing mount points for streaming. ```APIDOC ## GET /station/{station_id}/mount/{id} ### Description Retrieve details for a single mount point. ### Method GET ### Endpoint /station/{station_id}/mount/{id} ### Parameters #### Path Parameters - **station_id** (string) - Required - The unique identifier for the station. - **id** (string) - Required - The unique identifier for the mount point. ### Stations: Mount Points ## PUT /station/{station_id}/mount/{id} ### Description Update details of a single mount point. ### Method PUT ### Endpoint /station/{station_id}/mount/{id} ### Parameters #### Path Parameters - **station_id** (string) - Required - The unique identifier for the station. - **id** (string) - Required - The unique identifier for the mount point. ### Stations: Mount Points ## DELETE /station/{station_id}/mount/{id} ### Description Delete a single mount point. ### Method DELETE ### Endpoint /station/{station_id}/mount/{id} ### Parameters #### Path Parameters - **station_id** (string) - Required - The unique identifier for the station. - **id** (string) - Required - The unique identifier for the mount point. ### Stations: Mount Points ## GET /station/{station_id}/mount/{id}/intro ### Description Get the intro track for a mount point. ### Method GET ### Endpoint /station/{station_id}/mount/{id}/intro ### Parameters #### Path Parameters - **station_id** (string) - Required - The unique identifier for the station. - **id** (string) - Required - The unique identifier for the mount point. ### Stations: Mount Points ## POST /station/{station_id}/mount/{id}/intro ### Description Update the intro track for a mount point. ### Method POST ### Endpoint /station/{station_id}/mount/{id}/intro ### Parameters #### Path Parameters - **station_id** (string) - Required - The unique identifier for the station. - **id** (string) - Required - The unique identifier for the mount point. ### Stations: Mount Points ## DELETE /station/{station_id}/mount/{id}/intro ### Description Removes the intro track for a mount point. ### Method DELETE ### Endpoint /station/{station_id}/mount/{id}/intro ### Parameters #### Path Parameters - **station_id** (string) - Required - The unique identifier for the station. - **id** (string) - Required - The unique identifier for the mount point. ### Stations: Mount Points ## GET /station/{station_id}/mounts ### Description List all current mount points. ### Method GET ### Endpoint /station/{station_id}/mounts ### Parameters #### Path Parameters - **station_id** (string) - Required - The unique identifier for the station. ### Stations: Mount Points ## POST /station/{station_id}/mounts ### Description Create a new mount point. ### Method POST ### Endpoint /station/{station_id}/mounts ### Parameters #### Path Parameters - **station_id** (string) - Required - The unique identifier for the station. ``` -------------------------------- ### Stations: Web Hooks Source: https://www.azuracast.com/api Endpoints for managing web hooks for a station, including retrieval, update, deletion, testing, and creation. ```APIDOC ## GET /station/{station_id}/webhook/{id} ### Description Retrieve details for a single web hook. ### Method GET ### Endpoint /station/{station_id}/webhook/{id} ## PUT /station/{station_id}/webhook/{id} ### Description Update details of a single web hook. ### Method PUT ### Endpoint /station/{station_id}/webhook/{id} ## DELETE /station/{station_id}/webhook/{id} ### Description Delete a single web hook. ### Method DELETE ### Endpoint /station/{station_id}/webhook/{id} ## POST /station/{station_id}/webhook/{id}/clone ### Description Duplicate a single web hook. ### Method POST ### Endpoint /station/{station_id}/webhook/{id}/clone ## PUT /station/{station_id}/webhook/{id}/test ### Description Send a test dispatch of a webhook with the current Now Playing data for the station. ### Method PUT ### Endpoint /station/{station_id}/webhook/{id}/test ## PUT /station/{station_id}/webhook/{id}/toggle ### Description Toggle the enabled/disabled status of a webhook. ### Method PUT ### Endpoint /station/{station_id}/webhook/{id}/toggle ## GET /station/{station_id}/webhooks ### Description List all current web hooks. ### Method GET ### Endpoint /station/{station_id}/webhooks ## POST /station/{station_id}/webhooks ### Description Create a new web hook. ### Method POST ### Endpoint /station/{station_id}/webhooks ## GET /station/{station_id}/webhooks/{id}/test-log/{path} ### Description View a specific webhook test dispatch log contents. ### Method GET ### Endpoint /station/{station_id}/webhooks/{id}/test-log/{path} ``` -------------------------------- ### Stations: Podcasts - Set Podcast Episode Art Source: https://www.azuracast.com/api Sets the album art for a podcast episode. ```APIDOC ## POST /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art ### Description Sets the album art for a podcast episode. ### Method POST ### Endpoint /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art ``` -------------------------------- ### Administration: Users Endpoints Source: https://www.azuracast.com/api Endpoints for managing users, including login tokens and user accounts. Operations include retrieving, creating, updating, and deleting login tokens and user details. ```APIDOC ## GET /admin/login_token/{id} ### Description Retrieve details for a single login token. ### Method GET ### Endpoint /admin/login_token/{id} ``` ```APIDOC ## DELETE /admin/login_token/{id} ### Description Delete a single login token. ### Method DELETE ### Endpoint /admin/login_token/{id} ``` ```APIDOC ## GET /admin/login_tokens ### Description List all current unexpired login tokens in the system. ### Method GET ### Endpoint /admin/login_tokens ``` ```APIDOC ## POST /admin/login_tokens ### Description Create a new login token. ### Method POST ### Endpoint /admin/login_tokens ``` ```APIDOC ## GET /admin/user/{id} ### Description Retrieve details for a single current user. ### Method GET ### Endpoint /admin/user/{id} ``` ```APIDOC ## PUT /admin/user/{id} ### Description Update details of a single user. ### Method PUT ### Endpoint /admin/user/{id} ``` ```APIDOC ## DELETE /admin/user/{id} ### Description Delete a single user. ### Method DELETE ### Endpoint /admin/user/{id} ``` ```APIDOC ## GET /admin/users ### Description List all current users in the system. ### Method GET ### Endpoint /admin/users ``` ```APIDOC ## POST /admin/users ### Description Create a new user. ### Method POST ### Endpoint /admin/users ``` -------------------------------- ### General API Information Source: https://www.azuracast.com/api Endpoints for retrieving API specifications, status, and time. ```APIDOC ## GET /openapi.yml ### Description Returns the OpenAPI specification document for this installation. ### Method GET ### Endpoint /openapi.yml ``` ```APIDOC ## GET /status ### Description Returns an affirmative response if the API is active. ### Method GET ### Endpoint /status ``` ```APIDOC ## GET /time ### Description Returns the current server time. ### Method GET ### Endpoint /time ``` -------------------------------- ### Clone Station Source: https://www.azuracast.com/api Clones a station, preserving certain settings, using its ID. ```APIDOC ## POST /admin/station/{id}/clone ### Description Clone a station, preserving certain settings. ### Method POST ### Endpoint /admin/station/{id}/clone ``` -------------------------------- ### Stations: Podcasts - Update Podcast Episode Details Source: https://www.azuracast.com/api Updates the details of a single podcast episode. ```APIDOC ## PUT /station/{station_id}/podcast/{podcast_id}/episode/{id} ### Description Update details of a single podcast episode. ### Method PUT ### Endpoint /station/{station_id}/podcast/{podcast_id}/episode/{id} ``` -------------------------------- ### Stations: Podcasts - Remove Podcast Art Source: https://www.azuracast.com/api Removes the album art for a podcast. ```APIDOC ## DELETE /station/{station_id}/podcast/{podcast_id}/art ### Description Removes the album art for a podcast. ### Method DELETE ### Endpoint /station/{station_id}/podcast/{podcast_id}/art ``` -------------------------------- ### Retrieve API Key Details Source: https://www.azuracast.com/api Retrieves the details for a specific API key associated with your account using its ID. ```APIDOC ## GET /frontend/account/api-key/{id} ### Description Retrieve details for a single API key. ### Method GET ### Endpoint /frontend/account/api-key/{id} ``` -------------------------------- ### Stations: SFTP Users Source: https://www.azuracast.com/api Endpoints for managing SFTP user accounts associated with a station, including retrieval, update, deletion, and creation. ```APIDOC ## GET /station/{station_id}/sftp-user/{id} ### Description Retrieve details for a single SFTP user. ### Method GET ### Endpoint /station/{station_id}/sftp-user/{id} ## PUT /station/{station_id}/sftp-user/{id} ### Description Update details of a single SFTP user. ### Method PUT ### Endpoint /station/{station_id}/sftp-user/{id} ## DELETE /station/{station_id}/sftp-user/{id} ### Description Delete a single SFTP user. ### Method DELETE ### Endpoint /station/{station_id}/sftp-user/{id} ## GET /station/{station_id}/sftp-users ### Description List all current SFTP users. ### Method GET ### Endpoint /station/{station_id}/sftp-users ## POST /station/{station_id}/sftp-users ### Description Create a new SFTP user. ### Method POST ### Endpoint /station/{station_id}/sftp-users ``` -------------------------------- ### Station Listing Source: https://www.azuracast.com/api Endpoint to retrieve a list of all available stations. ```APIDOC ## GET /stations ### Description Returns a list of stations. ### Method GET ### Endpoint /stations ``` -------------------------------- ### Administration: General Endpoints Source: https://www.azuracast.com/api Endpoints for general administration tasks such as managing ACME certificates, API keys, audit logs, custom assets, GeoLite databases, logs, relays, RSAS, sending test emails, server statistics, and services. ```APIDOC ## PUT /admin/acme ### Description Generate or renew ACME certificate. ### Method PUT ### Endpoint /admin/acme ``` ```APIDOC ## GET /admin/acme-log/{path} ### Description View the logs of a manually run ACME certificate renewal. ### Method GET ### Endpoint /admin/acme-log/{path} ``` ```APIDOC ## DELETE /admin/api-key/{id} ### Description Delete a single API key. ### Method DELETE ### Endpoint /admin/api-key/{id} ``` ```APIDOC ## GET /admin/api-keys ### Description List all current API keys across the system. ### Method GET ### Endpoint /admin/api-keys ``` ```APIDOC ## POST /admin/api-keys ### Description Create a new API key for a specified user. ### Method POST ### Endpoint /admin/api-keys ``` ```APIDOC ## GET /admin/auditlog ### Description List all Audit Log actions that have taken place on the installation. ### Method GET ### Endpoint /admin/auditlog ``` ```APIDOC ## GET /admin/custom_assets/{type} ### Description Get the details of the custom asset of the specified type. ### Method GET ### Endpoint /admin/custom_assets/{type} ``` ```APIDOC ## POST /admin/custom_assets/{type} ### Description Upload a new custom asset of the specified type. ### Method POST ### Endpoint /admin/custom_assets/{type} ``` ```APIDOC ## DELETE /admin/custom_assets/{type} ### Description Removes the custom asset of the specified type. ### Method DELETE ### Endpoint /admin/custom_assets/{type} ``` ```APIDOC ## GET /admin/geolite ### Description Get the current MaxMindDB GeoLite Database status. ### Method GET ### Endpoint /admin/geolite ``` ```APIDOC ## POST /admin/geolite ### Description Set the GeoLite MaxMindDB Database license key. ### Method POST ### Endpoint /admin/geolite ``` ```APIDOC ## GET /admin/log/{key} ### Description View a specific log contents. ### Method GET ### Endpoint /admin/log/{key} ``` ```APIDOC ## GET /admin/logs ### Description List all available log types for viewing. ### Method GET ### Endpoint /admin/logs ``` ```APIDOC ## GET /admin/relays/list ### Description Return a list of all currently active AzuraRelay instances. ### Method GET ### Endpoint /admin/relays/list ``` ```APIDOC ## GET /admin/rsas ### Description Get the current Rocket Streaming Audio Server (RSAS) status. ### Method GET ### Endpoint /admin/rsas ``` ```APIDOC ## POST /admin/rsas ### Description Upload a new Rocket Streaming Audio Server (RSAS) binary. ### Method POST ### Endpoint /admin/rsas ``` ```APIDOC ## DELETE /admin/rsas ### Description Removes the Rocket Streaming Audio Server (RSAS) installation. ### Method DELETE ### Endpoint /admin/rsas ``` ```APIDOC ## POST /admin/rsas/license ### Description Upload a new Rocket Streaming Audio Server (RSAS) license key. ### Method POST ### Endpoint /admin/rsas/license ``` ```APIDOC ## DELETE /admin/rsas/license ### Description Removes the Rocket Streaming Audio Server (RSAS) license. ### Method DELETE ### Endpoint /admin/rsas/license ``` ```APIDOC ## POST /admin/send-test-message ### Description Send a test e-mail to confirm mail delivery settings. ### Method POST ### Endpoint /admin/send-test-message ``` ```APIDOC ## GET /admin/server/stats ### Description Return a list of all CPU usage stats. ### Method GET ### Endpoint /admin/server/stats ``` ```APIDOC ## GET /admin/services ### Description List the status of essential system services. ### Method GET ### Endpoint /admin/services ``` ```APIDOC ## POST /admin/services/restart/{service} ### Description Restart the specified service. ### Method POST ### Endpoint /admin/services/restart/{service} ``` ```APIDOC ## GET /admin/shoutcast ### Description Get details about the Shoutcast installation. ### Method GET ### Endpoint /admin/shoutcast ``` ```APIDOC ## POST /admin/shoutcast ### Description Upload a new Shoutcast binary. ### Method POST ### Endpoint /admin/shoutcast ``` ```APIDOC ## DELETE /admin/shoutcast ### Description Removes the installed Shoutcast binary. ### Method DELETE ### Endpoint /admin/shoutcast ``` ```APIDOC ## GET /admin/stereo_tool ### Description Get information about the Stereo Tool installation. ### Method GET ### Endpoint /admin/stereo_tool ``` ```APIDOC ## POST /admin/stereo_tool ### Description Upload a new Stereo Tool binary. ### Method POST ### Endpoint /admin/stereo_tool ``` ```APIDOC ## DELETE /admin/stereo_tool ### Description Removes the installed Stereo Tool binary. ### Method DELETE ### Endpoint /admin/stereo_tool ``` ```APIDOC ## GET /admin/updates ### Description Show information about this installation and its update status. ### Method GET ### Endpoint /admin/updates ``` ```APIDOC ## PUT /admin/updates ### Description Attempts to trigger a web-based update. ### Method PUT ### Endpoint /admin/updates ``` -------------------------------- ### Stations: Remote Relays - List All Remote Relays Source: https://www.azuracast.com/api Lists all current remote relays for a station. ```APIDOC ## GET /station/{station_id}/remotes ### Description List all current remote relays. ### Method GET ### Endpoint /station/{station_id}/remotes ``` -------------------------------- ### Stations: Playlists - Import Playlist Source: https://www.azuracast.com/api Imports the contents of an uploaded playlist file (PLS/M3U) into the specified playlist. ```APIDOC ## POST /station/{station_id}/playlist/{id}/import ### Description Import the contents of an uploaded playlist (PLS/M3U) file into the specified playlist. ### Method POST ### Endpoint /station/{station_id}/playlist/{id}/import ``` -------------------------------- ### Retrieve Storage Location Details Source: https://www.azuracast.com/api Retrieves the details for a specific storage location using its ID. ```APIDOC ## GET /admin/storage_location/{id} ### Description Retrieve details for a single storage location. ### Method GET ### Endpoint /admin/storage_location/{id} ``` -------------------------------- ### List Dashboard Stations Source: https://www.azuracast.com/api Lists stations that can be managed by the current user account on the dashboard. ```APIDOC ## GET /frontend/dashboard/stations ### Description List stations that can be managed by the current user account on the dashboard. ### Method GET ### Endpoint /frontend/dashboard/stations ``` -------------------------------- ### Song Requests Source: https://www.azuracast.com/api Endpoints for submitting song requests and retrieving a list of requestable songs. ```APIDOC ## POST /station/{station_id}/request/{request_id} ### Description Submit a song request. ### Method POST ### Endpoint /station/{station_id}/request/{request_id} ``` ```APIDOC ## GET /station/{station_id}/requests ### Description Return a list of requestable songs. ### Method GET ### Endpoint /station/{station_id}/requests ``` -------------------------------- ### Stations: Playlists - Set Playlist Order Source: https://www.azuracast.com/api Sets the order of sequential tracks in the specified playlist. ```APIDOC ## PUT /station/{station_id}/playlist/{id}/order ### Description Set the order of sequential tracks in the specified playlist. ### Method PUT ### Endpoint /station/{station_id}/playlist/{id}/order ``` -------------------------------- ### Stations: Remote Relays - Create New Remote Relay Source: https://www.azuracast.com/api Creates a new remote relay for a station. ```APIDOC ## POST /station/{station_id}/remotes ### Description Create a new remote relay. ### Method POST ### Endpoint /station/{station_id}/remotes ``` -------------------------------- ### Stations: Reports Source: https://www.azuracast.com/api Endpoints for retrieving and managing song playback history, listener information, and various performance reports for a station. ```APIDOC ## GET /station/{station_id}/history ### Description Return song playback history items for a given station. ### Method GET ### Endpoint /station/{station_id}/history ## GET /station/{station_id}/listeners ### Description Return detailed information about current listeners. ### Method GET ### Endpoint /station/{station_id}/listeners ## GET /station/{station_id}/reports/overview/best-and-worst ### Description Get the "Best and Worst Performing Songs" report for a station. ### Method GET ### Endpoint /station/{station_id}/reports/overview/best-and-worst ## GET /station/{station_id}/reports/overview/by-browser ### Description Get the "Listeners by Browser" report for a station. ### Method GET ### Endpoint /station/{station_id}/reports/overview/by-browser ## GET /station/{station_id}/reports/overview/by-client ### Description Get the "Listeners by Client" report for a station. ### Method GET ### Endpoint /station/{station_id}/reports/overview/by-client ## GET /station/{station_id}/reports/overview/by-country ### Description Get the "Listeners by Country" report for a station. ### Method GET ### Endpoint /station/{station_id}/reports/overview/by-country ## GET /station/{station_id}/reports/overview/by-listening-time ### Description Get the "Listeners by Listening Time" report for a station. ### Method GET ### Endpoint /station/{station_id}/reports/overview/by-listening-time ## GET /station/{station_id}/reports/overview/by-stream ### Description Get the "Listeners by Stream" report for a station. ### Method GET ### Endpoint /station/{station_id}/reports/overview/by-stream ## GET /station/{station_id}/reports/overview/charts ### Description Get chart data for the station reports. ### Method GET ### Endpoint /station/{station_id}/reports/overview/charts ## GET /station/{station_id}/reports/requests ### Description List station requests. ### Method GET ### Endpoint /station/{station_id}/reports/requests ## DELETE /station/{station_id}/reports/requests/{request_id} ### Description Delete an individual station request. ### Method DELETE ### Endpoint /station/{station_id}/reports/requests/{request_id} ## POST /station/{station_id}/reports/requests/clear ### Description Clear all unplayed station requests. ### Method POST ### Endpoint /station/{station_id}/reports/requests/clear ## GET /station/{station_id}/reports/soundexchange ### Description Generate a SoundExchange royalty report. ### Method GET ### Endpoint /station/{station_id}/reports/soundexchange ``` -------------------------------- ### Save Account Changes Source: https://www.azuracast.com/api Saves changes to your logged-in account. ```APIDOC ## PUT /frontend/account/me ### Description Save changes to your logged in account. ### Method PUT ### Endpoint /frontend/account/me ``` -------------------------------- ### Administration: Debugging Endpoints Source: https://www.azuracast.com/api Endpoints for debugging purposes, including clearing cache, clearing message queues, listing queues, clearing station song queues, generating next songs, generating now playing data, and running Telnet commands. ```APIDOC ## PUT /admin/debug/clear-cache ### Description Clear the application cache (Redis). ### Method PUT ### Endpoint /admin/debug/clear-cache ``` ```APIDOC ## PUT /admin/debug/clear-queue/{queue} ### Description Clear the specified message queue. ### Method PUT ### Endpoint /admin/debug/clear-queue/{queue} ``` ```APIDOC ## GET /admin/debug/queues ### Description List all message queues. ### Method GET ### Endpoint /admin/debug/queues ``` ```APIDOC ## PUT /admin/debug/station/{station_id}/clearqueue ### Description Clear the upcoming song queue and generate a new one. ### Method PUT ### Endpoint /admin/debug/station/{station_id}/clearqueue ``` ```APIDOC ## PUT /admin/debug/station/{station_id}/nextsong ### Description Get the next song to be played by the AutoDJ for a given station. ### Method PUT ### Endpoint /admin/debug/station/{station_id}/nextsong ``` ```APIDOC ## PUT /admin/debug/station/{station_id}/nowplaying ### Description Generate the raw Now Playing data for a given station. ### Method PUT ### Endpoint /admin/debug/station/{station_id}/nowplaying ``` ```APIDOC ## PUT /admin/debug/station/{station_id}/telnet ### Description Manually run a Telnet command on a station backend. ### Method PUT ### Endpoint /admin/debug/station/{station_id}/telnet ``` ```APIDOC ## GET /admin/debug/stations ### Description List all stations with their debug links. ### Method GET ### Endpoint /admin/debug/stations ``` ```APIDOC ## GET /admin/debug/sync-tasks ### Description List all sync tasks and details about their run times. ### Method GET ### Endpoint /admin/debug/sync-tasks ``` ```APIDOC ## PUT /admin/debug/sync/{task} ### Description Manually run a scheduled synchronized task by name. ### Method PUT ### Endpoint /admin/debug/sync/{task} ``` -------------------------------- ### Retrieve Station Details Source: https://www.azuracast.com/api Retrieves the details for a specific station using its ID. ```APIDOC ## GET /admin/station/{id} ### Description Retrieve details for a single station. ### Method GET ### Endpoint /admin/station/{id} ``` -------------------------------- ### Schedule and Streamer Information Source: https://www.azuracast.com/api Endpoints for retrieving schedule entries and streamer art. ```APIDOC ## GET /station/{station_id}/schedule ### Description Return upcoming and currently ongoing schedule entries. ### Method GET ### Endpoint /station/{station_id}/schedule ``` ```APIDOC ## GET /station/{station_id}/streamer/{id}/art ### Description Gets the default album art for a streamer. ### Method GET ### Endpoint /station/{station_id}/streamer/{id}/art ```