{ "version": 1, "name": "AzuraCast", "documents": [ { "id": "index.md", "kind": "page", "title": "About AzuraCast", "description": "Learn about AzuraCast", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/index.md", "file": "index.md", "searchText": "\n\n> [!TIP]\n> **AzuraCast is currently in beta!**\n>\n> Many web radio stations already run AzuraCast, but keeping your server up-to-date with the latest code from the GitHub repository is strongly recommended for security, bug fixes and new feature releases. It's unlikely, but updates may result in unexpected issues or data loss, so always make sure to keep your station's media files backed up in a second location.\n>\n> To install AzuraCast, you should have a basic understanding of the Linux shell terminal. Once installed, every aspect of your radio station can be managed via AzuraCast's web interface.\n\n\n\n![](https://img.shields.io/packagist/v/azuracast/azuracast.svg?label=latest+stable+version&style=for-the-badge)\n\n**AzuraCast** is a self-hosted, all-in-one web radio management suite. Using its easy installer and powerful but intuitive web interface, you can start up a fully working web radio station in a few quick minutes.\n\nAzuraCast works for web radio stations of all types and sizes, and is built to run on even the most affordable VPS web hosts.\n\n\n## Where to start {#where-to-start}\n\n\n\n\n\n\n\n\n**[Install AzuraCast](/docs/getting-started/installation/)**\n\nSet up a server with Docker, Ansible, Synology or Windows.\n\n\n\n\n\n\n**[Run your station](/docs/user-guide/station-management/)**\n\nAdd media, build playlists and go live with DJs.\n\n\n\n\n\n\n**[Administer the server](/docs/administration/docker/)**\n\nCertificates, storage, backups, users and roles.\n\n\n\n\n\n\n**[Automate with the API](/docs/api/)**\n\nEvery station, media and admin action, with its fields and examples.\n\n\n\n\n\n\n**[Fix a problem](/docs/help/troubleshooting/)**\n\nLogs, performance tuning and how to report a bug.\n\n\n\n\n\n\n**[Contribute](/docs/contribute/donate/)**\n\nDonate, translate or suggest a feature.\n\n\n\n\n\n\n## Core Features {#core-features}\n\n\n\n### For Radio Stations {#for-radio-stations}\n\n\n- **Rich Media Management:** Upload songs, edit metadata, preview songs and organize music into folders from your browser.\n- **Playlists:** Add music to standard-rotation playlists (in sequential or shuffled playback order) or schedule a playlist to play at a scheduled time, or once per x songs/minutes/etc.\n- **Live DJs:** Set up individual DJ/streamer accounts and see who's currently streaming from your station's profile page.\n- **Web DJ:** Broadcast live directly from your browser, with no extra software needed, with AzuraCast's built-in Web DJ tool.\n- **Public Pages:** AzuraCast includes embeddable public pages that you can integrate into your existing web page or use as the basis for your own customized player.\n- **Listener Requests:** Let your listeners request specific songs from your playlists, both via an API and a simple public-facing listener page.\n- **Remote Relays:** Broadcast your radio signal (including live DJs) to any remote server running Icecast or Shoutcast.\n- **Web Hooks:** Integrate your station with Slack, Discord, TuneIn, Twitter and more by setting up web hooks that connect to third-party services.\n- **Detailed Analytics and Reports:** Keep track of every aspect of your station's listeners over time. View reports of each song's impact on your listener count. You can also generate a report that's compatible with SoundExchange for US web radio royalties.\n\n\n### For Server Administrators {#for-server-administrators}\n\n\n- **Role-based User Management:** Assign global and per-station permissions to a role, then add users to those roles to control access.\n- **Custom Branding:** Modify every aspect of both the internal and public-facing AzuraCast pages by supplying your own custom CSS and JavaScript.\n- **Authenticated RESTful API:** Individual users in the system can create API keys which have the same permissions they have in the system. The AzuraCast API is a powerful and [well-documented](/docs/api/) tool for interacting with installations.\n- **Web Log Viewing:** Quickly diagnose problems affecting any part of the AzuraCast system through the system-wide web log viewer.\n- **Automatic Radio Proxies:** Many users can't connect directly to radio station ports (i.e. 8000) by default, so AzuraCast includes an automatic nginx proxy that lets listeners connect via the http (80) and https (443) ports. These proxies are also compatible with services like CloudFlare.\n- **Storage Location Management:** Station media, live recordings and backups can be stored localy or on an S3 compatible storage provider.\n\n\n## What's Included {#whats-included}\n\n\nAzuraCast will automatically retrieve and install these components for you:\n\n\n### Radio Software {#radio-software}\n\n\n* **[Liquidsoap](https://www.liquidsoap.info/)** as the always-playing \"AutoDJ\"\n* **[Icecast-KH](https://icecast.org/)** as a radio broadcasting frontend\n\nFor x86/x64 installations, [Shoutcast 2 DNAS](http://wiki.shoutcast.com/wiki/SHOUTcast_DNAS_Server_2) can also be used as a broadcasting frontend. Shoutcast is non-free software and does not come bundled with AzuraCast, but can be installed via the administration panel after AzuraCast has been installed.\n\n\n### Supporting Software {#supporting-software}\n\n\n* **[NGINX](https://www.nginx.com)** for serving web pages and the radio proxy\n* **[MariaDB](https://mariadb.org/)** as the primary database\n* **[PHP](https://secure.php.net/)** powering the web application\n* **[Redis](https://redis.io/)** for sessions, message queue storage, database and general caching\n* **[Centrifugo](https://centrifugal.dev/)** for high-performance \"Now Playing\" data feeds\n\n\n## AzuraCast API {#azuracast-api}\n\n\nOnce installed and running, AzuraCast exposes a REST API that allows you to monitor and interact with your stations. Documentation about this API and its endpoints are available on the [AzuraCast API Documentation](/docs/api/).\n\nAll of AzuraCast's frontend actions are performed through the API, so through API calls, you can manage your station(s) entirely via the API.\n\n\n## License {#license}\n\n\nAzuraCast is licensed under the [Affero GNU General Public License (GPL), version 3.0](https://github.com/AzuraCast/AzuraCast/blob/main/LICENSE.md). This project is free and open-source software, and pull requests are always welcome\n\n\n## Friends of AzuraCast {#friends-of-azuracast}\n\n\nWe would like to thank the following organizations for their support of AzuraCast's ongoing development:\n\n- [JetBrains](https://www.jetbrains.com/) For making our development faster, easier and more productive with tools like PhpStorm\n- [CrowdIn](https://crowdin.com/) For giving us a simple and powerful tool to help translate our application for users around the world\n- [BrowserStack](https://www.browserstack.com/) For providing us a tool that allows us to test across multiple browsers in one place\n- [Depot](https://depot.dev/?utm_source=AzuraCast) for powering our Docker image builds.\n\n...and the creators and maintainers of the many free and open-source tools that AzuraCast is built on, who have done so much to help move FOSS forward!\n", "documentId": "index", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/index.md" } ] }, { "id": "live-demo/index.md", "kind": "page", "title": "Live Demo", "description": "Live demonstration of AzuraCast", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/live-demo/", "markdown": "https://sourcey-azuracast.pages.dev/docs/live-demo/index.md", "file": "live-demo/index.md", "searchText": "Want to see AzuraCast for yourself?\n\nWe have a demo site with a small AzuraCast installation and a single radio station, where you can see the basics of the AzuraCast web interface in action.\n\n\n\n\n\n**[AzuraCast Demo](https://demo.azuracast.com/)**\n\n\n\n\n\n - **Username:** `demo@azuracast.com`\n - **Password:** `demo`\n\n\n\n> [!TIP]\n> **Refreshing? Check back soon!**\n>\n> The AzuraCast demo instance automatically resets at the top of every hour to a fresh copy. If you try to access the demo site at exactly the top of the hour, you may be automatically redirected back to our website; just try again in a minute or two.\n\n\n", "documentId": "live-demo", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/live-demo/", "markdown": "https://sourcey-azuracast.pages.dev/docs/live-demo/index.md" } ] }, { "id": "getting-started/requirements/index.md", "kind": "page", "title": "Requirements", "description": "This page tells you what is required to run AzuraCast", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/requirements/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/requirements/index.md", "file": "getting-started/requirements/index.md", "searchText": "AzuraCast is powered by Docker and uses pre-built images that contain every component of the software. Don't worry if you aren't very familiar with Docker; our easy installer tools will handle installing Docker and Docker Compose for you, and updates are very simple.\n\n\n\n> [!CAUTION]\n> **A general disclaimer...**\n>\n> AzuraCast does not ensure, and is not liable for, music licenses and royalties paid to creators. Copyright and royalty laws vary widely from country to country around the world, and you will need to follow the appropriate laws for your location. If in doubt, consult with an attorney.\n\n\n\n\n## 🖥️ System Requirements {#️-system-requirements}\n\n\n\n### Minimum Requirements {#minimum-requirements}\n\n\n- A 64-bit x86 (x86_64/amd64) or ARM64 CPU\n- at least 2GB of RAM\n- 20GB or greater of hard drive space\n- A computer/server capable of running Docker\n\nFor Linux hosts, the `sudo`, `curl` and `git` packages should be installed before installing AzuraCast. Most Linux distributions include these packages already. This is the barest of minimum to run AzuraCast, there's no guarantees it will run perfectly.\n\n\n### Recommended Requirements {#recommended-requirements}\n\n\n- 4 CPU cores\n- 4GB of ram\n- 40 GB or greater of hard drive space\n- A computer/server capable of running Docker\n\nRecommeneded Requirements should allow you to run a few stations with ease, this is aimed for hobby usage (5 to 10 stations). [If you wish to increase the memory even further, consult this guide on Swap Space](https://www.digitalocean.com/community/tutorials/how-to-add-swap-space-on-ubuntu-20-04)\n\n\n## 📀 Operating System {#-operating-system}\n\n\n\n\n> [!TIP]\n> Regardless of which OS you choose, to avoid any compatibility or permissions issues you should install AzuraCast on a fresh minimal installation without Docker or Docker Compose installed.\n\n\n\nWe strongly recommend one of the following distributions and versions for your AzuraCast installation:\n\n- Ubuntu 22.04 LTS (Docker only)\n- Ubuntu 20.04 LTS (Ansible / Docker)\n- Ubuntu 18.04 LTS (Docker only)\n- Debian 10 \"Buster\" (Ansible / Docker)\n- Debian 9 \"Stretch\" (Ansible / Docker)\n- MacOS - Using Docker Desktop\n\n- Windows 10 - Using Docker Desktop + WSL2\n- Windows 11 - Using Docker Desktop + WSL2\n\n\n## ⚠️ Known Incompatibilities {#️-known-incompatibilities}\n\n\n- **OpenVZ or LXC-based Web Hosts:**\n\n - Some hosting providers use OpenVZ or LXC, and sometimes these technologies are incompatible with Docker. If the Docker installation does not work on your host, you should consider using a different server for AzuraCast, or you can use the unsupported Ansible installation method.\n\n- **CentOS:**\n - Recent versions of CentOS are moving away from supporting Docker and instead supporting Podman, a different container-based solution. AzuraCast does not currently support being deployed on Podman. If you are selecting a Linux OS for your server, the LTS distributions of Ubuntu and Debian are strongly recommended.\n \n- **MacOS incompatabilities with M1 CPUs:**\n - Apple's flagship chip, the M1, is not fully compatable with AzuraCast and the Docker Desktop due to incompatabilities with processor architecture. We'll review this in the future to see if there's any workarounds.\n \n\n## 📊 Resource Usage {#-resource-usage}\n\n\nOn the Administration page you can find a basic `Server Status` section that shows you the `CPU Load`, `Memory` and `Disk Space` usage of your server.\n\n\n### Icecast {#icecast}\n\n\nFor Icecast you can find some benchmarks for the following topics at https://icecast.org/loadtest/\n\n- [Testing the maximum numbers of connected listeners](https://icecast.org/loadtest/1/)\n- [Testing the maximum numbers of connected sources](https://icecast.org/loadtest/2/)\n- [Icecast/Shoutcast comparsion](https://icecast.org/loadtest/3/)\n", "documentId": "getting-started/requirements", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/requirements/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/requirements/index.md" } ] }, { "id": "getting-started/installation/index.md", "kind": "page", "title": "Install AzuraCast", "description": "How to install AzuraCast on your server", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/index.md", "file": "getting-started/installation/index.md", "searchText": "\n\n> [!TIP]\n> **Did you know?**\n>\n> AzuraCast is completely free for you to install and use, even for commercial purposes. We're a small team, and we depend on donations to support our work.\n>\n> If you enjoy it, please consider [donating](/docs/contribute/donate/) to support us. We are a small team building a very big application, so your support is very important to us.\n\n\n\nAzuraCast is server-based software that is installed on a VPS, dedicated server or other computer and serves both your station broadcasts and its own web interface through the server's network connection.\n\nYou can also install AzuraCast yourself on most server hardware and many computers running Linux.\n\n\n## One-Click Installers {#one-click-installers}\n\n\nThe easiest way to get started with AzuraCast is to create a new VPS with one of our supported partners via the options below.\n\n\n\n\n\n\n**Linode (Akamai)**\n\nDeploy a new Linode instance with the AzuraCast one-click installer in the Linode Marketplace.\n\n\n\n\n\n**[Linode AzuraCast One-Click Image](https://www.linode.com/marketplace/apps/linode/azuracast/)**\n\n\n\n\n\n\n\n\n\n\n**Vultr**\n\nDeploy a new Vultr VPS with the one-click installer on the Vultr marketplace.\n\n\n\n\n\n**[AzuraCast on Vultr](https://www.vultr.com/marketplace/apps/azuracast?slug=azuracast#support)**\n\n\n\n\n\n\n\n\n\n\n**DigitalOcean**\n\nCreate a new droplet based on our one-click installer from the AzuraCast listing on the DigitalOcean Marketplace.\n\n\n\n\n\n**[DigitalOcean AzuraCast One-Click Image](https://marketplace.digitalocean.com/apps/azuracast)**\n\n\n\n\n\n\n\n\n\n\n## Self-Hosted Installation {#self-hosted-installation}\n\n\n\n\n> [!TIP]\n> **Before you begin...**\n>\n> Installing AzuraCast yourself requires a basic understanding of the Linux shell/terminal environment, as well as root (or \"sudo\") access to the computer you're installing AzuraCast on.\n\n\n\n\n### 🐋 Docker (Recommended) {#-docker-recommended}\n\n\n**Docker installation now supports ARM64 devices as well (i.e. newer Raspbery Pi devices, and ARM64-based cloud hosts), so you can follow these same installation steps.**\n\nFor a majority of users, our Docker installation method is the preferred way of installing and using AzuraCast. Click the link below for Docker installation instructions.\n\n\n\n\n\n**[Install AzuraCast with Docker](/docs/getting-started/installation/docker/)**\n\n\n\n\n\n\n### Docker App Installers {#docker-app-installers}\n\n\nAzuraCast is also available via Docker-based app installer tools. These tools let you install AzuraCast alongside other Docker images in a simple visual manner.\n\n\n\n\n\n**[DockSTARTer](https://dockstarter.com/apps/azuracast/)**\n\n\n\n\n\n\n\n\n\n**[CapRover](https://caprover.com/docs/one-click-apps.html)**\n\n\n\n\n\n\n\n### Windows 10/11 (WSL2) {#windows-1011-wsl2}\n\n\nIf you're looking to install AzuraCast on your Windows installation, this is now possible thanks to the Windows Subsystem for Linux (WSL2). Follow our Windows-specific guide for tips on how to get AzuraCast up and running easily on a Windows computer.\n\n\n\n\n\n**[Installing on Windows with WSL](/docs/getting-started/installation/windows/)**\n\n\n\n\n\n\n### Synology NAS {#synology-nas}\n\n\nInstalling AzuraCast on a Synology NAS involves specific steps, so we've created a unique guide for installation on this platform.\n\nNote: This guide is intended for X86/AMD64-based Synology NAS devices only. Devices running ARM processors are not officially supported.\n\n\n\n\n\n**[Installing on a Synology NAS](/docs/getting-started/installation/synology/)**\n\n\n\n\n", "documentId": "getting-started/installation", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/index.md" } ] }, { "id": "getting-started/installation/docker/index.md", "kind": "page", "title": "Install AzuraCast with Docker", "description": "AzuraCast is powered by Docker and uses pre-built images that contain every component of the software. Don't worry if you aren't very familiar with Docker; our easy installer tools will handle installing Docker and Docker Compose for you, and updates are very simple.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/docker/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/docker/index.md", "file": "getting-started/installation/docker/index.md", "searchText": "AzuraCast is powered by Docker and uses pre-built images that contain every component of the software. Don't worry if you aren't very familiar with Docker; our easy installer tools will handle installing Docker and Docker Compose for you, and updates are very simple.\n\n\n## System Requirements {#system-requirements}\n\n\nPlease check the page with the [AzuraCast system requirements](/docs/getting-started/requirements/) before installing to make sure your server meets the minimum requirements.\n\n\n## Installing {#installing}\n\n\nConnect to the server or computer you want to install AzuraCast on via an SSH terminal. You should be an administrator user with either root access or the ability to use the `sudo` command. If you are not the root user, you may need to run `sudo su -` before executing the commands below.\n\nPick a base directory on your host computer that AzuraCast can use. If you're on Linux, you can follow the steps below to use the recommended directory:\n\n```bash\nmkdir -p /var/azuracast\ncd /var/azuracast\n```\n\nUse these commands to download our Docker Utility Script, set it as executable and then run the Docker installation process:\n\n```bash\ncurl -fsSL https://raw.githubusercontent.com/AzuraCast/AzuraCast/main/docker.sh > docker.sh\nchmod a+x docker.sh\n./docker.sh install\n```\n\nOn-screen prompts will show you how the installation is progressing.\n\n\n\n> [!TIP]\n> **You're almost ready...**\n>\n> Once installation has completed, be sure to open the URL to your AzuraCast installation in your browser to create your super administrator account and finish the initial setup.\n\n\n\n\n### Troubleshooting {#troubleshooting}\n\n\nSome Virtual Private Server (VPS) providers sometimes ship a old version of Docker or Docker-Compose with their systems and the version isn't fully compatible with our installation script. This can be resolved by running these commands then attempting the installation process again: \n\n```bash\ncd /var/azuracast\n./docker.sh install-docker\n./docker.sh install-docker-compose\n./docker.sh install\n```\n\n\n## Unattended Installation {#unattended-installation}\n\n\nTo automate the installation process for AzuraCast, you can run the following commands or place them into a `cloud-init` script:\n\n```bash\nmkdir -p /var/azuracast\ncd /var/azuracast\ncurl -fsSL https://raw.githubusercontent.com/AzuraCast/AzuraCast/main/docker.sh > docker.sh\nchmod a+x docker.sh\n\n# To install the \"Stable\" release channel instead of \"Rolling Release\", uncomment this line:\n# yes 'Y' | ./docker.sh setup-release\n\nyes '' | ./docker.sh install\n```\n", "documentId": "getting-started/installation/docker", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/docker/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/docker/index.md" } ] }, { "id": "getting-started/installation/ansible/index.md", "kind": "page", "title": "Installing AzuraCast with Ansible", "description": "While our software is primarily deployed via Docker, there is an alternative installation method that allows you to install the software directly onto a host computer without Docker. We call this method the Ansible installer because it uses the Ansible deployment orchestration tool under the hood.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/ansible/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/ansible/index.md", "file": "getting-started/installation/ansible/index.md", "searchText": "While our software is primarily deployed via Docker, there is an alternative installation method that allows you to install the software directly onto a host computer without Docker. We call this method the **Ansible installer** because it uses the Ansible deployment orchestration tool under the hood.\n\n**This installation method is no longer supported by AzuraCast.**\n\nA community-maintained repository containing our Ansible installation files is maintained on GitHub. Follow the readme on the project's homepage for instructions on how to install AzuraCast via Ansible:\n\nhttps://github.com/AzuraCast/ansible-installer\n", "documentId": "getting-started/installation/ansible", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/ansible/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/ansible/index.md" } ] }, { "id": "getting-started/installation/synology/index.md", "kind": "page", "title": "Installing AzuraCast on a Synology NAS", "description": "Install Docker from the Synology package center.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/synology/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/synology/index.md", "file": "getting-started/installation/synology/index.md", "searchText": "\n## Configure Environment {#configure-environment}\n\n\n\n### 1. Install Docker {#1-install-docker}\n\n\nInstall Docker from the Synology package center.\n\n\n### 2. Enable SSH {#2-enable-ssh}\n\n\nTo enable SSH on Synology, open control panel and go to `Terminal & SNMP`. Check `Enable SSH service`. The default port is 22. You may change the port to something else if desired.\n\nAfter enabling SSH, connect to the NAS from a remote machine with a supported SSH terminal.\n\n\n### 3. OPTIONAL: Enable Home Folder for User {#3-optional-enable-home-folder-for-user}\n\n\nAs a convenience factor, you can set up home folders for users on the Synology NAS \n\nTo enable user home folder on Synology DSM, open control panel and go to `User`->`Advanced`. Scroll down and enable user home service.\n\n(Note: If you enable both SSH and home folder service, you can drop your SSH key into your home folder at `~/.ssh/authorized_keys`. Just make sure that folder and its children are `chmod`ded to 755, i.e. `chmod 755 /var/services/homes/my-nas-user`)\n\n\n### 4. OPTIONAL: Add User to Docker Group {#4-optional-add-user-to-docker-group}\n\n\nNote: This will effectively give the user account \"root\" level access (via Docker volumes), so only do this if you are comfortable with that arrangement.\n\n```bash\nsudo synogroup --add docker username\n```\n\nIf you decide not to do this, just add `sudo` to the beginning of any commands that appear after this.\n\n\n## Install AzuraCast {#install-azuracast}\n\n\n\n### 1. Create AzuraCast Folder {#1-create-azuracast-folder}\n\n\nBy default, Docker prefers that its relevant files be located in `/volume1/docker`. This doesn't necessarily mean that your media files have to be located on this directory, but the core AzuraCast installation should live within that folder. In this example, we will install AzuraCast into `/volume1/docker/azuracast`.\n\n```bash\nmkdir -p /volume1/docker/azuracast\ncd /volume1/docker/azuracast\n\ncurl -fsSL https://raw.githubusercontent.com/AzuraCast/AzuraCast/main/docker.sh > docker.sh\nchmod a+x docker.sh\n```\n\nBefore running the initial installation, you'll want to configure the ports that AzuraCast uses, as the Synology NAS by default will occupy ports 80 and 443. If you want AzuraCast to occupy those ports, you'll have to modify the configuration of the existing software to accomplish this.\n\nFor this example, we'll run AzuraCast on port 2080 and 2443.\n\nRun the script below to configure the relevant environment variables:\n\n```bash\nsudo ./docker.sh setup-ports\n```\n\nEnter the custom ports when prompted. You can also specify a custom port for SFTP connections, but the default (2022) should be available.\n\n```bash\nsudo ./docker.sh install\n```\n\nAzuraCast should then be immediately available on the specified ports.\n\n\n### 2. OPTIONAL: Specify Media directory for Station {#2-optional-specify-media-directory-for-station}\n\n\nGiven the setup of a Synology NAS, it's likely that you won't necessarily want to host your station's media inside the internal volume managed by Docker but rather elsewhere on your system. \n\nFor this example, I have created a station named \"AzuraTest Radio\" inside AzuraCast and created a separate shared folder, on Volume 2, labeled \"azuracast_media\".\n\nIn the Docker directory, `/volume1/docker/azuracast`, create a new file named `docker-compose.override.yml` with contents like those below:\n\n```yml\nservices:\n web:\n volumes:\n - /volume2/azuracast_media:/var/azuracast/stations/azuratest_radio/media\n\n stations:\n volumes:\n - /volume2/azuracast_media:/var/azuracast/stations/azuratest_radio/media\n```\n\nBy default, the user inside the Docker container runs as UID/GID 1000, the default UID for the first created user in an Ubuntu installation. It is very likely, however, that your Synology user account is not running with this UID/GID.\n\nYou should also update the UID/GID of the account running inside Docker to match yours.\n\nFirst, find your UID by running:\n\n```bash\nid -u\nid -g\n```\n\nEdit `/volume1/docker/azuracast/.env` (this file is hidden by default, but if you type it into a command like `vim /volume1/docker/azuracast/.env` you will see it) and add or modify the following rows:\n\n```\nAZURACAST_PUID=your_user_uid\nAZURACAST_PGID=your_user_gid\n```\n\nWith both the `docker-compose.override.yml` file and the UID/GID set, you can now restart your Docker containers by running:\n\n```bash\nsudo docker-compose down\nsudo docker-compose up -d\n```\n", "documentId": "getting-started/installation/synology", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/synology/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/synology/index.md" } ] }, { "id": "getting-started/installation/windows/index.md", "kind": "page", "title": "Installing AzuraCast on Windows", "description": "Installing AzuraCast on newer editions of Windows 10 (and Windows 11) is quite simple, thanks to the recent addition of the Windows Subsystem for Linux (WSL) version 2.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/windows/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/windows/index.md", "file": "getting-started/installation/windows/index.md", "searchText": "Installing AzuraCast on newer editions of Windows 10 (and Windows 11) is quite simple, thanks to the recent addition of the Windows Subsystem for Linux (WSL) version 2.\n\n\n## Installing with WSL2 {#installing-with-wsl2}\n\n\n\n\n> [!TIP]\n> Version 2 of the Windows Subsystem for Linux (WSL) will work on any edition of Windows, including Home editions.\n\n\n\n\n### Install Docker Desktop for Windows {#install-docker-desktop-for-windows}\n\n\nThe first step is to install WSL2 on your computer. One of the easiest ways to do this is to [download Docker Desktop for Windows](https://www.docker.com/products/docker-desktop).\n\nWhen running the installer, you will be prompted to automatically set up your Windows installation to work with WSL2. Make sure this option remains checked, and it will direct you to the necessary steps to get WSL2 running for your installation.\n\n\n### Set WSL2 as the Default Version {#set-wsl2-as-the-default-version}\n\n\nOnce WSL2 is installed and configured, and Docker Desktop is up and running, open a terminal window and type the following command:\n\n```bash\nwsl --set-default-version 2\n```\n\nThis ensures that any new Linux distributions will use version 2 of WSL by default, which is the desired behavior.\n\n\n### Install a Linux Distribution from the Windows Store {#install-a-linux-distribution-from-the-windows-store}\n\n\nNow you should install a Linux distribution that will serve as the host of your AzuraCast instance. Per our [requirements](/docs/getting-started/requirements/), you can select from several operating systems as your host OS, but the one with the best compatibility and support is the latest LTS build of Ubuntu, which you can install from the link below:\n\n- [Ubuntu on the Microsoft Store](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6?activetab=pivot:overviewtab)\n\n\n### Select That Distribution as Default {#select-that-distribution-as-default}\n\n\nFor convenience, you can set the newly installed distribution as your \"default\" WSL2 distribution, which means it automatically gets integration with Docker Desktop for Windows.\n\nYou can list the names of all installed WSL2 distributions by running:\n\n```bash\nwsl --list\n```\n\nTo set one as your default, enter its name in the command below. If you followed the recommendations here and used Ubuntu, you can run this command:\n\n```bash\nwsl --set-default Ubuntu\n```\n\n\n### Open a Linux Shell {#open-a-linux-shell}\n\n\nYour newly installed Linux distribution should be listed on the Start menu. Clicking the name of the distribution will open a terminal window with access to that distribution. If you're using Windows Terminal, you should also see a new option when creating a new tab to open a shell that connects to your installed Linux distribution.\n\n\n### Follow the Standard AzuraCast Installation Instructions {#follow-the-standard-azuracast-installation-instructions}\n\n\nInside the Linux shell window, you can follow our standard Linux Docker installation instructions. You don't need to make any changes to this process for it to work in this environment.\n\n- [Docker Installation](/docs/getting-started/installation/docker/)\n\n\n### Installation Complete {#installation-complete}\n\n\nOnce your installation is complete, by default, you will be able to access AzuraCast from your host Windows operating system by visiting `http://localhost`.\n", "documentId": "getting-started/installation/windows", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/windows/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/installation/windows/index.md" } ] }, { "id": "getting-started/settings/index.md", "kind": "page", "title": "AzuraCast Settings", "description": "Tuning AzuraCasts settings and performance", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/settings/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/settings/index.md", "file": "getting-started/settings/index.md", "searchText": "\n# Environment Variables {#environment-variables}\n\n\nThere are 2 files with environment variables that can change different aspects of AzuraCast.\n\nRemember to restart AzuraCast after changing values in these files via:\n\n```\ndocker-compose down\ndocker-compose up -d\n```\n\n\n## The `.env` File {#the-env-file}\n\n\n\n\n> [!TIP]\n> **Note the filename...**\n>\n> Because this file's name starts with a period, it is often hidden when using commands like `ls` to view a directory. You can list a directory (including this file) by using the `ls -a` flag (i.e. `ls -lah`).\n\n\n\nThe `.env` file is used by Docker itself to determine how certain parts of the infrastructure is set up.\n\nThe default `.env` file contains the following variables:\n\n| Variable | Default Value | Description\n| - | - | -\n| `COMPOSE_PROJECT_NAME` | azuracast | An internal variable used by Docker Compose; this should not be changed.\n| `AZURACAST_HTTP_PORT` | 80 | The port used to serve insecure HTTP web traffic.\n| `AZURACAST_HTTPS_PORT` | 443 | The port used to serve secure HTTPS web traffic.\n| `AZURACAST_SFTP_PORT` | 2022 | The port used to listen for incoming SFTP connections (used for bulk file management).\n| `NGINX_TIMEOUT` | 1800 | The time limit (in seconds) that nginx will wait for a response from the PHP application. Corresponds with `proxy_read_timeout` on the proxy and `fastcgi_read_timeout` on the web container. This should match your longest timeout value in `azuracast.env`.\n| `AZURACAST_PUID` | 1000 | The effective User ID (UID) of the user inside Docker. Matching this to your host UID (`id -u`) can fix permission issues.\n| `AZURACAST_PGID` | 1000 | The effective Group ID (GID) of the user inside Docker. Matching this to your host GID (`id -g`) can fix permission issues.\n| `AZURACAST_COMPOSE_PRIVILEGED` | true | Use privileged Docker settings that may not work in nested virtualization environments.\n\nIf you don't want to manually edit this file, you can also change the HTTP, HTTPS and SFTP ports by running `./docker.sh change-ports`.\n\n\n## The `azuracast.env` File {#the-azuracastenv-file}\n\n\nThe default `azuracast.env` contains the following variables:\n\n\n### AzuraCast Customization {#azuracast-customization}\n\n\n| Variable | Default Value | Description\n| - | - | -\n| `LANG` | en_US | The locale to use for CLI commands.
Valid options: `en_US`, `cs_CZ`, `nl_NL`, `fr_FR`, `de_DE`, `el_GR`, `it_IT`, `ja_JP`, `ko_KR`, `nb_NO`, `pl_PL`, `pt_PT`, `pt_BR`, `ru_RU`, `zh_CN`, `es_ES`, `sv_SE`, `tr_TR`, `uk_UA`\n| `APPLICATION_ENV` | production | The application environment.
Valid options: `production`, `development`, `testing`\n| `LOG_LEVEL` | notice | This allows you to log debug-level errors temporarily (for problem-solving) or reduce the volume of logs that are produced by your installation, without needing to modify whether your installation is a production or development instance.
Valid options: `debug`, `info`, `notice`, `warning`, `error`, `critical`, `alert`, `emergency`\n| `COMPOSER_PLUGIN_MODE` | false | Enable the composer \"merge\" functionality to combine the main application's composer.json file with any plugins' composer files. This can have performance implications, so you should only use it if you use one or more plugins with their own Composer dependencies.
Valid options: true, false\n| `AUTO_ASSIGN_PORT_MIN` | 8000 | The minimum port number to use when automatically assigning ports to a station. By default, this matches the first forwarded port on the \"stations\" container. You can modify this variable if your station port range is different. Be sure to also forward the necessary ports via `docker-compose.yml` (and nginx, if you want to use the built-in port-80/443 proxy)!\n| `AUTO_ASSIGN_PORT_MAX` | 8499 | The maximum port number to use when automatically assigning ports to a station. If using the default `AUTO_ASSIGN_PORT_MIN` OF 8000, using the default 8499 allows for 50 unique stations to operate.\n| `SHOW_DETAILED_ERRORS` | false | This allows you to debug Slim Application Errors you may encounter. By default, this is disabled to prevent users from seeing privileged information. Please report any Slim Application Error logs [to the development team on GitHub](https://github.com/slimphp/Slim/issues).\n\n\n### Database Configuration {#database-configuration}\n\n\n| Variable | Default Value | Description\n| - | - | -\n| `MYSQL_HOST` | localhost | The host to connect to. Leave this as the default value unless you're connecting to an external database server.\n| `MYSQL_PORT` | 3306 | The port to connect to. Leave this as the default value unless you're connecting to an external database server.\n| `MYSQL_USER` | azuracast | The username AzuraCast will use to connect to the database.\n| `MYSQL_PASSWORD` | azur4c457 | The password AzuraCast will use to connect to the database. By default, the database is not exposed to the Internet at all and this is only an internal password used by the service itself.\n| `MYSQL_DATABASE` | azuracast | The name of the AzuraCast database.\n| `MYSQL_RANDOM_ROOT_PASSWORD` | yes | Automatically generate a random root password upon the first database spin-up. This password will be visible in the mariadb container's logs.\n| `MYSQL_SLOW_QUERY_LOG` | 0 | Log slower queries for the purpose of diagnosing issues. Only turn this on when you need to, by uncommenting this and switching it to 1.
To read the slow query log once enabled, run: `docker-compose exec mariadb slow_queries`\n| `MYSQL_MAX_CONNECTIONS` | 100 | Set the amount of allowed connections to the database. This value should be increased if you are seeing the `Too many connections` error in the logs.\n| `MYSQL_INNODB_BUFFER_POOL_SIZE` | 128M | The InnoDB buffer pool size controls how much data & indexes are kept in memory. Making sure that this value is as large as possible reduces the amount of disk IO.\n| `MYSQL_INNODB_LOG_FILE_SIZE` | 16M | The InnoDB log file is used to achieve data durability in case of crashes or unexpected shutoffs and to allow the DB to better optimize IO for write operations.\n\n\n### Redis Configuration {#redis-configuration}\n\n\nUncomment these fields if you are using a third-party Redis host instead of the one provided with AzuraCast.\n\nDo not modify these fields if you are using the standard AzuraCast Redis host.\n\n| Variable | Default Value | Description\n| - | - | -\n| `ENABLE_REDIS` | true | Disable to use a flatfile cache instead of Redis.\n| `REDIS_HOST` | localhost | Name of the Redis host.\n| `REDIS_PORT` | 6379 | Port to connect to on the Redis host.\n| `REDIS_DB` | 1 | Database index to use on the Redis host.\n\n\n### Advanced Configuration {#advanced-configuration}\n\n\n| Variable | Default Value | Description\n| - | - | -\n| `PHP_MAX_FILE_SIZE` | 25M | PHP's maximum POST body size and max upload filesize.\n| `PHP_MEMORY_LIMIT` | 128M | PHP's maximum memory limit.\n| `PHP_MAX_EXECUTION_TIME` | 30 | PHP's maximum script execution time (in seconds).\n| `SYNC_SHORT_EXECUTION_TIME` | 600 | The maximum execution time (and lock timeout) for the 15-second, 1-minute and 5-minute synchronization tasks.\n| `SYNC_LONG_EXECUTION_TIME` | 1800 | The maximum execution time (and lock timeout) for the 1-hour synchronization task.\n| `NOW_PLAYING_DELAY_TIME` | 10 | The delay (in seconds) between Now Playing checks for every station. Decrease for more frequent checks at the expense of performance; increase for less frequent checks but better performance (for large installations). Minimum of 5 and maximum of 60 seconds.\n| `NOW_PLAYING_MAX_CONCURRENT_PROCESSES` | 1/3rd the total number of stations, rounded up | The maximum number of concurrent processes for now playing updates. Increasing this can help reduce the latency between updates now playing updates on large installations.\n| `PHP_FPM_MAX_CHILDREN` | 5 | Maximum number of PHP-FPM worker processes to spawn.\n| `PROFILING_EXTENSION_ENABLED` | 0 | Enable the SPX profiling extension in the Docker container, allowing for performance analysis of each page load.\n| `PROFILING_EXTENSION_ALWAYS_ON` | false | This will have a significant performance impact on your installation.\n| `PROFILING_EXTENSION_HTTP_KEY` | dev | The value for the \"SPX_KEY\" parameter for viewing profiling pages.\n| `NGINX_CLIENT_MAX_BODY_SIZE` | 50M | This is the total size any single request body can be. AzuraCast chunks its uploads into smaller file sizes, so this only applies when doing custom uploads via the API. Sizes should be listed in a format like \"100K\", \"128M\", \"1G\" for kilobytes, megabytes, and gigabytes respectively.\n| `ENABLE_WEB_UPDATER` | true | Enable web-based Docker image updates.\n| `INSTALL_PACKAGES_ON_STARTUP` | none | Extra Ubuntu packages to install upon startup. Separate package names with a space. Packages will be installed during container startup.\n| `NGINX_BLOCK_BOTS` | true | If enabled, it automatically blocks bad crawlers, spammers and bots, powered by the [Nginx Ultimate Bad Bot Blocker](https://github.com/mitchellkrogza/nginx-ultimate-bad-bot-blocker), with rules updated daily to ensure up-to-date protection.\n", "documentId": "getting-started/settings", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/settings/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/settings/index.md" } ] }, { "id": "getting-started/scaling/index.md", "kind": "page", "title": "Scaling AzuraCast", "description": "Expectations on what resources are required to host an AzuraCast instance, and tips on how to scale up as your station grows.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/scaling/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/scaling/index.md", "file": "getting-started/scaling/index.md", "searchText": "One of the most common questions we get from our users is:\n\n> \"How many stations/listeners/etc. can my server/VPS handle if running AzuraCast?\"\n\nUnfortunately, there's no universal answer to this question, as every web host (and indeed, every computer) has slightly different performance characteristics.\n\nFrom our experiences, we can draw some broad conclusions that can help you in scaling AzuraCast to meet your needs.\n\n\n## Resource Constraints {#resource-constraints}\n\n\n\n### CPU {#cpu}\n\n\nIf you're using the Liquidsoap AutoDJ, there will be a relatively stable but constant CPU load for every single broadcast destination you have on every station.\n\nIn this case, a \"broadcast destination\" is either:\n - a local mount point, or\n - a remote relay where the main AzuraCast server transcodes the audio and \"pushes\" it to the remote server.\n \nRemote relays that pull the local broadcast and duplicate it (i.e. AzuraRelay) don't count toward this limit.\n\nAs a very broad guideline, think of the equation for this CPU load as:\n **10% of one CPU per broadcast destination**.\n\nThis means if you have one station broadcasting to 10 mount points, you can expect that single station to take up *about* 100% of a single CPU core. Conversely, if you have 10 stations broadcasting only one mount point each, the CPU load is still 100% of a single CPU core.\n\nThe CPU impact of listeners connecting to your station is generally *much lower* than the impact of transcoding different stations. The broadcasting frontends (both Icecast and Shoutcast) can handle hundreds or even thousands of listeners before the CPU load of serving those listeners impacts your total CPU in the same way that media transcoding does.\n\n\n#### A Note on Throttling {#a-note-on-throttling}\n\n\nSome cloud hosting providers (including our own partners at DigitalOcean) offer \"Shared CPU\" plans where your instance shares processor time with other instances hosted on the same server.\n\nThey are generally able to offer those services affordably by ensuring that none of the instances use near 100% of their CPU load, allowing some extra load to be shared by other customers.\n\nBecause media transcoding is a constant CPU load on the server at all hours of the day, there's no way for the hosting provider to share that resource with other customers; as a result, if your load exceeds about 60% on a constant basis, they will often \"throttle\" your instance, giving it far fewer total CPU resources than before.\n\nIf you're running AzuraCast, you will absolutely notice this \"throttling\" as it will grind your system to a halt and stop most station operations. Sometimes, the only way to recover from this is to completely power down the server and restart it; other times, the throttling is permanent and requires setting up a new server.\n\nThere are two long-term solutions to this throttling:\n - Always \"overprovision\" your server so it never sees a constant CPU load of more than 50% of its total capacity, ensuring it likely won't be throttled, or\n - Invest in the hosting provider's \"Dedicated CPU\" plans, which, while they are likely to be more expensive, will not encounter this issue at all.\n\n\n### RAM {#ram}\n\n\nAzuraCast depends on a number of third-party software to operate, and one of the biggest consumers of RAM in our setup is our database engine, MariaDB (a community-maintained fork of MySQL).\n\nBetween MariaDB and the main PHP processes, you should allocate at least 512MB, and preferably over 1GB of RAM to any AzuraCast server.\n\nIn our experience with AzuraCast, the amount of RAM being used does not scale linearly with the number of stations you operate. Almost every process in AzuraCast has a maximum RAM limit that it will reach, after which processes start to take more *time* instead of more *memory*.\n\n\n### Storage {#storage}\n\n\nA typical AzuraCast installation, whether on Docker or Ansible, requires about 2GB of available space to store its own internal software images. You should have at least 5GB of free space available on the server to allow for upgrades to run without any issues.\n\nThe amount of storage you need is largely determined by the size of your stations' media libraries. Many stations upload lossless versions of their media, but if your listeners are only connecting at standard web radio bitrates (128kbps MP3, for example), this may not always be necessary. It can be helpful to transcode media to a lower bitrate before uploading.\n\n\n#### A Note on Backups {#a-note-on-backups}\n\n\nIf you're backing up your AzuraCast installation and including media in the backup, you should have the same amount of available space as your current media collection. You can exclude media from your regular backups to save space on the server if necessary.\n\n\n## Tips for Overcoming Limits {#tips-for-overcoming-limits}\n\n\n\n### Expanding Listener Capacity {#expanding-listener-capacity}\n\n\nOne of the easiest ways to expand your listener capacity with very little modification needed is to install [AzuraRelay](https://github.com/AzuraCast/AzuraRelay) on a second server. AzuraRelay connects to your main AzuraCast listeners, relays its streams in a way that doesn't consume extra CPU on the main server, and reports its statistics back to AzuraCast automatically.\n\nThis second server can be located anywhere in the world, so it can also be used to create a relay that's closer to some listeners than your main server.\n\n\n### Expanding Storage {#expanding-storage}\n\n\nSome virtual hosting providers offer \"block storage\" that lets you add a separate block of storage space to your virtual environment. You can then follow our [instructions](/docs/administration/docker/#storing-your-station-data-on-the-host-machine) for mounting this additional storage space to your station's media directory.\n\nAlternatively, if you need large volumes of storage, or want to store things like backups remotely, you can take advantage of S3-compatible storage options. If you're using S3 storage for your station media library, it is strongly recommended to use a service with no egress fees, like [Wasabi](https://wasabi.com/) or [CloudFlare R2](https://blog.cloudflare.com/introducing-r2-object-storage/).\n", "documentId": "getting-started/scaling", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/scaling/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/scaling/index.md" } ] }, { "id": "getting-started/updates/index.md", "kind": "page", "title": "Update AzuraCast", "description": "How to update your AzuraCast installation", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/updates/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/updates/index.md", "file": "getting-started/updates/index.md", "searchText": "Updating AzuraCast will update both the web app itself and all of its dependencies, so you will be on the latest version of all of the supporting software.\n\nDuring the update process, your stations will be briefly offline to listeners, so you should set aside a time to update and notify listeners if necessary.\n\n\n\n> [!TIP]\n> **Always back up first!**\n>\n> The AzuraCast team is not responsible for any downtime or loss of data of your production installations of AzuraCast if you run into any errors while updating. Especially if you are updating a production installation with a lot of stations on a single server.\n\n\n\n\n## For Docker Installations {#for-docker-installations}\n\n\n\n### Before Updating: Update Docker & Docker Compose {#before-updating-update-docker--docker-compose}\n\n\nIf it's been quite some time since you last updated, your version of Docker and Docker Compose may be out of date, and updates may trigger errors as a result.\n\nYou can update Docker and Docker Compose using the utility script by running:\n\n```bash\ncd /var/azuracast\n./docker.sh update-self\n./docker.sh install-docker\n./docker.sh install-docker-compose\n```\n\n\n### Interactive Updates (Recommended) {#interactive-updates-recommended}\n\n\nUsing the included Docker utility script, updating is as simple as running:\n\n```bash\ncd /var/azuracast\n./docker.sh update-self\n./docker.sh update\n```\n\n\n### Automated Updates {#automated-updates}\n\n\nBy default, the updater will prompt you to update your `docker-compose.yml` file. If you aren't making any changes to this file and want to automate the update process, you can use the command below to automatically answer \"yes\" to this question:\n\n```bash\ncd /var/azuracast\n./docker.sh update-self\nyes \"\" | ./docker.sh update\n```\n\n\n## For Ansible Installations {#for-ansible-installations}\n\n\nAzuraCast also includes a handy updater script for Ansible installations that pulls down the latest copy of the codebase from Git, flushes the site caches and makes any necessary database updates. Run these commands as any user with `sudo` permissions:\n\n```bash\ncd /var/azuracast/www\n \nsudo chmod a+x update.sh\nsudo ./update.sh\n```\n\n\n### Force a Full Update {#force-a-full-update}\n\n\nNormally, the Ansible installer's update script only updates the portion of the system that have been modified since your last update. If an update was interrupted or otherwise is causing trouble, you can force the update script to process all components, which can often fix any issues:\n\n```bash\n./update.sh --full\n```\n\n\n## Switching Update Release Channels {#switching-update-release-channels}\n\n\nAzuraCast ships two different release channels (\"Stable\" and \"Rolling Release\"), which you can switch between per installation. For more information, see our [Release Channels](/docs/getting-started/updates/release-channels/) page.\n", "documentId": "getting-started/updates", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/updates/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/updates/index.md" } ] }, { "id": "getting-started/updates/release-channels/index.md", "kind": "page", "title": "Release Channels", "description": "How to change the release channel for your installation", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/updates/release-channels/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/updates/release-channels/index.md", "file": "getting-started/updates/release-channels/index.md", "searchText": "For Docker installations, AzuraCast offers two different release channels:\n\n- A \"**Stable**\" channel that only updates every few weeks or months and consists of changes that have been running on many installations without any issue for quite some time. These releases are tagged with version numbers (i.e. 0.10.3, 0.10.4).\n\n- A \"**Rolling Release**\" channel that updates every time changes are made to the AzuraCast codebase, which can sometimes be as frequent as multiple times in a single day. This channel is useful if you're testing new features, running a non-production environment, or need a bug fix that's only recently been made available.\n\nBy default, our one-click installers for web hosts are set to prefer stable release builds. When installing yourself, you'll be prompted with the question of whether to prefer stable releases during the initial installation process.\n\n\n## Switching Release Channels {#switching-release-channels}\n\n\n\n\n> [!TIP]\n> **Take a backup first!**\n>\n> Regardless of which direction you are switching, it is strongly recommended when switching channels to take a backup of your station's data beforehand to more easily recover from any issues that may arise.\n\n\n\nIf you want to switch release channels on an existing installation, note the rules below before proceeding:\n\n\n### Switching from \"Stable\" to \"Rolling Release\" {#switching-from-stable-to-rolling-release}\n\n\nYou can switch from the \"Stable\" channel to the \"Rolling Release\" channel at any time, because the Rolling Release channel will always be the same as, or newer than, the stable channel.\n\n\n### Switching from \"Rolling Release\" to \"Stable\" {#switching-from-rolling-release-to-stable}\n\n\nYou should only switch from \"Rolling Release\" to \"Stable\" when your rolling-release version is older than or the exact same version as the current stable version. In other words:\n\n- If your rolling release version is dated October 2, 2020 and the stable version was released on October 5, you can switch channels and update without any issue, BUT\n\n- If your rolling release version is dated October 7, 2020 and the stable version was released on October 5, you **should not** switch channels and should instead wait until the next stable release.\n\nThe reason this can be a problem is because of database migrations: new features implemented in the \"Rolling Release\" channel can include corresponding database changes, and an update to a \"Stable\" release that's older than your current one would require that you roll back database migrations; however, to the \"Stable\" version those migrations don't exist (since it is frozen in time from before they were created), causing your database to fall into an incorrect state.\n\nAs an important note, though, if you have mistakenly switched to the \"Stable\" channel and it has caused your database to go out-of-sync, it is highly likely that just switching back to the \"Rolling Release\" channel will resolve your issues and return your installation to normal. You can then wait until the next tagged \"Stable\" release to switch channels again.\n\n\n## Setting AzuraCast to Use a Different Channel {#setting-azuracast-to-use-a-different-channel}\n\n\n\n### For Docker Installations {#for-docker-installations}\n\n\nYou can switch release channels by logging in to your host computer (the server running AzuraCast) via SSH and executing:\n\n```bash\ncd /var/azuracast\n./docker.sh update-self\n./docker.sh setup-release\n```\n\nYou will be prompted whether to prefer stable release builds. If you answer \"N\", you will be placed on the \"Rolling Release\" channel.\n\nYou can then run the update script (`./docker.sh update`) and your installation will switch its active release channel.\n\n\n### For Ansible Installations {#for-ansible-installations}\n\n\nAnsible installations are directly tied to the Git repository, so switching channels is a matter of switching the branch that's checked out.\n\n\n#### Switching to Rolling Release {#switching-to-rolling-release}\n\n\n```bash\ngit reset --hard\ngit checkout main\ngit pull\n```\n\n\n#### Switching to Stable {#switching-to-stable}\n\n\n```bash\ngit reset --hard\ngit checkout stable\ngit pull\n```\n", "documentId": "getting-started/updates/release-channels", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/getting-started/updates/release-channels/", "markdown": "https://sourcey-azuracast.pages.dev/docs/getting-started/updates/release-channels/index.md" } ] }, { "id": "administration/docker/index.md", "kind": "page", "title": "Docker", "description": "All about Docker installations of AzuraCast", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/docker/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/docker/index.md", "file": "administration/docker/index.md", "searchText": "Docker installations come with four files by default:\n\n- `docker.sh`, the Docker Utility Script;\n- `.env`, which contains environment variables used by Docker Compose itself;\n- `azuracast.env`, which contains customizable environment variables sent to AzuraCast and related services; and\n- `docker-compose.yml`, a large file that defines all of the services used by AzuraCast and how they interact.\n\n\n## Docker Utility Script {#docker-utility-script}\n\n\nIf you're using the Docker installation method to run AzuraCast, we have created a helpful utility script to perform common functions without having to type long command names.\n\n\n### Download the Utility Script {#download-the-utility-script}\n\n\nIf you've recently followed the [Docker installation instructions](/docs/getting-started/installation/docker/), you already have the Docker Utility Script installed. The file is named `docker.sh`.\n\nIf you have an older installation, you can use the Docker Utility Script by running these commands inside your AzuraCast directory on your host computer:\n\n```bash\ncurl -L https://raw.githubusercontent.com/AzuraCast/AzuraCast/main/docker.sh > docker.sh\nchmod a+x docker.sh\n```\n\n\n### Run Command Line Tools {#run-command-line-tools}\n\n\n```bash\n./docker.sh cli [command_name]\n```\n\nRuns any command exposed by the command line interface tools.\n\n\n## Available Commands {#available-commands}\n\n\n\n### Install AzuraCast {#install-azuracast}\n\n\n```bash\n./docker.sh install\n```\n\nPulls the latest version of all Docker images and sets up the AzuraCast database. When complete, your AzuraCast instance should be up and running.\n\n\n### Update AzuraCast {#update-azuracast}\n\n\n```bash\n./docker.sh update-self\n./docker.sh update\n```\n\nNote: You should always run update-self first to update the updater script.\n\nAutomatically pulls down any updated Docker images and applies any database and configuration changes since your last AzuraCast update.\n\n\n### Uninstall AzuraCast {#uninstall-azuracast}\n\n\n```bash\n./docker.sh uninstall\n```\n\nTurns off and permanently deletes both the AzuraCast Docker containers and permanent volumes that store the AzuraCast database and station media.\n\n\n\n> [!CAUTION]\n> **This command results in data loss!**\n>\n> This command will fully remove any station media, statistics and metrics, and the entire database associated with your AzuraCast instance.\n\n\n\n\n### Back Up Files and Settings {#back-up-files-and-settings}\n\n\n```bash\n./docker.sh backup [/path/to/backup.tar.gz]\n```\n\nCreates a .tar.gz backup copy of the media, statistics and metrics of every station, along with a copy of the full AzuraCast database. You can later restore from this same file in the event of data loss or corruption.\n\n\n### Restore Files and Settings {#restore-files-and-settings}\n\n\n```bash\n./docker.sh restore /path/to/backup.tar.gz\n```\n\nExtracts a .tar.gz file previously created by this same script's backup command, copying media, statistics and metrics for each station into AzuraCast and importing the version of the database contained in the backup.\n\n\n\n> [!CAUTION]\n> **This command replaces your current installation!**\n>\n> Restoring from a backup will remove any existing AzuraCast database or media that exists inside the Docker volumes.\n\n\n\n\n## Customizing Docker Installations {#customizing-docker-installations}\n\n\nFor power users looking to customize or expand their Docker configuration, you should follow these best practices:\n\n- Do not modify or replace the `docker.sh` utility script.\n\n- When updating (using the `docker.sh` utility script), it is recommended to run `./docker.sh update-self` before running `./docker.sh update`, to ensure the Docker Utility Script itself is up to date before it updates your Docker installation.\n\n- Environment variables set in `.env` are only used by Docker Compose itself, and aren't passed directly into the AzuraCast containers. You should only modify this file to change the HTTP and HTTPS port mappings used by Nginx (see the \"Use Non-Standard Ports\" section above).\n\n- The `azuracast.env` file is specific to your environment and can be customized however you like. It will not be replaced during any updates. Once your database has been created, however, changing the password listed in this file will cause the system to fail. If you want to destructively wipe your existing database and other files and set up a new one with the updated password, add the `-v` flag to the end of `docker-compose down to remove all existing volumes, including your database.\n\n- If possible, you should not directly modify `docker-compose.yml`, as some updates may modify how it is defined to resolve bugs or add new features. When updating, you will always be asked if you want to update this file; if you have not modified it, you should always do so.\n\n- Instead of modifying `docker-compose.yml`, you can create a file named `docker-compose.override.yml` with your customizations. The structure of this file is the same as the main `docker-compose.yml` file, and is automatically parsed by Docker Compose to override any definitions in the main file. Updates will not replace this file.\n\n\n## Modifying Docker {#modifying-docker}\n\n\nThe AzuraCast Docker installation is built to serve the needs of the vast majority of installations out of the box, but there may be times when you need to customize how Docker serves your installation, while still retaining the benefits of compatibility and easy updating that Docker offers.\n\n\n### The Overall Infrastructure {#the-overall-infrastructure}\n\n\nIn recent versions, we have united our Docker infrastructure into a single container that contains the whole application, its databases and caches, and broadcasting controls.\n\n![appinfrastructure.png](/docs/_media/cd20882aee7d11e02bf2.png)\n\n\n### Docker Compose {#docker-compose}\n\n\nIn order to make our Docker installation simple to maintain, we rely on a secondary piece of software called [Docker Compose](https://docs.docker.com/compose/). Rather than using lengthy command-line commands, Docker Compose allows you to write simple YAML files to configure the way our Docker containers launch, which ports they forward to the host, mounted disk volumes, etc.\n\nIf you follow our installation instructions (or use one of our prebuilt images), your Docker installation is located on your host computer at `/var/azuracast`. Within this folder, you'll see four files by default:\n\n- `docker-compose.yml`, the primary Docker Compose configuration file. AzuraCast's updater automatically prompts you to keep this file updated, which is strongly recommended;\n\n- `docker.sh`, the Docker Utility Script that provides easy aliases for common Docker tasks, such as updating, executing commands inside containers, and more;\n\n- `azuracast.env`, a list of environment (configuration) variables that are sent to the AzuraCast application itself, running inside the web container; and\n\n- `.env`, a separate environment file that affects how Docker Compose _itself_ is configured, and is thus used for higher-level configuration changes like port mappings.\n\n\n### Overriding Docker Compose {#overriding-docker-compose}\n\n\nRather than modifying `docker-compose.yml` directly, it is strongly recommended to instead create a new file called `docker-compose.override.yml` in the same folder. Docker Compose will automatically look for and include this file if it exists, and apply its configuration on top of the base file's instructions.\n\nThere are some considerations when creating your own `docker-compose.override.yml`:\n\n- The file must be valid YAML using the standard [Docker Compose format](https://docs.docker.com/compose/compose-file/compose-file-v2/).\n\n- When modifying ports or other lists, you can only add new items, not remove existing ones.\n\nOnce you've modified your Docker Compose configuration, you should apply these changes by running:\n\n```bash\ndocker-compose down\ndocker-compose up -d\n```\n\nNote that this will temporarily shut down your AzuraCast installation and will briefly disconnect your listeners.\n\n\n### Using Non-standard Ports {#using-non-standard-ports}\n\n\n\n\n> [!TIP]\n> In newer versions, you no longer need to manually do this; you can instead use the installer by answering \"Yes\" when prompted to customize settings.\n\n\n\nYou may want to serve the AzuraCast web application itself on a different port, or host your radio station on a port that isn't within the default range AzuraCast serves (8000-8999).\n\nYou can use a helper tool in the Docker Utility Script to easily change the ports used by AzuraCast:\n\n```bash\ncd /var/azuracast\n./docker.sh update-self\n./docker.sh change-ports\n```\n\nTo override more complex functionality in your Docker installation, see the \"Customizing Docker\" section below.\n\n\n# Expanding the Station Port Range {#expanding-the-station-port-range}\n\n\n\n\n> [!TIP]\n> Installations running version 0.16.0 or higher can now use our installation script to customizez ports via the terminal which will automatically write the changes into the `docker-compose.yml` file for you.\n\n\n\nFor performance reasons, by default Docker installations only open radio ports from port 8000 to 8500. This allows for 50 unique stations to operate.\n\nDepending on your hardware, it may be possible to run more than 50 stations on one AzuraCast instance, but if you want to directly access the additional radio ports, you can follow this simple process.\n\nIn the same folder where your Docker installation is (if using recommended instructions, this is `/var/azuracast`), create a new file named `docker-compose.override.yml`.\n\nIn this file, paste the following contents:\n\n```yaml\nservices:\n web:\n ports:\n - \"8500-8999:8500-8999\"\n```\n\nYou can modify the port range in this file to meet your needs, such as expanding it to port 8999 instead of 8500.\n\nWhen creating a new station, AzuraCast will attempt to automatically assign it an available port from the available port range. If you change this port range, you should let AzuraCast know by adding or updating the following values in your `azuracast.env` file:\n\n```\nAUTO_ASSIGN_PORT_MIN=8500\nAUTO_ASSIGN_PORT_MAX=8999\n```\n\nYou will need to restart your Docker containers using `docker-compose down`, then `docker-compose up -d` to apply any changes made to these files.\n\n\n### Mounting a Directory Into a Station {#mounting-a-directory-into-a-station}\n\n\nYou may want to add music to a station from a directory on your host machine without copying the data into AzuraCast. You can mount the directory into your stations and web container to make them available to AzuraCast by creating a `docker-compose.override.yml`.\n\nIn the same folder where your Docker installation is (if using recommended instructions, this is `/var/azuracast`), create a new file named `docker-compose.override.yml`.\n\nIn this file, paste the following contents:\n\n```yaml\nservices:\n web:\n volumes:\n - /path/on/host/computer:/var/azuracast/stations//media/\n```\n\nReplace the `` with the name of the station directory found under the \"Administration\" section of the station's profile settings and modify the `/path/on/host/computer` with the path to the directory that you want to mount.\n\nYou will need to restart your Docker containers using `docker-compose down`, then `docker-compose up -d` to apply any changes made to this file.\n\n\n### Storing Your Station Data on the Host Machine {#storing-your-station-data-on-the-host-machine}\n\n\nYou can store all of you station data in a directory on your host machine. This can be useful if you want to have AzuraCast running on a small SSD and store the station data on a large HDD.\n\nIn the same folder where your Docker installation is (if using recommended instructions, this is `/var/azuracast`), create a new file named `docker-compose.override.yml`.\n\nIn this file, paste the following contents:\n\n```yaml\nservices:\n web:\n volumes:\n - /path/on/host/computer:/var/azuracast/stations\n```\n\nModify the `/path/on/host/computer` with the path to the directory that you want to mount.\n\nYou will need to restart your Docker containers using `docker-compose down`, then `docker-compose up -d` to apply any changes made to this file.\n\n\n# Custom Default Track {#custom-default-track}\n\n\n\n\n> [!TIP]\n> In newer versions of AzuraCast, you no longer need to upload a custom default track this way; you can upload a unique \"Custom Fallback Track\" per-station using the web interface.\n\n\n\nWhen nothing is playing on your station you'll hear the default error.mp3 file of AzuraCast playing. You can replace this file by mounting your own .mp3 file via a `docker-compose.override.yml`.\n\nIn the same folder where your Docker installation is (if using recommended instructions, this is `/var/azuracast`), create a new file named `docker-compose.override.yml`.\n\nYou can place your .mp3 file anywhere on your host machine. You just have to specify the path to it by replacing this part: `/path/to/your/file.mp3`\n\nWe recommend to put that file inside the `/var/azuracast` directory though so that you have everything in the same place. Make sure that the format of the file specified matches the streaming format exactly.\n\nIn this file, paste the following contents:\n\n```yaml\nservices:\n web:\n volumes:\n - /path/to/your/file.mp3:/usr/local/share/icecast/web/error.mp3\n```\n\nYou will need to restart your Docker containers using `docker-compose down`, then `docker-compose up -d` to apply any changes made to this file.\n\n\n### Stream Intro File {#stream-intro-file}\n\n\n\n\n> [!TIP]\n> In newer versions of AzuraCast, you can now directly upload an intro track on the Mount Point edit page.\n\n\n\nYou can add a music file to play when someone initially connects to your stream. Remember when creating intro files that they **must match the exact same format, bitrate and sample rate as your mount point to work properly.**\n\nFirst, tell the Docker filesystem where to find your intro file. Inside the AzuraCast directory on your host (by default, `/var/azuracast`), create a file named `docker-compose.override.yml` with the following contents:\n\n```yaml\nservices:\n stations:\n volumes:\n - /path/to/your/file.mp3:/usr/local/share/icecast/web/intro.mp3\n```\n\nNow restart AzuraCast via `docker-compose down && docker-compose up -d`.\n\nReturn to the AzuraCast web interface, visit the \"Mount Points\" page for your station, edit the mount point you want to add an intro for, and inside the \"Advanced: Custom Frontend Configuration\" field, enter this, based on the last portion of the mounted file from the above example:\n\n```\n/intro.mp3\n```\n\nFor more information, see the [Icecast documentation.](https://www.icecast.org/docs/)\n\n\n### Custom Favicon {#custom-favicon}\n\n\n\n\n> [!TIP]\n> In newer versions of AzuraCast, you can manage this via the web UI.\n\n\n\nTo override the favicon and other browser icons used by AzuraCast, you should follow these steps:\n\n1. Upload your icon to favicon-generator.org. Be sure to leave \"Generate icons for Web, Android, Microsoft, and iOS (iPhone and iPad) Apps\" checked.\n2. Once your icon set is downloaded, it will be in a .zip file format; extract that file and copy it to the host server where AzuraCast is hosted.\n3. Inside the AzuraCast directory on your host (by default, /var/azuracast), create a file named docker-compose.override.yml with the following contents:\n\n```yaml\nservices:\n web:\n volumes:\n - /path/to/your/favicon/folder:/var/azuracast/www/static/icons/production\n```\n\n4. Restart AzuraCast via `docker-compose down && docker-compose up -d`.\n\n\n### Increase PHP Allowed Memory {#increase-php-allowed-memory}\n\n\nWhen you encounter an error like the following one you will need to increase the amount of memory that PHP is allowed to use:\n\n```\nAzuraCast.CRITICAL: Fatal error: Allowed memory size of 268435456 bytes exhausted (tried to allocate 212992 bytes) ...\n```\n\nYou can easily do this by editing the `azuracast.env` located in `/var/azuracast/`.\n\nThere you can find the following entry:\n\n```\n# PHP's maximum memory limit.\n# PHP_MEMORY_LIMIT=128M\n```\n\nChange this to look like this:\n\n```\n# PHP's maximum memory limit.\nPHP_MEMORY_LIMIT=512M\n```\n\nYou should increase the value until the error dissappears.\n\nThe `M` after the value stands for `Megabytes`.\n\nRefer to [PHP's documentation](https://www.php.net/manual/docs/faq.using.php#faq.using.shorthandbytes) for more information about the allowed values for this setting.\n\nAfter you have changed this setting you need to restart AzuraCast via `docker-compose down && docker-compose up -d`.\n\n\n### Adding custom NGINX configurations {#adding-custom-nginx-configurations}\n\n\nIf you need to add some custom configurations to NGINX you can do this by your `custom.conf` file into the `web` container via the `docker-compose.override.yml` like this:\n\n```yaml\nservices:\n web:\n volumes:\n - ./custom.conf:/etc/nginx/azuracast.conf.d/custom.conf\n```\n\nAll config files placed in the `/etc/nginx/azuracast.conf.d/` are automatically included in the main AzuraCast NGINX configuration.\n\n\n### Multi-Site Installation {#multi-site-installation}\n\n\nAzuraCast can exist on a server with other web sites hosted at different URLs. Check out our [Multi-Site Docker Installation guide](/docs/administration/multi-site-installation/) for more information.\n", "documentId": "administration/docker", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/docker/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/docker/index.md" } ] }, { "id": "administration/ssl-and-lets-encrypt/index.md", "kind": "page", "title": "SSL & Let's Encrypt", "description": "Securing your AzuraCast installation with SSL / HTTPS", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/ssl-and-lets-encrypt/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/ssl-and-lets-encrypt/index.md", "file": "administration/ssl-and-lets-encrypt/index.md", "searchText": "AzuraCast now includes built-in support for creating and managing SSL (HTTPS) certificates via LetsEncrypt from the System Settings panel.\n\nLetsEncrypt is a free and simple way to allow safe and secure connections to your AzuraCast installation. With a valid SSL certificate, you can:\n\n- Secure your connection to AzuraCast when administering your stations,\n\n- Enforce security for all AzuraCast administrators via HTTP Strict Transport Security (HSTS), and\n\n- Provide a secure listening endpoint to listeners, avoiding \"Mixed Content\" warnings when your radio signal is played from a secure web page.\n\n\n## Important Considerations {#important-considerations}\n\n\nBefore setting up LetsEncrypt, you should make sure the following conditions are met:\n\n- **AzuraCast must be on its own domain or subdomain.** You can't set up LetsEncrypt using only an IP address; you must have a domain (i.e. example.com) or a subdomain (radio.example.com) set up to point to your AzuraCast installation.\n\n- **AzuraCast's web server must be served on the default ports, 80 for HTTP and 443 for HTTPS.** By default, AzuraCast is already set up this way, but if you've modified the ports to serve the site on a secondary port, you must switch the ports back to the defaults when setting up LetsEncrypt and when performing renewals.\n\n\n## Enabling LetsEncrypt {#enabling-letsencrypt}\n\n\nTo enable LetsEncrypt, follow these steps:\n\n- Log in to your AzuraCast installation\n- Click the dropdown on the top right, then \"System Administration\"\n- Click \"System Settings\"\n- Select the \"Services\" tab\n- Complete the LetsEncrypt section fields\n- Click \"Save Changes\" at the bottom\n\nThe HTTPS certificate will automatically be generated in the next few minutes, but you can do it manually by clicking the \"Create/Renew Certificate\" button under the LetsEncrypt fields.\n\n\n\n> [!TIP]\n> If users are still having issues with audio not playing, please ensure you have the \"Use Web Proxy\" option enabled in your System Settings.\n\n\n\n\n### Renewing a Let's Encrypt Certificate {#renewing-a-lets-encrypt-certificate}\n\n\nThe web service will automatically renew your LetsEncrypt certificates. If you provide an e-mail in the initial setup process, that e-mail will be used to send you reminders of upcoming expiration in the event that automatic renewal fails.\n\n\n## Always Use HTTPS (HTTP Strict Transport Security) {#always-use-https-http-strict-transport-security}\n\n\nFrom the \"System Settings\" panel inside AzuraCast, you can enable the \"Always Use HTTPS\" setting in the \"Security & Privacy\" tab.\n\nOnce this setting is enabled, not only will all users be redirected to the secure version of AzuraCast when visiting, but HTTP Strict Transport Security (HSTS) will be enabled, which requires a valid SSL certificate to function. This significantly improves the security of your connection to AzuraCast and should be enabled whenever possible.\n\n\n### Disabling HSTS via CLI {#disabling-hsts-via-cli}\n\n\nIf you enable HTTP Strict Transport Security, and then your domain is no longer available via HTTPS, you will normally be unable to access your installation via your web browser.\n\nYou can, however, turn this setting off via the SSH terminal, by using the code below:\n\n```bash\ncd /var/azuracast\nbash docker.sh cli azuracast:settings:set always_use_ssl 0\n```\n\nThis will disable the setting and enable you to reconnect to your installation.\n\n\n## Using a Custom Certificate {#using-a-custom-certificate}\n\n\nIf you have a custom SSL certificate on your host, you should create a `docker-compose.override.yml` file in your `/var/azuracast` directory on the host server with the contents below, modified to reflect your domain name and the path to your SSL certificate and key:\n\n```yaml\nservices:\n web:\n volumes:\n - /path/on/host/to/ssl.crt:/var/azuracast/acme/ssl.crt:ro\n - /path/on/host/to/ssl.key:/var/azuracast/acme/ssl.key:ro\n```\n\n\n\n> [!TIP]\n> Please note that Icecast expects an RSA private key as well as a certificate file with the complete certificate chain. For custom certificates in the `.pem` format generated by something like `Certbot` you will need to convert them like this:\n>\n> `openssl rsa -in privkey.pem -out example.com.key`\n>\n> `openssl crl2pkcs7 -nocrl -certfile fullchain.pem | openssl pkcs7 -print_certs -out example.com.crt`\n\n\n\nFinally you need to restart AzuraCast in order to apply the changes:\n\n```bash\ndocker-compose down\ndocker-compose up -d\n```\n", "documentId": "administration/ssl-and-lets-encrypt", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/ssl-and-lets-encrypt/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/ssl-and-lets-encrypt/index.md" } ] }, { "id": "administration/cloudflare/index.md", "kind": "page", "title": "Cloudflare", "description": "Using Cloudflare as proxy for your AzuraCast installation", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/cloudflare/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/cloudflare/index.md", "file": "administration/cloudflare/index.md", "searchText": "[Cloudflare](https://cloudflare.com/) is a leading provider of reverse proxying and CDN services for the web. Their free tier offers huge benefits in performance and protection that you can take advantage of while using AzuraCast, with a few important caveats. This document details how to use Cloudflare with AzuraCast.\n\n\n## Enabling Cloudflare with AzuraCast {#enabling-cloudflare-with-azuracast}\n\n\nAzuraCast has full support for using Cloudflare's protection in front of your radio server.\n\nEnabling Cloudflare support from the Cloudflare control panel is as simple as ensuring the little \"cloud\" next to your radio server's domain (or subdomain) is orange, indicating protection is enabled.\n\n![cloudflare_enable.png](/docs/_media/a7519ac812dbe23e9ef3.png)\n\nThe default settings for Cloudflare will suffice, though you can also switch from \"Flexible\" to \"Full\" SSL mode if you like (since AzuraCast itself supports HTTPS). \"Strict\" SSL mode isn't recommended, as this requires that you maintain an up-to-date SSL certificate on AzuraCast itself (which is possible, but not necessary).\n\nOnce you've enabled Cloudflare support for your domain (or radio station's subdomain) from the Cloudflare control panel, you only need to enable one feature inside AzuraCast to enable listeners to connect:\n\n\n### Enabling the Web Proxy for Radio Broadcasts {#enabling-the-web-proxy-for-radio-broadcasts}\n\n\nOne major limitation imposed by Cloudflare is that they do not forward incoming connections to your server that don't come from the traditional web ports (that is, 80 and 443). By default, AzuraCast serves each radio station on its own distinct port in a range from 8000 to 9000. This means your listeners wouldn't normally be able to connect.\n\n![cloudflare_proxy.png](/docs/_media/fb5622a15312f63fe99e.png)\n\nFortunately, we've already built a solution to this problem! In AzuraCast's system administration, on the \"System Settings\" page, we have a checkbox labeled \"Use Web Proxy for Radio\". Enable this checkbox and all of the station playback URLs across the system will be updated to automatically use the web port proxy links, which are fully accessible even when Cloudflare protection is enabled.\n\n\n## Important Notes {#important-notes}\n\n\n\n### Do Not Cache Radio Content {#do-not-cache-radio-content}\n\n\nCloudflare does not allow you to serve your web radio content via their cached CDN, as the content is a streaming audio file that isn't cacheable via their traditional services. The easiest way to instruct Cloudflare not to cache your radio broadcasts is via their Page Rules feature.\n\nTo create a new Page Rule:\n\n1) Visit the Cloudflare control panel, then \"Rules\", then \"Page Rules\".\n2) Click \"Create Page Rule\".\n3) Enter the URL of your AzuraCast installation, followed by one of the patterns below. The finished pattern should look like `azuracast.example.com/radio/*`\n4) Pick the \"Cache Level\" setting, set it to \"Bypass\".\n5) Click \"Save and Deploy Page Rule\" at the bottom of the page.\n\nRepeat these steps for all of the following patterns:\n\n - `/radio/*`\n - `/listen/*`\n - `/hls/*`\n\n\n### Always Disable Rocket Loader {#always-disable-rocket-loader}\n\n\nAzuraCast is **not** compatible with the Rocket Loader optimization offered by Cloudflare. If Rocket Loader is enabled, you will encounter unexpected errors with AzuraCast.\n\nIn order to resolve this error, you must go to your Cloudflare Dashboard and disable the Rocket Launcher settings.\n\n\n### About Incoming DJ Connections {#about-incoming-dj-connections}\n\n\nBecause Cloudflare blocks any incoming connections that aren't on the standard web ports, it also blocks the incoming connections that your streamers/DJs would use to broadcast to your station. Unlike the experience we offer listeners through our radio proxy, we can't proxy the incoming broadcast in the same way for technical reasons.\n\nWe recommend instructing your streamers/DJs to connect to your server using its IP address rather than its Cloudflare-protected domain name. This will allow them to connect without any issue, and without exposing your origin IP to your regular listener base.\n\n\n### About AzuraRelay Instances {#about-azurarelay-instances}\n\n\nIf you use AzuraRelay instances that should relay a Cloudflare-protected installation, you should use the IP address of the installation as the base URL for the relay (in a format like http://127.0.0.1), rather than the public-facing Cloudflare-protected address. Otherwise, no changes are needed.\n", "documentId": "administration/cloudflare", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/cloudflare/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/cloudflare/index.md" } ] }, { "id": "administration/storage-locations/index.md", "kind": "page", "title": "Storage Locations", "description": "Managing the storage locations of your media files, recordings and backups for your stations", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/storage-locations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/storage-locations/index.md", "file": "administration/storage-locations/index.md", "searchText": "For each station there are `Storage Locations` defined in AzuraCast for `Station Media`, `Station Recordings` and `Backups`.\n\nA `Storage Location` can be one of the following types:\n\n- Local Filesystem\n- S3-Compatible\n- Dropbox\n\n\n## S3-Compatible Storage Location {#s3-compatible-storage-location}\n\n\n\n\n> [!TIP]\n> Media processing performance varies depending on the provider you're using (Backblaze, Digital Ocean, Linode, S3, etc) so don't panic if it's taking some time.\n>\n> If the processing seems slow to you, measure the download speeds of your S3 bucket to determine if this is an issue with the S3 provider's resources before contacting us through our support methods.\n\n\n\nThis guide is aimed for smaller installations that have small storage disk sizes. Our guides will guide you through collecting the Access / Secret Keys. You'll require the following to use the S3 compatible service: `Access Key ID`, `Secret Key`, `Endpoint`, `Region`, `Bucket Name` and `API version` (API version should always be `latest`).\n\nTo configure a station to use an S3 compatible service, you'll need to go to `yourdomain.com/admin/storage_locations`, click on `edit` and then tick the `Remote: S3 Compatible` instead of `Local Filesystem`.\n\nIt'll look like this:\n\n![storage_location.png](/docs/_media/d6ca971865ada166d54c.png)\n\n\n### Amazon Simple Storage Service (S3) {#amazon-simple-storage-service-s3}\n\n\n[Amazon Simple Storage Service](https://aws.amazon.com/s3/), otherwise known as (S3) is an object storage service. [S3's pricing](https://aws.amazon.com/s3/pricing/) is more complex than the others, instead of offering a 'base' fee, it charges for what you use. You can use our small guide listed below or use Amazon's official documentation You can use our small guide to create a bucket and collect key's or use [Amazon's documentation](https://docs.aws.amazon.com/s3/index.html)\n\n- With Amazon's S3 system, you'll need to sign into the [S3 console](https://console.aws.amazon.com/s3/) and click `Create Bucket`\n- You'll be able to pick the bucket's name (Must be unique across all S3, be 3 and 63 characters long).\n- Pick a region after you've made a bucket's name.\n- You can find your access and security key within the `My Security Credentials`\n\n\n### Backblaze {#backblaze}\n\n\n[Backblaze B2 Cloud Storage](https://www.backblaze.com/b2/cloud-storage.html) is an S3-compatible service. It has a similar price plan to Amazon's S3 service but it has a [pricing calculator](https://www.backblaze.com/b2/cloud-storage-pricing.html). You can use our small guide or use [Backblaze's extensive documentation](https://help.backblaze.com/hc/en-us/categories/202640068-Backblaze-B2-Cloud-Storage) on B2 Cloud Storage.\n\n- With Backblaze you'll need to sign in and go to your Buckets page.\n- From there you can collect the S3 endpoint (Important Note: Buckets created prior to the 4th of May 2020 are not S3 compatible, if a bucket isn't compatible, create a new one)\n- You can create the Application Key ID and Application Key in the App Keys page. (Important Note: Application Key ID = Access Key | Application Key = Secret Key)\n\n\n### Digital Ocean Spaces {#digital-ocean-spaces}\n\n\n[Digital Ocean Spaces](https://www.digitalocean.com/products/spaces/) is an a S3-compatible object storage service. The [basic plan](https://www.digitalocean.com/docs/spaces/#plans-and-pricing) costs $5 for 250GB with 1 TB outbound transfer. You can use our guide listed below or use [Digital Ocean's documentation on Spaces](https://www.digitalocean.com/docs/spaces/)\n\n- To create the Spaces storage service you'll need to create an account through Digital Ocean, if you have one, you can skip this step.\n- You can create a `Spaces` from the `Create menu and it'll take you to the page. You'll need to pick a datacenter region and enable or disable the CDN (optional).\n- Finally you can choose a unique name for the Space, it has to be unique as it'll serve as your `Endpoint`.\n- You'll need to create a Access/Secret Key by following [this guide](https://www.digitalocean.com/docs/spaces/how-to/manage-access/) from Digital Ocean.\n\n\n### Linode Object Storage (S3) {#linode-object-storage-s3}\n\n\n[Linode Object Storage](https://www.linode.com/products/object-storage/) is a storage service offered by Linode and the [basic plan](https://www.linode.com/pricing/#row--storage) starts at $5 for 250 GB with 1 TB outbound transfer. You can use our small guide listed below or use [Linode's documentation on Object Storage](https://www.linode.com/docs/guides/how-to-use-object-storage/)\n\n- Fist of all you'll need to grab the access and secret key from the [Cloud Manager](https://cloud.linode.com/), and click on `Object Storage`\n- If this is the first bucket you've created with Linode, you'll need to confirm the Object Storage. (Skip this part if you have a bucket)\n- After that you'll be able to generate a Access and Secret key.\n\n\n## Dropbox Storage Location {#dropbox-storage-location}\n\n\nIn order to create a Dropbox Storage Location in AzuraCast you will first need to create an OAuth 2 access token for your Dropbox account.\n\nGo to the [Dropbox App Console](https://www.dropbox.com/developers/apps) and click on the `Create app` button.\n\nSelect the following options:\n\n- `1. Choose an API`\n - `Scoped access`\n- `2. Choose the type of access you need`\n - If you are using your Dropbox other things apart from AzuraCast use `App folder` to automatically create a separate folder in your Dropbox account for this app\n - Otherwise select `Full Dropbox`\n- `3. Name your app`\n - Give your app a name, it is recommended to choose a name specific to your radio\n \nThen click on `Create app` to finish this step.\n\nOn the now generated page for you app switch to the `Permissions` tab at the top of the page and select the following permissions:\n\n- `files.metadata.write`\n- `files.metadata.read`\n- `files.content.write`\n- `files.content.read`\n\nThen click on the `Submit` button in at the bottom of the screen.\n\nNow switch back to the `Settings` tab at the top of the page.\n\nChange the `Access token expiration` from `Short-lived` to `No expiration` and under `Generated access token` click on `Generate`.\n\nCopy the token that is now shown to you and paste it into the `Dropbox Auth Token` text box when creating a new Storage Location of type `Remote: Dropbox` in AzuraCast.\n", "documentId": "administration/storage-locations", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/storage-locations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/storage-locations/index.md" } ] }, { "id": "administration/backup-and-restore/index.md", "kind": "page", "title": "Backup & Restore", "description": "Creating backups and restoring your AzuraCast installation from them", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/backup-and-restore/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/backup-and-restore/index.md", "file": "administration/backup-and-restore/index.md", "searchText": "AzuraCast includes a built-in utility for backing up your installation, including your database, all stations and their settings, and optionally the local media tied with the station(s).\n\n\n## Ways to Backup {#ways-to-backup}\n\n\n\n### Via the Web Interface {#via-the-web-interface}\n\n\nThe \"System Administration\" section of your AzuraCast web interface has a dedicated \"Backup\" page, where you can configure periodic automated backups, run a one-time backup and download existing backup files.\n\nBackups run through the web panel do not interrupt your broadcasts or disconnect your listeners.\n\n\n### Via the Command Line {#via-the-command-line}\n\n\nIf you want more control over where your backup files are going, or want to take advantage of pre-existing tools (like cron tasks) to handle the backup, you can use the Docker Utility Tool to generate backups as well.\n\nThe most basic version of this command is:\n\n```bash\ncd /var/azuracast\n./docker.sh backup path-to-backup.zip\n```\n\nYou can also pass the --exclude-media flag to back up just the database and statistics, but not the media itself, which significantly reduces the backup file size (but you should make sure to back your media up elsewhere):\n\n```bash\ncd /var/azuracast\n./docker.sh backup path-to-backup.zip --exclude-media\n```\n\nBoth .zip and .tar.gz formats are supported for backups. The correct format will automatically be determined by the extension of the filename you specify for the backup file.\n\n\n## Restoring a Backup {#restoring-a-backup}\n\n\nThese are the general steps for restoring a backup of AzuraCast:\n\n\n\n> [!CAUTION]\n> **This may take a while...**\n>\n> Large backups (100GB+) can take a considerably long time to fully restore onto the server and *may use* large amounts of CPU and or Memory.\n\n\n\n1. Install AzuraCast ([see our guide](/docs/getting-started/installation/))\n - If you have an older backup file and encounter issues with restoring, install AzuraCast on `stable` by answering `Y` to the question \"Prefer stable release versions of AzuraCast?\"\n2. After the installation is finished, run the restore command:\n - `./docker.sh restore path-to-backup.zip`\n3. If you have used the `stable` installation due to an older backup file you should now switch back to the `rolling-release` via the following command and answer `N` to the question if you want to use the stable version:\n - `./docker.sh setup-release`\n4. Finally run the following command to update the installation to the current rolling-release version:\n - `./docker.sh update`\n", "documentId": "administration/backup-and-restore", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/backup-and-restore/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/backup-and-restore/index.md" } ] }, { "id": "administration/sync-tasks/index.md", "kind": "page", "title": "Synchronized Tasks", "description": "All about the AzuraCast automatic processing tasks", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/sync-tasks/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/sync-tasks/index.md", "file": "administration/sync-tasks/index.md", "searchText": "AzuraCast has some background tasks that are regularly triggered to run internal processing jobs that are neccessary for the operation of your stations.\n\nOn this page you will find an overview of all the `Sync Tasks` that AzuraCast depends on.\n\n\n## Increasing Execution Timeout {#increasing-execution-timeout}\n\n\nIf you are regularly running into timeouts while a sync task is processing you can manually increase the time that the sync tasks are allowed to run via the `azuracast.env` in `/var/azuracast/`.\n\nIn the `azuracast.env` look for the following entries and increase the specified time in seconds to your needs.\n\n```\n# The maximum execution time (and lock timeout) for the 15-second, 1-minute and 5-minute synchronization tasks.\n# SYNC_SHORT_EXECUTION_TIME=600\n\n# The maximum execution time (and lock timeout) for the 1-hour synchronization task.\n# SYNC_LONG_EXECUTION_TIME=1800\n```\n\nThis is how these lines should look like after changing (the values are just for demonstration):\n\n```\n# The maximum execution time (and lock timeout) for the 15-second, 1-minute and 5-minute synchronization tasks.\nSYNC_SHORT_EXECUTION_TIME=900\n\n# The maximum execution time (and lock timeout) for the 1-hour synchronization task.\nSYNC_LONG_EXECUTION_TIME=2200\n```\n\nAfter changing these entries restart your AzuraCast installation via:\n\n```bash\ndocker-compose down\ndocker-compose up -d\n```\n\n\n## Synchronized Tasks {#synchronized-tasks}\n\n\n\n### ReactivateStreamer {#reactivatestreamer}\n\n\nWhen manually disconnecting a live DJ you can let AzuraCast disable their account for a set amount of time. This task is responsible for re-activating the DJ accounts after the time has passed.\n\n\n### CheckRequests {#checkrequests}\n\n\nThis task is responsible for sending user requested songs to the Liquidsoap AutoDJ to play.\n\n\n### RunBackup {#runbackup}\n\n\nThis task is responsible for checking if a scheduled backup needs to be run.\n\n\n### CleanupRelays {#cleanuprelays}\n\n\nThis task is responsible for the automatic cleanup of relay data.\n\n\n### CheckMedia {#checkmedia}\n\n\nThis task is responsible for scanning the media storage location for newly added or modified media files that AzuraCast needs to process.\n\n\n### CheckFolderPlaylists {#checkfolderplaylists}\n\n\nThis task is responsible for automatically assigning the media of a folder to the playlist that the folder is assigned to.\n\n\n### CheckUpdates {#checkupdates}\n\n\nThis task is responsible to check if there are updates available for your AzuraCast installation\n\n\n### RunAnalytics {#runanalytics}\n\n\nThis task is responsible for updating daily listener data and analytics that can take time to calculate.\n\n\n### CleanupHistory {#cleanuphistory}\n\n\nThis task is responsible for cleaning up old listener and song history data according to the system settings.\n\n\n### CleanupStorage {#cleanupstorage}\n\n\nThis task is responsible for clearing the temporary data directory as well as checking the media storage locations for files that need to be removed.\n\n\n### RotateLogs {#rotatelogs}\n\n\nThis task is responsible for rotating logs and backup of the AzuraCast installation.\n\n\n### UpdateGeoLite {#updategeolite}\n\n\nThis task is responisble for automatically updating your GeoLite database for IP-address geolocation if you have supplied an API key.\n", "documentId": "administration/sync-tasks", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/sync-tasks/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/sync-tasks/index.md" } ] }, { "id": "administration/command-line-interface/index.md", "kind": "page", "title": "Command-Line Interface", "description": "AzuraCast features a powerful Command-Line Interface (CLI) tool that allows you to perform maintenance and troubleshooting tasks \"under the hood\".", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/command-line-interface/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/command-line-interface/index.md", "file": "administration/command-line-interface/index.md", "searchText": "AzuraCast features a powerful Command-Line Interface (CLI) tool that allows you to perform maintenance and troubleshooting tasks \"under the hood\".\n\nIn order to use the AzuraCast CLI, you must have shell terminal access to the server running AzuraCast (to the host machine, if you're running Docker).\n\nSome of these commands are only intended for developers to debug or to resolve issues, use caution when executing these commands and only do them when told to, or you know what you're doing. \n\n\n## Invoking the CLI {#invoking-the-cli}\n\n\n**Using the Docker Utility Script:**\n\nIf you're using the Docker installation method, it's recommended to download the Docker Utility Script, which will allow you to use this shorter syntax:\n\n```bash\n./docker.sh cli [command]\n```\n\n**From a Docker Installation:**\n\n```bash\ndocker-compose run --rm cli azuracast_cli [command]\n```\n\n**Ansible Installation:**\n\n```bash\nphp /var/azuracast/www/bin/console [command]\n```\n\n\n## Account Related CLI Commands {#account-related-cli-commands}\n\n\nThis section will cover all account related CLI commands and the response the CLI will provide. \n\n\n### List all accounts {#list-all-accounts}\n\n\n```bash\n(cli_command) azuracast:account:list \n\nAzuraCast User Accounts\n=======================\n\n ---------------- ------ --------------------- -------------------\n E-mail Address Name Roles Created\n ---------------- ------ --------------------- -------------------\n name@domain.com Super Administrator YYYY-MM-DD HH:MM\n ---------------- ------ --------------------- -------------------\n```\n\n\n### Create a unique login recovery URL for the specified account {#create-a-unique-login-recovery-url-for-the-specified-account}\n\n\n``` bash\n(cli_command) azuracast:account:login-token [example]\n\nGenerate Account Login Recovery URL\n===================================\n\n The account recovery URL is:\n\n https://domain/recover/hash:hash\n\n Log in using this temporary URL and set a new password using the web interface.\n```\n\n\n### Reset the password of the specified account {#reset-the-password-of-the-specified-account}\n\n\n``` bash\n(cli_command) azuracast:account:reset-password [example]\n\nReset Account Password\n======================\n\n The account password has been reset. The new temporary password is:\n\n [example]\n\n Log in using this temporary password and set a new password using the web interface.\n ```\n\n\n### Set the account specified as a global administrator {#set-the-account-specified-as-a-global-administrator}\n\n\n```bash\n(cli_command) azuracast:account:set-administrator [example]\n\nSet Administrator\n=================\n\n The account associated with e-mail address \"[example]\" has been set as an administrator\n```\n\n\n## API Related CLI Commands {#api-related-cli-commands}\n\n\nThis section will cover our API related command(s), this'll be related to your AzuraCast's API.\n\n\n### Regenerate AzuraCast's API documentation {#regenerate-azuracasts-api-documentation}\n\n\n```bash\n(cli_command) azuracast:api:docs\n\nAPI documentation updated!\n```\n\nThis command should be used when you're on a development, production or testing machine and you're making modifications to the API, this will update your API accordingly (domain/api)\n\n\n## Internal CLI Commands {#internal-cli-commands}\n\n\nThis section will cover our internal processes, such as Liquidsoap, SSL and SFTP authentication.\n\n\n### Get the external IP address for this instance {#get-the-external-ip-address-for-this-instance}\n\n\n```bash\n(cli_command) azuracast:internal:ip\n\n[example]\n```\n\nRunning this command will return the IP of this machine.\n\n\n### Handle Liquidsoap API calls {#handle-liquidsoap-api-calls}\n\n\n```bash\n(cli_command) azuracast:internal:liquidsoap [example] [example]\n```\nThis command can run various Liquidsoap API calls, this is primarily used for debugging or development purposes.\n\n\n### Reload broadcast frontends when an SSL certificate changes {#reload-broadcast-frontends-when-an-ssl-certificate-changes}\n\n\n```bash\n(cli_command) azuracast:internal:on-ssl-renewal\n```\n\n\n### Attempt SFTP Authentication {#attempt-sftp-authentication}\n\n\n```bash\n(cli_command) azuracast:internal:sftp-auth\n```\n\n\n### Send upcoming song feedback from the AutoDJ back to AzuraCast {#send-upcoming-song-feedback-from-the-autodj-back-to-azuracast}\n\n\n```bash\n(cli_command) azuracast:internal:sftp-event\n```\n\n\n## AzuraCast Settings CLI Commands {#azuracast-settings-cli-commands}\n\n\nThis section will cover our internal internal settings ranging from base URL to smtp. This can be used should you be locked out of the settings or unable to access AzuraCast directly from the browser. \n\n\n### List all settings for AzuraCast {#list-all-settings-for-azuracast}\n\n\n```bash\n(cli_command) azuracast:settings:list\n```\n\nThis command will return all the settings you can modify via the Command Line Interface, which will be shown in the next field.\n\n\n### Modify settings for AzuraCast {#modify-settings-for-azuracast}\n\n\n```bash\n(cli_command) azuracast:settings:set [example] [example]\n```\n\nThe `setting-key` parameter can be collected from the `settings:list` CLI command, this command will allow you to modify almost all portions of AzuraCast's settings, this is useful should you be having issues with misconfigured settings.\n\n\n### Manually Run AzuraCast Setup {#manually-run-azuracast-setup}\n\n\n```bash\n(cli_command) azuracast:setup [--update]\n```\n\nRuns any necessary database updates to bring your AzuraCast installation to the latest version. This is normally run automatically as part of the installation and update processes, but can be run manually for troubleshooting or local development.\n\n\n\n> [!CAUTION]\n> **This command disconnects listeners!**\n>\n> Running this command will disconnect all current active listeners to your radio stations.\n\n\n\n\n### Clear All Caches {#clear-all-caches}\n\n\n```bash\n(cli_command) cache:clear\n```\n\nClears all caches used internally by AzuraCast. This can be used as a troubleshooting step if you are encountering issues with out-of-date information appearing on dashboard pages. Note that some pages may take slightly longer to load after all caches are cleared.\n\n\n### Run Synchronization Tasks {#run-synchronization-tasks}\n\n\n```bash\n(cli_command) sync:run [nowplaying|short|medium|long]\n```\n\nManually invoke the synchronized tasks (\"cron jobs\") that normally run automatically behind the scenes to keep AzuraCast updated.\n\n- **nowplaying** corresponds to the every-15-second check of all stations' currently playing song and listener metrics\n- **short** corresponds to the every-minute sync task\n- **medium** corresponds to the every-5-minutes sync task\n- **long** corresponds to the every-hour sync task\n\n\n## Station Specific Commands {#station-specific-commands}\n\n\n\n### Manually Reprocess All Media {#manually-reprocess-all-media}\n\n\n```bash\n(cli_command) azuracast:media:reprocess\n```\n\nIterates through all stations' media directories and manually reloads the metadata information stored inside AzuraCast with the latest data on the files themselves. This is useful for troubleshooting songs that are stuck in \"Processing\" status, or if you have recently uploaded multiple songs via SFTP.\n\n\n### Restart All Radio Stations {#restart-all-radio-stations}\n\n\n```bash\n(cli_command) azuracast:radio:restart\n```\n\nShuts down both the frontends (Icecast, Shoutcast, etc) and backends (Liquidsoap) of all radio stations, rewrites their configuration files, then relaunches them. This is identical to the \"Restart Broadcasting\" command inside the web interface.\n\n\n\n> [!CAUTION]\n> **This command disconnects listeners!**\n>\n> Running this command will disconnect all current active listeners to your radio stations.\n\n\n\nThese tasks can also be invoked directly from the web interface via the Administration homepage.\n\n\n## Other Commands {#other-commands}\n\n\nThe AzuraCast CLI interface also exposes a number of other advanced commands. These commands are intended for developers to use when building the application, and often should not be run by station owners on production installations.\n\nFor a full list of AzuraCast CLI commands, view them [here](https://github.com/AzuraCast/AzuraCast/blob/main/backend/config/cli.php).\n\nFor more information about the additional command line tools available, see their respective documentation pages below:\n- [Doctrine Command Line Reference](https://www.doctrine-project.org/projects/doctrine-orm/en/3.2/reference/tools.html)\n- [Doctrine Migrations](https://www.doctrine-project.org/projects/doctrine-migrations/en/3.8/reference/introduction.html)\n", "documentId": "administration/command-line-interface", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/command-line-interface/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/command-line-interface/index.md" } ] }, { "id": "administration/users/index.md", "kind": "page", "title": "Users", "description": "User management for the web interface of AzuraCast", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/users/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/users/index.md", "file": "administration/users/index.md", "searchText": "\n\n> [!TIP]\n> **Required Permissions**\n>\n> To manage users, users must be in a role that has the \"Administer Users\" permission globally.\n\n\n\nFrom the \"Users\" administration panel, you can modify any existing users or create new ones. You can modify the roles that any given user are a part of, and force a password change in the event the user has forgotten their password.\n\n\n## Resetting an Account Password {#resetting-an-account-password}\n\n\nIf you have lost the password to log into an account, but still have access to the SSH terminal for the server, you can execute the following command to generate a new random password for an account in the system.\n\nReplace `YOUREMAILADDRESS` with the e-mail address whose password you intend to reset.\n\n```bash\ncd /var/azuracast\n./docker.sh cli azuracast:account:reset-password YOUREMAILADDRESS\n```\n", "documentId": "administration/users", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/users/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/users/index.md" } ] }, { "id": "administration/roles-and-permissions/index.md", "kind": "page", "title": "Roles & Permissions", "description": "AzuraCasts Access Control List (ACL) system allows you to control the specific permissions of each group of users", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/roles-and-permissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/roles-and-permissions/index.md", "file": "administration/roles-and-permissions/index.md", "searchText": "\n\n> [!TIP]\n> **Required Permissions**\n>\n> To manage roles and permissions, users must be in a role that has the \"Administer Permissions\" permission globally.\n\n\n\nAzuraCast has a highly granular Access Control List (ACL) system that allows you to control the specific permissions of each group of users.\n\nIn summary, you can think of the access control list as working this way:\n\n- One or more **Users** can be in a **Role**.\n- Each **Role** has one or more **Permissions**, which gives everyone in that Role that level of access. Permissions can either be specific to a single station, or global for the entire installation.\n\nThe Roles & Permissions page has protections in place to prevent users from accidentally denying themselves permissions to the Permissions page itself.\n\n\n## Special Permissions {#special-permissions}\n\n\nThere are special permissions that will grant access to other sections of the system, even when you don't explicitly grant those lower-level permissions to each user:\n\n- The **All Permissions** global permission creates a super-user with access to all of the AzuraCast installation, and the **All Permissions** station-specific permission creates a super-user with full access to that specific station only.\n- The **Manage Stations** global permission also allows the user to administer any stations that exist in the AzuraCast installation.\n\n\n## Feature-Specific Permission Requirements {#feature-specific-permission-requirements}\n\n\nAzuraCast has robust permission controls that prevent unauthorized access to critical station features:\n\n- **Skip Current Track**: Requires the user to have the `manage station broadcasting` permission for a station.\n- **Play Song Now / Add to Queue**: Requires the user to have the `manage station media` permission for a station.\n- **Deleting Media**: While any user with the `manage station media` permission can visit the station's Media Manager interface, only users with the `delete station media` permission can remove existing files.\n", "documentId": "administration/roles-and-permissions", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/roles-and-permissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/roles-and-permissions/index.md" } ] }, { "id": "administration/customization/index.md", "kind": "page", "title": "Using Custom JavaScript", "description": "AzuraCast provides you with the possibility to add custom JS via the Custom Branding page at /admin/branding.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/customization/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/customization/index.md", "file": "administration/customization/index.md", "searchText": "\n## Custom JavaScript for Public Pages {#custom-javascript-for-public-pages}\n\n\nAzuraCast provides you with the possibility to add custom JS via the `Custom Branding` page at `/admin/branding`.\n\nThere you can add your own JavaScripts to the public pages with the editor for `Custom JS for Public Pages`.\n\nYou can attach to events of the public player like this:\n\n```javascript\n$(document).on('now-playing', function(np_new) {\n // custom code with np_new\n});\n```\n\n\n### Example: Video Playback for Public Page {#example-video-playback-for-public-page}\n\n\nYou can use `Custom JS for Public Pages` to add a video element to the page and style via the `Custom CSS for Public Pages` using our example below.\n\n**Custom CSS for Public Pages**\n\n```css\n[data-theme] body.page-minimal .background-video {\n\twidth: 100vw;\n\theight: 100vh;\n\tobject-fit: cover;\n\tposition: fixed;\n\tleft: 0;\n\tright: 0;\n\ttop: 0;\n\tbottom: 0;\n\tz-index: -1;\n}\n```\n\n**Custom JS for Public Pages**\n\n```javascript\nlet videoBackgroundElement = document.createElement('video');\nvideoBackgroundElement.autoplay = true;\nvideoBackgroundElement.loop = true;\nvideoBackgroundElement.muted = true;\nvideoBackgroundElement.poster = 'Enter.URL.Here';\nvideoBackgroundElement.className = 'background-video';\n\nlet videoBackgroundSource = document.createElement('source');\nvideoBackgroundSource.src = 'Enter.URL.Here';\nvideoBackgroundSource.type = 'video/mp4';\n\nvideoBackgroundElement.appendChild(videoBackgroundSource);\n\ndocument.body.append(videoBackgroundElement);\n```\n", "documentId": "administration/customization", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/customization/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/customization/index.md" } ] }, { "id": "administration/css/index.md", "kind": "page", "title": "Using Custom CSS", "description": "AzuraCast provides you with the possibility to customize the default CSS via the Custom Branding page at /admin/branding.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/css/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/css/index.md", "file": "administration/css/index.md", "searchText": "\n\n> [!TIP]\n> **An important change in newer versions...**\n>\n> In version 0.19.0, we switched from an old style system to a newer version of Bootstrap, and in the process, the prefix on the commands below changed from `[data-theme]` to `[data-bs-theme]`. You should update any custom CSS you're using accordingly.\n\n\n\nAzuraCast provides you with the possibility to customize the default CSS via the `Custom Branding` page at `/admin/branding`.\n\nThere you can alter the styling of the internal and public pages via your own CSS with the editors for `Custom CSS for Public Pages` and `Custom CSS for Internal Pages`.\n\nThis page will give you a simple overview of the CSS classes and ids used in the HTML of AzuraCast that you can then use in your own CSS to customize those elements.\n\nIf you have no prior experience with CSS take a look at the [MDN Web Docs](https://developer.mozilla.org/en-US/docs/Web/CSS) about CSS.\n\n\n## Note about Automatic Theme Detection {#note-about-automatic-theme-detection}\n\n\nAzuraCast now has a built-in feature where it will automatically detect the user's preferred color scheme from their browser via a CSS media query. It's recommended that if you intend to customize your public pages, you disable this by visiting the `Custom Branding` page and setting a specific theme for public pages that isn't \"Prefer System Default\".\n\nThe instructions below assume that this change has been made already.\n\n\n## Custom CSS for Public Pages {#custom-css-for-public-pages}\n\n\nEach station's public pages have a class applied to the `` element that follows the format `station-`.\n\nSo if you have a station called `My Radio`, this class would be `station-my_radio`. You can use this to define CSS styles that should only apply to a single station by prefixing your CSS selectors like this:\n\n```css\n# Targeting either dark or light themed pages\n[data-bs-theme] body.station-my_radio {\n ...\n}\n\n# Targeting only light themed pages\n[data-bs-theme=\"light\"] body.station-my_radio {\n ...\n}\n\n# Targeting only dark themed pages\n[data-bs-theme=\"dark\"] body.station-my_radio {\n ...\n}\n```\n\n\n### Changing the background image {#changing-the-background-image}\n\n\nThe CSS for the background image on public pages is defined like this:\n\n```css\n# See above for theme-specific prefixes\n[data-bs-theme] body.page-minimal {\n background: #edecec url(../img/hexbg.png);\n background-size: cover;\n background-attachment: fixed;\n}\n```\n\nYou can change the background image by using the same CSS selector and then just overwrite the `background` attribute like this:\n\n```css\n[data-bs-theme] body.page-minimal {\n background: url(https://example.com/my_custom_background_image.png);\n}\n```\n\n\n### Styling the radio player {#styling-the-radio-player}\n\n\nYou can change the background color of the radio player like this:\n\n```css\n[data-bs-theme] body.page-minimal .public-page .card {\n background-color: #5e0f16;\n}\n```\n\nThe CSS selector for the title of the player is as follows:\n\n```css\n[data-bs-theme] body.page-minimal .public-page .card .card-body .card-title {\n ...\n}\n```\n\nThe buttons at the bottom of the player can be styled with the following CSS selector:\n\n```css\n[data-bs-theme] body.page-minimal .public-page .card .card-actions .btn {\n ...\n}\n```\n\nThe elements of the player itself are found in the `radio-player-widget` class and are separated further under `now-playing-details` and `radio-controls`.\n\nAs an example on how to customize those elements this page provides you with a short snippet for one element of each part of the player widget. For more detailed information it is recommended to directly look at the HTML of the page via your browsers HTML inspector.\n\nThis example shows you how to change the text color of the title and artist:\n\n```css\n[data-bs-theme] body.page-minimal .public-page .card .now-playing-title {\n color: #fff;\n}\n\n[data-bs-theme] body.page-minimal .public-page .card .now-playing-artist {\n color: #fefefe;\n}\n```\n\nThis example shows you how to change the color of the play button:\n\n```css\n[data-bs-theme] body.page-minimal .public-page .card .radio-control-play-button a {\n color: #000;\n}\n```\n\n\n### Styling the modals for Song History & Song Requests {#styling-the-modals-for-song-history--song-requests}\n\n\nTo change the background color of the modals you can use the following CSS selector:\n\n```css\n[data-bs-theme] body.page-minimal .modal .modal-content {\n background-color: #5e0f16;\n}\n```\n\nTo change the text color of the title use the following CSS selector:\n\n```css\n[data-bs-theme] body.page-minimal .modal .modal-content .modal-title {\n color: #fff;\n}\n```\n\nTo change the background color of the pagination use the following CSS selector:\n\n```css\n[data-bs-theme] body.page-minimal .modal .modal-content .pagination {\n background: #3d3d3d;\n}\n```\n\nThe text color of the Song Requests table header and rows can be changed like this:\n\n```css\n[data-bs-theme] body.page-minimal .modal .modal-content .table thead {\n color: #fff;\n}\n\n[data-bs-theme] body.page-minimal .modal .modal-content .table tbody {\n color: #fff;\n}\n```\n\n\n## Custom CSS for Internal Pages {#custom-css-for-internal-pages}\n\n\nThe internal pages can also be conditonally styled for the dark and light theme like it is done for the public pages:\n\n```css\n[data-bs-theme=\"light\"] body {\n ...\n}\n\n[data-bs-theme=\"dark\"] body {\n ...\n}\n```\n\n\n### Changing the color of the top navigation {#changing-the-color-of-the-top-navigation}\n\n\nIf you want to change the color of the top navigation you can use the following CSS selector to use your own color and remove the background image:\n\n```css\n[data-bs-theme] header.navbar {\n background-image: none;\n background: #3d3d3d;\n}\n```\n\n\n### Changing the card header color {#changing-the-card-header-color}\n\n\nMost cards and some other elements in the internal pages have a blue background color. In order to change this color you can use the following CSS selector:\n\n```css\n[data-bs-theme] .bg-primary-dark {\n background-color: #5e0f16 !important;\n}\n```\n", "documentId": "administration/css", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/css/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/css/index.md" } ] }, { "id": "administration/multi-site-installation/index.md", "kind": "page", "title": "Multi-Site Docker Installation", "description": "If you use the recommended Docker installation method for AzuraCast, you can configure your installation to sit behind a nginx proxy that can also handle other web sites on the same host. This allows you to host, for example, your station's web site on the same server as your AzuraCast installation.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/multi-site-installation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/multi-site-installation/index.md", "file": "administration/multi-site-installation/index.md", "searchText": "If you use the recommended Docker installation method for AzuraCast, you can configure your installation to sit behind a nginx proxy that can also handle other web sites on the same host. This allows you to host, for example, your station's web site on the same server as your AzuraCast installation.\n\nFollow the steps below to configure your installation for multisite support.\n\n\n## Nginx Proxy Manager {#nginx-proxy-manager}\n\n\nMost users prefer to use a proxy manager that includes a GUI for easier management of the proxy. There are a lot of different tools for this, one of which is the [Nginx Proxy Manager](https://nginxproxymanager.com/), which uses NGINX and includes an easy to use GUI and automatic Let's Encrypt SSL which should be sufficient for most users.\n\n\n### Enter AzuraCast Base Directory {#enter-azuracast-base-directory}\n\n\nConnect to your server via SSH and change to the base directory where your AzuraCast installation is located. If you followed the recommended installation instructions (or used a prebuilt image) you can run:\n\n```bash\ncd /var/azuracast\n```\n\n\n### Turn Off Existing Services {#turn-off-existing-services}\n\n\nWhile you're making these configuration changes, your Docker containers should be turned off. Turn off your existing Docker containers by running:\n\n```bash\ndocker-compose down\n```\n\nThis will disconnect your listeners and stop your station from broadcasting. You will not lose any data or statistics during the upgrade.\n\n\n### Edit AzuraCast Web Serving Ports {#edit-azuracast-web-serving-ports}\n\n\nThe first step is to prevent AzuraCast's own `web` container from trying to listen on ports 80 and 443, as a proxy will now be doing that job instead.\n\nThere is a file in the AzuraCast installation directory named `.env` which has two values set by default:\n\n```\nAZURACAST_HTTP_PORT=80\nAZURACAST_HTTPS_PORT=443\n```\n\n\n\n> [!TIP]\n> **Note the filename!**\n>\n> This file is actually named `.env`, not `azuracast.env`, which is a separate file. Most Linux hosts will hide the `.env` file by default, but you can still see it by running `ls -lah` or edit it with a command like `vim .env`.\n\n\n\n**Edit the `.env` file** in your editor of choice to change those values to an unused public-facing port. A good option would be the examples below:\n\n```\nAZURACAST_HTTP_PORT=10080\nAZURACAST_HTTPS_PORT=10443\n```\n\nSave your changes and return to the shell.\n\n\n### Start Docker Services {#start-docker-services}\n\n\nTurn the Docker AzuraCast containers back on to resume broadcasting with the new setup:\n\n```bash\ndocker-compose up -d\n```\n\n\n### Setup Nginx Proxy Manager {#setup-nginx-proxy-manager}\n\n\nCreate a new directory for the Nginx Proxy Manager and enter it via the following commands:\n\n```bash\nmkdir /var/proxy_manager\ncd /var/proxy_manager\n```\n\nThen create a file with the name `docker-compose.yml` in this directory (for example with `nano`) like this:\n\n```bash\nnano docker-compose.yml\n```\n\nNow follow the [Quick Setup](https://nginxproxymanager.com/guide/#quick-setup) for the Nginx Proxy Manager starting with step `2`.\n\n\n### Create Proxy Host for AzuraCast {#create-proxy-host-for-azuracast}\n\n\nWhen you have successfully setup the Nginx Proxy Manager and have access to the GUI you can start creating a proxy for AzuraCast via the `Proxy Hosts` page.\n\nClick on the `Create Proxy Host` button, enter a domain that points to the server in the `Domain Names` field.\n\nIn the \"Scheme\" field, select `https`. In \"Forward Hostname/IP\", enter the public-facing IP of your server (not the domain name). In \"Forward Port\", enter the same port you specified above for AzuraCast (in our example, 10443).\n\nEnable the `Websockets Support` option.\n\nSwitch to the `SSL` tab and select `Request a new SSL Certificate` in the `SSL Certificate` dropdown.\n\nEnable the `Force SSL` as well as the `HTTP/2 Support` options, enter your e-mail address, agree to the Let's Encrypt Terms of Service and click on the `Save` button.\n", "documentId": "administration/multi-site-installation", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/multi-site-installation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/multi-site-installation/index.md" } ] }, { "id": "administration/azurarelay/index.md", "kind": "page", "title": "AzuraRelay", "description": "AzuraRelay is \"relay in a box\" containing a lightweight web application and Icecast servers that can connect to and relay an AzuraRelay parent instance.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/administration/azurarelay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/azurarelay/index.md", "file": "administration/azurarelay/index.md", "searchText": "AzuraRelay is \"relay in a box\" containing a lightweight web application and Icecast servers that can connect to and relay an AzuraRelay parent instance.\n\nIf you want to offer your streams to users around the world or accept a large volume of incoming traffic, AzuraRelay is the perfect companion to AzuraCast.\n\n\n## Parent Installation Requirements {#parent-installation-requirements}\n\n\nBefore installing AzuraRelay, make sure your \"parent\" AzuraCast installation:\n\n- is updated to the latest version,\n- has the direct radio ports (i.e. 8000, 8010) exposed (i.e. isn't behind a CloudFlare proxy)\n\n\n## System Requirements {#system-requirements}\n\n\n- A 64-bit x86 (x86_64) CPU (ARM devices, like the Raspberry Pi 3/4, are not supported.)\n- 512MB or greater of RAM\n- 20GB or greater of hard drive space\n\nFor Linux hosts, the `sudo`, `curl` and `git` packages should be installed before installing . Most Linux distributions include these packages already.\n\n\n## Installing {#installing}\n\n\nAzuraRelay is powered by Docker and uses pre-built images that contain every component of the software. Don't worry if you aren't very familiar with Docker; our easy installer tools will handle installing Docker and Docker Compose for you, and updates are very simple.\n\nConnect to the server or computer you want to install AzuraRelay on via an SSH terminal. You should be an administrator user with either root access or the ability to use the `sudo` command.\n\nPick a base directory on your host computer that AzuraRelay can use. If you're on Linux, you can follow the steps below to use the recommended directory:\n\n```bash\nmkdir -p /var/azurarelay\ncd /var/azurarelay\n```\n\nUse these commands to download our Docker Utility Script, set it as executable and then run the Docker installation process:\n\n```bash\ncurl -L https://raw.githubusercontent.com/AzuraCast/AzuraRelay/main/docker.sh > docker.sh\nchmod a+x docker.sh\n./docker.sh install\n```\n\nOn-screen prompts will show you how the installation is progressing.\n\n\n## Updating {#updating}\n\n\nUsing the included Docker utility script, updating is as simple as running:\n\n```bash\n./docker.sh update-self\n./docker.sh update\n```\n", "documentId": "administration/azurarelay", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/administration/azurarelay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/administration/azurarelay/index.md" } ] }, { "id": "developers/getting-started/index.md", "kind": "page", "title": "Getting Started", "description": "Developing with AzuraCast", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/developers/getting-started/", "markdown": "https://sourcey-azuracast.pages.dev/docs/developers/getting-started/index.md", "file": "developers/getting-started/index.md", "searchText": "Development on the main AzuraCast application should always be applicable to a broad community of radio station operators and not specific features to one station or group of stations.\n\nIf you would like to build a set of features specific to one station or group of stations, you should take advantage of AzuraCast's plugin architecture. The plugin system takes advantage of event listeners that are built into AzuraCast itself. Check out the [example plugin](https://github.com/AzuraCast/example-plugin) for more details on what is possible via plugins.\n\n\n## Contributing Code Changes {#contributing-code-changes}\n\n\nAzuraCast is open-source software, and as part of this dedication to openness and transparency, we fully support contributions from members of the community who are skilled in the languages that we use to build our applications.\n\nA majority of our repositories come with an `.editorconfig` file in the root, which will set many standards for indentation, punctuation and other style items for you automatically. You may need to enable EditorConfig support in your IDE of choice.\n\nIf your IDE does not support EditorConfig, the most important standard to remember that we follow is the PHP Framework Interoperability Group's [PSR-12 Extended Coding Style](https://www.php-fig.org/psr/psr-12/) standard.\n\nAccessibility, security, and modern best practices are very important in AzuraCast's development. Any newly contributed code can, and should, take advantage of the full suite of new features made available in PHP 8.0 and newer.\n\nContributions are also welcome in the supporting technologies used to make AzuraCast possible, such as:\n\n- Dockerfiles (see [our separate repositories](https://github.com/AzuraCast) for Docker containers)\n- [Ansible configuration](https://github.com/AzuraCast/AzuraCast/tree/master/util/ansible) for Ansible installs\n\n\n## Setting Up a Local Environment {#setting-up-a-local-environment}\n\n\nRegardless of your host operating system, it's highly recommended to use **Docker** when developing locally, as it offers portability, convenience, and a very close approximation of how AzuraCast runs on production environments.\n\nFor the steps below, we're assuming you've created a folder where you will store all of your AzuraCast-related projects, like `/home/myuser/azuracast/`.\n\nYou will need Git and Docker installed locally. If you're on Windows or Mac, the best way to use Docker is via the native [Docker Desktop](https://www.docker.com/products/docker-desktop) applications for those platforms.\n\nFor Windows, an installer tool like [Scoop](https://scoop.sh/) is highly recommended for dependencies like Git and your terminal of choice. A third-party shell client like Cmder is also often helpful.\n\n\n### Clone the Core Repository {#clone-the-core-repository}\n\n\nUsing Git, clone the AzuraCast core repository into a subfolder of your working directory.\n\n> **Note for Windows developers:** Before cloning the repositories, you should ensure your Git is locally configured to not automatically convert line endings from Linux style (LF) to Windows style (CRLF), which will break AzuraCast. You can set this globally by running:\n> \n> ```bash\n> git config --global core.autocrlf input\n> ```\n\nTo do this, your initial command should look like:\n\n```bash\ngit clone https://github.com/AzuraCast/AzuraCast.git\n```\n\n\n### Setup via Docker Utility Script {#setup-via-docker-utility-script}\n\n\nWe have added a developer-specific helper tool to our Docker Utility Script that takes care of a lot of the common setup tasks for you. This script will copy the default environment configuration files, clone the additional repositories, and even install Docker and Docker Compose for you if they aren't installed already.\n\nFrom the previous command, you can run this script by running:\n\n```bash\ncd AzuraCast\nbash docker.sh install-dev\n# Alternatively, you can use `make install` if `make` is installed on your system\n```\n\n\n### Modify the Environment File {#modify-the-environment-file}\n\n\nDuring the developer setup process, if you haven't done so already, you will be prompted to customize your `azuracast.env` file to make sure the proper values are input into this file.\n\nMany of the values left blank by default are what are called \"fixtures\", which will automatically populate parts of the database upon initial installation, saving you the trouble of setting those values up every time you reset your database or code.\n\nIf you want to populate those values, you can modify them in the `azuracast.env` file, where they will look like the fields below:\n\n```\nINIT_BASE_URL=http://azuracast.local\nINIT_INSTANCE_NAME=\"local development\"\nINIT_ADMIN_EMAIL=\nINIT_ADMIN_PASSWORD=\n... etc.\n```\n\nWhen initializing a development instance, AzuraCast will create both a standard demo account and system admin user profile, using the values set in `azuracast.env` if provided. `INIT_DEMO_API_KEY` and `INIT_ADMIN_API_KEY` are associated with the demo and admin users respectively, and should be a valid split-token key. The default login credentials for the demo user are `demo@azuracast.com` with password `demo`. Additionally, AzuraCast will create a demo station AzuraTest Radio (`azuratest_radio`) that will use the defined `INIT_MUSIC_PATH` and `INIT_PODCASTS_PATH`.\n\nIf you would prefer to follow the traditional post-installation setup process instead, just remove any fields from the `azuracast.env` file that start with `INIT_`.\n\nFollowing these steps, re-run the prior command (`bash docker.sh install-dev` or `make install`) to build the Docker image and run the containers. After the script finishes (as indicated by `✔ Container azuracast Started`), you may need to wait a few more minutes for the initialization process to finish running. You can check the progress by running `docker logs -f azuracast`.\n\n\n## Common Tasks {#common-tasks}\n\n\nMany common tasks are made simpler by the addition of a `Makefile` to our core repository. It's strongly recommended to install `make` on your host OS or inside WSL.\n\n\n### Rebuilding the Docker Images {#rebuilding-the-docker-images}\n\n\nBy default, developer installations bind mount the current code from your local computer into the Docker container, so changes to the code will be visible immediately in the running web application.\n\nIf you need to make changes to the containers themselves, though, or your containers get out of date with the ones in our repositories, you can rebuild them by running:\n\n```bash\ndocker-compose build\n# OR\nmake build\n```\n\nYou should then restart your installation by running:\n\n```bash\ndocker-compose down\ndocker-compose up -d\n# OR\nmake restart\n```\n\nIf you want to fully rebuild, restart, and re-run the setup process after a Docker image change, you can run all of those as one command:\n\n```bash\nmake update\n```\n\n\n### Building Static Assets {#building-static-assets}\n\n\nAzuraCast automatically builds static assets as they're changed in the dev environment. Modifications inside the `/frontend` folder are automatically watched and rebuilt when developing, then compiled down into static files as part of our Docker image build process.\n\n\n### Accessing `bash` Inside the Container {#accessing-bash-inside-the-container}\n\n\nIt is common to need to access the bash shell inside the running `web` container in order to see or modify the current state of the application while it's running.\n\nThere is a helper command you can run using the Docker Utility Script to easily accomplish this:\n\n```bash\nbash docker.sh bash\n# OR\nmake bash\n```\n\n\n### Customize Local SSL {#customize-local-ssl}\n\n\nOut of the box, AzuraCast comes with a self-signed SSL certificate that you can use for local development. Most browsers will complain about this, but you can add an exception to allow you to proceed anyway.\n\nIf you want to use a valid SSL certificate on your local installation, we highly recommend a tool called [mkcert](https://github.com/FiloSottile/mkcert).\n\nWe commonly use this tool to register a local SSL-enabled domain at `azuracast.local`. You will need to edit your `/etc/hosts` file to point this domain to your own computer as a one-time change.\n\nThe process for installing this certificate into the AzuraCast ecosystem looks like this command, run from the main repository's project root:\n\n```bash\nmkcert -cert-file util/local_ssl/azuracast.local.crt -key-file util/local_ssl/azuracast.local.key azuracast.local\n```\n\nTo make your new certificate take effect, you will need to restart the Docker containers using:\n\n```bash\ndocker-compose down\ndocker-compose up -d\n# OR\nmake restart\n```\n\n\n## Translations (Locales) {#translations-locales}\n\n\nLocales are managed by the application in two places: the backend PHP code and the frontend (primarily Vue.js) JavaScript code. When new locales are added or translations are changed, they should be processed in both locations.\n\nThere are two steps to the translation process:\n\n\n### Generating New Translations {#generating-new-translations}\n\n\nWhen new strings have been added to the application, they should be added to the .POT (localization template) file, so that our CrowdIn translation service recognizes it as a translatable string.\n\n```bash\nbash docker.sh cli locale:generate\n# OR\nmake generate-locales\n```\n\n\n### Import New Translated Strings {#import-new-translated-strings}\n\n\nWhen strings have been translated, they should be converted back into optimized files that can easily be read by the PHP and Vue.js parts of the application, respectively.\n\n```bash\nbash docker.sh cli locale:import\n# OR\nmake import-locales\n```\n", "documentId": "developers/getting-started", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/developers/getting-started/", "markdown": "https://sourcey-azuracast.pages.dev/docs/developers/getting-started/index.md" } ] }, { "id": "developers/apis/index.md", "kind": "page", "title": "AzuraCast APIs", "description": "All about the APIs of AzuraCast", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/developers/apis/", "markdown": "https://sourcey-azuracast.pages.dev/docs/developers/apis/index.md", "file": "developers/apis/index.md", "searchText": "Once installed and running, AzuraCast exposes an API that allows you to monitor and interact with your stations. You can perform the following functions and more from the JSON REST API:\n\n- View now-playing data and recent song history for all stations\n- View general station information\n- Submit song requests (if allowed by the station)\n- Start, stop and restart stations individually\n\n\n## Per-Install API Documentation {#per-install-api-documentation}\n\n\nEach AzuraCast installation includes documentation for the API at the exact version it's currently using. In our public documentation, we include the API as of the latest Rolling Release version.\n\n- [View API Documentation](/docs/api/)\n\n\n## API Authentication {#api-authentication}\n\n\nIf you're accessing sensitive information or modifying the server, you will be required to authenticate your API requests with an authorization key.\n\nYou can create an API key from the AzuraCast web interface, by clicking the user menu in the top right and clicking \"My API Keys\". Any API keys you create will share the same permissions that you have as a user.\n\nThe preferred method of authenticating is to send the following header along with your API request:\n\n```\nAuthorization: Bearer your_api_key_here\n```\n\nYou can also include the API key in the `X-API-Key` header if desired.\n\n\n## Now Playing Data APIs {#now-playing-data-apis}\n\n\nThe most important and frequently accessed pieces of information that AzuraCast stores are all served as part of a single group of data, which we refer to as the \"Now Playing\" data.\n\nBecause of how valuable this information is, we serve it in a number of ways depending on whether performance or flexibility is your main concern.\n\nCheck out our [Now Playing Data APIs](/docs/developers/now-playing-data/) page for more detailed information on these APIs.\n\n\n## SDKs & API clients {#sdks--api-clients}\n\n\n\n### PHP {#php}\n - Packagist: [`azuracast/php-api-client`](https://packagist.org/packages/azuracast/php-api-client)\n - GitHub: https://github.com/AzuraCast/php-api-client\n", "documentId": "developers/apis", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/developers/apis/", "markdown": "https://sourcey-azuracast.pages.dev/docs/developers/apis/index.md" } ] }, { "id": "developers/now-playing-data/index.md", "kind": "page", "title": "Now Playing Data APIs", "description": "The most important and frequently accessed pieces of information that AzuraCast stores are all served as part of a single group of data, which we refer to as the \"Now Playing\" data.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/developers/now-playing-data/", "markdown": "https://sourcey-azuracast.pages.dev/docs/developers/now-playing-data/index.md", "file": "developers/now-playing-data/index.md", "searchText": "The most important and frequently accessed pieces of information that AzuraCast stores are all served as part of a single group of data, which we refer to as the \"Now Playing\" data.\n\nThis data includes:\n\n - Basic information about the station, its mount points and remote relays;\n - Current listener counts, including total and unique listeners;\n - The currently playing song, including a timestamp of when it was started, and whether it came from a playlist, request, or live source;\n - Whether a live DJ is currently connected, and if so, what their name is; and\n - A truncated history of the most recent ~5 songs (this number is customizable) played on the station.\n\nHere's a [real-world example of the Now Playing API's return data](https://demo.azuracast.com/api/nowplaying_static/azuratest_radio.json) from the AzuraCast demo page.\n\nAzuraCast always serves this data in the exact same format, regardless of whether you're broadcasting locally or remotely, or whether you're using Icecast or Shoutcast.\n\nBecause of how valuable this information is, we serve it in a number of ways depending on whether performance or flexibility is your main concern.\n\n\n## Standard Now Playing API {#standard-now-playing-api}\n\n\nThis is the \"Now Playing\" API endpoint listed as part of the [API documentation](/docs/api/). On any installation, an array of now-playing data for all public stations is available at:\n\n```\nhttp://your-azuracast-site.example.com/api/nowplaying\n```\n\nThe now-playing data for a specific station is available at:\n\n```\nhttp://your-azuracast-site.example.com/api/nowplaying/station_shortcode\n```\n\nFor a more performance-optimized (but slightly more delayed) static version of the now-playing data, use this URL format instead:\n\n```\nhttp://your-azuracast-site.example.com/api/nowplaying_static/station_shortcode.json\n```\n\n...replacing `station_shortcode` with either the station's abbreviated name (i.e. `azuratest_radio` for \"AzuraTest Radio\") or the numeric ID of the station (visible in the URL when managing the station in AzuraCast).\n\n\n### Elapsed/Remaining Time {#elapsedremaining-time}\n\n\nFor performance reasons, AzuraCast caches the Now Playing API endpoint's responses for a few seconds after the first uncached request is made. This allows our web server (nginx) to serve subsequent requests, substantially improving throughput and allowing installations to serve many more listeners.\n\nBecause of this, the `elapsed` and `remaining` time on the current playing track may not be accurate as of the exact time you're making the API request. In order to ensure their accuracy, it is recommended to calculate these values client-side in your calling code.\n\nYou can compare this to the calling client's UNIX timestamp, but it may be a little different than the AzuraCast installation's server clock time. To ensure better accuracy, we recommend infrequently calling the `time` API endpoint to retrieve the server's current UNIX timestamp:\n\n```\nhttp://your-azuracast-site.example.com/api/time\n```\n\nOur example implementation code below includes this functionality.\n\n\n### Example Implementation {#example-implementation}\n\n\nUsing the [jQuery](https://jquery.com/) JavaScript library, an example implementation might look like:\n\n```javascript\nlet nowPlayingTimeout = null;\nlet nowPlaying = {};\nlet checkTimeTimeout = null;\nlet currentTimestamp = Math.floor(Date.now() / 1000);\n\nfunction checkTime() {\n $.ajax({\n cache: false,\n dataType: \"json\",\n url: \"http://your-azuracast-site.example.com/api/time\",\n success: function(data) {\n currentTimestamp = data.timestamp;\n checkTimeTimeout = setTimeout(checkTime, 600000);\n },\n }).fail(function() {\n currentTimestamp = Math.floor(Date.now() / 1000);\n checkTimeTimeout = setTimeout(checkTime, 1200000);\n });\n}\n\nfunction loadNowPlaying() {\n $.ajax({\n cache: false,\n dataType: \"json\",\n url: 'http://your-azuracast-site.example.com/api/nowplaying/station_shortcode',\n success: function(np) {\n // Update the elapsed/remaining time.\n const currentTrackPlayedAt = np.now_playing?.played_at ?? 0;\n const currentTrackDuration = np.now_playing?.duration ?? 0;\n\n if (currentTrackPlayedAt !== 0) {\n let elapsed = currentTimestamp - currentTrackPlayedAt;\n\n if (elapsed < 0) {\n elapsed = 0;\n } else if (elapsed >= currentTrackDuration) {\n elapsed = currentTrackDuration;\n }\n\n np.now_playing.elapsed = elapsed;\n np.now_playing.remaining = currentTrackDuration - elapsed;\n }\n\n // Do something with the Now Playing data.\n nowPlaying = np;\n\n nowPlayingTimeout = setTimeout(loadNowPlaying, 15000);\n }\n }).fail(function() {\n nowPlayingTimeout = setTimeout(loadNowPlaying, 30000);\n });\n}\n\n$(function() {\n checkTime();\n loadNowPlaying();\n\n setInterval(\n () => {\n currentTimestamp += 1;\n },\n 1000\n );\n});\n```\n\nUsing the [Axios](https://github.com/axios/axios) HTTP client library, an example implementation might look like:\n\n```javascript\nlet nowPlayingTimeout = null;\nlet nowPlaying = {};\nlet checkTimeTimeout = null;\nlet currentTimestamp = Math.floor(Date.now() / 1000);\n\nfunction checkTime() {\n axios.get('http://your-azuracast-site.example.com/api/time').then((response) => {\n // Do something with the Now Playing data.\n currentTimestamp = response.data.timestamp;\n }).catch((error) => {\n console.error(error);\n }).then(() => {\n clearTimeout(checkTimeTimeout);\n checkTimeTimeout = setTimeout(checkTime, 600000);\n });\n}\n\nfunction loadNowPlaying() {\n axios.get('http://your-azuracast-site.example.com/api/nowplaying/station_shortcode').then((response) => {\n let np = response.data;\n\n // Update the elapsed/remaining time.\n const currentTrackPlayedAt = np.now_playing?.played_at ?? 0;\n const currentTrackDuration = np.now_playing?.duration ?? 0;\n\n if (currentTrackPlayedAt !== 0) {\n let elapsed = currentTimestamp - currentTrackPlayedAt;\n\n if (elapsed < 0) {\n elapsed = 0;\n } else if (elapsed >= currentTrackDuration) {\n elapsed = currentTrackDuration;\n }\n\n np.now_playing.elapsed = elapsed;\n np.now_playing.remaining = currentTrackDuration - elapsed;\n }\n\n // Do something with the Now Playing data.\n nowPlaying = np;\n }).catch((error) => {\n console.error(error);\n }).then(() => {\n clearTimeout(nowPlayingTimeout);\n nowPlayingTimeout = setTimeout(checkNowPlaying, 15000);\n });\n}\n\ndocument.addEventListener('DOMContentLoaded', () => {\n checkTime();\n loadNowPlaying();\n\n setInterval(\n () => {\n currentTimestamp += 1;\n },\n 1000\n );\n});\n```\n\nIf your application is written in PHP, you can use the Composer package manager to install our [PHP API Client](https://github.com/AzuraCast/php-api-client), which has full support for the Now Playing API endpoints.\n\n\n## Simple Text File {#simple-text-file}\n\n\nAzuraCast also generates a simple text file containing `Artist - Title` for each station. This can be useful if you need to fetch the current playing track for display or in automation tools.\n\nThe URL of the text file follows the format:\n\n```\nhttp://your-azuracast-site.example.com/api/nowplaying_static/station_shortcode.txt\n```\n\n...replacing `station_shortcode` with the station's abbreviated name (i.e. `azuratest_radio` for \"AzuraTest Radio\").\n\n\n## High-Performance Updates {#high-performance-updates}\n\n\nWe deliver a high-performance (low-latency and low server CPU burden) Now Playing feed thanks to a realtime messaging library called [Centrifugo](https://centrifugal.dev/). Using this connection method, each listener gets immediate track updates while only maintaining a single lightweight HTTP connection.\n\nNow Playing updates are delivered as unidirectional messages via Websocket, Server-Sent Events (SSE) or Long Polling web streams. \n\n\n### Websockets {#websockets}\n\n\nThe URL for websocket connections is:\n\n```\nwss://your-azuracast-url/api/live/nowplaying/websocket\n```\n\nUpon connection, you should send a connection string in the form of a JSON request:\n\n```json\n{ \"subs\": { \"station:your_station_name\": {} }}\n```\n\nReplacing `your_station_name` with your station's URL stub or short name.\n\nYou will start to receive a feed of empty pings (`{}`) and Now Playing updates. You can identify Now Playing updates as they will have, in their parsed JSON, `pub.data.np`.\n\nAn example JavaScript implementation is below:\n\n```javascript\nlet socket = new WebSocket(\"wss://your-azuracast-url/api/live/nowplaying/websocket\");\n\nsocket.onopen = function(e) {\n socket.send(JSON.stringify({\n \"subs\": {\n \"station:azuratest_radio\": {\"recover\": true}\n } \n }));\n};\n\nlet nowplaying = {};\nlet currentTime = 0;\n\n// Handle a now-playing event from a station. Update your now-playing data accordingly.\nfunction handleSseData(ssePayload, useTime = true) {\n const jsonData = ssePayload.data;\n\n if (useTime && 'current_time' in jsonData) {\n currentTime = jsonData.current_time;\n }\n\n nowplaying = jsonData.np;\n}\n\nsocket.onmessage = function(e) {\n const jsonData = JSON.parse(e.data);\n\n if ('connect' in jsonData) {\n const connectData = jsonData.connect;\n\n if ('data' in connectData) {\n // Legacy SSE data\n connectData.data.forEach(\n (initialRow) => handleSseData(initialRow)\n );\n } else {\n // New Centrifugo time format\n if ('time' in connectData) {\n currentTime = Math.floor(connectData.time / 1000);\n }\n\n // New Centrifugo cached NowPlaying initial push.\n for (const subName in connectData.subs) {\n const sub = connectData.subs[subName];\n if ('publications' in sub && sub.publications.length > 0) {\n sub.publications.forEach((initialRow) => handleSseData(initialRow, false));\n }\n }\n }\n } else if ('pub' in jsonData) {\n handleSseData(jsonData.pub);\n }\n};\n```\n\n\n### Server-Sent Events (SSE/EventSource) {#server-sent-events-sseeventsource}\n\n\nThe URL for SSE connections is:\n\n```\nhttps://your-azuracast-url/api/live/nowplaying/sse?cf_connect=TOKEN\n```\n\nWhere the `cf_connect` URL parameter is the same connection token as the first message in the Websocket example.\n\nAn example JavaScript implementation is below:\n\n```javascript\nconst sseBaseUri = \"https://your-azuracast-url/api/live/nowplaying/sse\";\nconst sseUriParams = new URLSearchParams({\n \"cf_connect\": JSON.stringify({\n \"subs\": {\n \"station:azuratest_radio\": {\"recover\": true}\n }\n })\n});\nconst sseUri = sseBaseUri+\"?\"+sseUriParams.toString();\nconst sse = new EventSource(sseUri);\n\nlet nowplaying = {};\nlet currentTime = 0;\n\n// This is a now-playing event from a station. Update your now-playing data accordingly.\nfunction handleSseData(ssePayload, useTime = true) {\n const jsonData = ssePayload.data;\n\n if (useTime && 'current_time' in jsonData) {\n currentTime = jsonData.current_time;\n }\n\n nowplaying = jsonData.np;\n}\n\nsse.onmessage = (e) => {\n const jsonData = JSON.parse(e.data);\n\n if ('connect' in jsonData) {\n const connectData = jsonData.connect;\n\n if ('data' in connectData) {\n // Legacy SSE data\n connectData.data.forEach(\n (initialRow) => handleSseData(initialRow)\n );\n } else {\n // New Centrifugo time format\n if ('time' in connectData) {\n currentTime = Math.floor(connectData.time / 1000);\n }\n\n // New Centrifugo cached NowPlaying initial push.\n for (const subName in connectData.subs) {\n const sub = connectData.subs[subName];\n if ('publications' in sub && sub.publications.length > 0) {\n sub.publications.forEach((initialRow) => handleSseData(initialRow, false));\n }\n }\n }\n } else if ('pub' in jsonData) {\n handleSseData(jsonData.pub);\n }\n};\n```\n", "documentId": "developers/now-playing-data", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/developers/now-playing-data/", "markdown": "https://sourcey-azuracast.pages.dev/docs/developers/now-playing-data/index.md" } ] }, { "id": "developers/plugins/index.md", "kind": "page", "title": "Plugins", "description": "AzuraCast contains a plugin system that can be used to extend AzuraCast without having to modifying AzuraCasts code. When you need to modify AzuraCasts behavior you should use the plugin system so that you can still easily update your AzuraCast installation without losing any modifications.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/developers/plugins/", "markdown": "https://sourcey-azuracast.pages.dev/docs/developers/plugins/index.md", "file": "developers/plugins/index.md", "searchText": "AzuraCast contains a plugin system that can be used to extend AzuraCast without having to modifying AzuraCasts code. When you need to modify AzuraCasts behavior you should use the plugin system so that you can still easily update your AzuraCast installation without losing any modifications.\n\n\n## Example Plugin {#example-plugin}\n\n\nWe have built an example plugin that you should use as the base for your own plugin. You can find the git repository at:\n\nhttps://github.com/AzuraCast/example-plugin\n\n\n## Including Plugins {#including-plugins}\n\n\nPlugins are automatically discovered if they're located in the `/plugins` directory relative to the main AzuraCast installation. Plugins are ignored by the parent AzuraCast instance, so you can update your instance any time you like without worrying about your plugins being removed.\n\nYou can clone the plugin directory anywhere you want on the host machine, then create a `docker-compose.override.yml` in your `/var/azuracast` directory to mount the plugin as a volume in the correct location, like so:\n\n```yaml\nservices:\n web:\n environment:\n AZURACAST_PLUGIN_MODE: true\n volumes:\n - ./path_to_plugin:/var/azuracast/www/plugins/example-plugin:ro\n```\n\nMake sure to update and restart the Docker containers afterwards (using `./docker.sh update`).\n\n\n## Additional Information {#additional-information}\n\n\nDetails about how to build plugins, what events are available, etc. are included in the documentation of the [Example Plugin](https://github.com/AzuraCast/example-plugin).\n", "documentId": "developers/plugins", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/developers/plugins/", "markdown": "https://sourcey-azuracast.pages.dev/docs/developers/plugins/index.md" } ] }, { "id": "developers/liquidsoap/index.md", "kind": "page", "title": "Liquidsoap", "description": "Liquidsoap the audio processing tool and language", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/developers/liquidsoap/", "markdown": "https://sourcey-azuracast.pages.dev/docs/developers/liquidsoap/index.md", "file": "developers/liquidsoap/index.md", "searchText": "[Liquidsoap](https://www.liquidsoap.info/) is a powerful and flexible language for describing audio and video streams. It offers a rich collection of operators that you can combine at will for creating or transforming streams.\n\n\n## Liquidsoap in AzuraCast {#liquidsoap-in-azuracast}\n\n\nAzuraCast uses Liquidsoap as the the AutoDJ to generate and manipulate audio streams. It transforms the input streams to the correct format for each mount point, handles live DJ connections, filtering, compression, and more.\n\n\n## Liquidsoap Annotation Reference {#liquidsoap-annotation-reference}\n\n\nThis information is intended for plugin developers who are looking to supply additional annotation metadata to Liquidsoap. It is a compilation of information that wasn't available elsewhere online, and is intended only for advanced users.\n\n\n### Appending Tracks {#appending-tracks}\n\n\n> liquidsoap/src/operators/append.ml\n\nAppend an extra track to every track.\n\n\n#### liq_append {#liq_append}\n\n\nSet the metadata 'liq_append' to 'false' to inhibit appending on one track.\n\n\n### Crossing Tracks {#crossing-tracks}\n\n\n> liquidsoap/src/operators/cross.ml\n\nCommon effects like cross-fading can be split into two parts: crossing, and fading. Here we implement crossing, not caring about fading: a arbitrary transition function is passed, taking care of the combination.\n\nA buffer is needed to store the end of a track before combining it with the next track. We could always have a full buffer, but this would involve copying all the time. Instead, we try to fill the buffer only when getting close to the end of track. The problem then is to cope with tracks which are longer than expected, i.e. which end doesn't really fit in the buffer.\n\nThis operator works with any type of stream. All three parameters are durations in ticks.\n\n\n#### liq_start_next {#liq_start_next}\n\n\nMetadata field which, if present and containing a float, overrides the 'duration' parameter for current track.\n\n\n### Cue Points {#cue-points}\n\n\n> liquidsoap/src/operators/cuepoint.ml\n\nThe [cue_cut] class is able to skip over the beginning and end of a track according to cue points. This involves quite a bit of trickery involving clocks, #seek as well as reverting frame contents. Even more trickery would be needed to implement a [cue_split] operator that splits tracks according to cue points: in particular, the frame manipulation would get nasty, involving storing chunks that have been fetched too early, replaying them later, glued with new content.\n\nWe use ticks for precision, but store them as Int64 to allow long durations. This should eventually be generalized to all of liquidsoap, removing limitations such as the duration passed to #seek or returned by #remaining. We introduce a few notations to make this comfortable.\n\nStart track after a cue in point and stop it at cue out point. The cue points are given as metadata, in seconds from the begining of tracks.\n\n\n#### liq_cue_in {#liq_cue_in}\n\n\nMetadata for cue in points.\n\n\n#### liq_cue_out {#liq_cue_out}\n\n\nMetadata for cue out points. Note that cue-out should be given relative to the beginning of the file (0:00 of the file itself, not 0:00 as calculated by the cue-in point).\n\n\n### Fader {#fader}\n\n\n> liquidsoap/src/operators/fade.ml\n\nFade durations (in, initial, out, final) are indicated in total seconds.\n\n\n#### liq_fade_type {#liq_fade_type}\n\n\nMetadata field which, if present and correct, overrides the 'type' parameter for current track.\n\nOptions: lin|sin|log|exp (linear, sinusoidal, logarithmic or exponential)\n\nDefault: lin\n\n\n#### liq_fade_in {#liq_fade_in}\n\n\nFade the beginning of **tracks**.\n\n\n#### liq_fade_initial {#liq_fade_initial}\n\n\nFade the beginning of **a stream**.\n\n\n#### liq_fade_out {#liq_fade_out}\n\n\nFade the end of **tracks**.\n\n\n#### liq_fade_final {#liq_fade_final}\n\n\nFade **a stream** to silence.\n\n\n### Offset {#offset}\n\n\n> liquidsoap/src/operators/on_offset.ml\n\nCall a given handler when position in track is equal or more than a given amount of time (the 'offset' parameter)\n\n\n#### liq_on_offset {#liq_on_offset}\n\n\nMetadata field which, if present and containing a float, overrides the 'offset' parameter.\n\n\n### Prepending Tracks {#prepending-tracks}\n\n\n> liquidsoap/src/operators/prepend.ml\n\nPrepend an extra track before every track.\n\n\n#### liq_prepend {#liq_prepend}\n\n\nSet the metadata 'liq_prepend' to 'false' to inhibit appending on one track.\n\n\n### Set Volume {#set-volume}\n\n\n> liquidsoap/src/operators/setvol.ml\n\nMultiply the amplitude of the signal.\n\n\n#### liq_amplify {#liq_amplify}\n\n\nSpecify the name of a metadata field that, when present and well-formed, overrides the amplification factor for the current track. Well-formed values are floats in decimal notation (e.g. '0.7') which are taken as normal/linear multiplicative factors; values can be passed in decibels with the suffix 'dB' (e.g. '-8.2 dB', but the spaces do not matter).\n\n\n### Video Fade {#video-fade}\n\n\n> liquidsoap/src/operators/video_fade.ml\n\n\n#### liq_video_fade_in {#liq_video_fade_in}\n\n\nFade the beginning of tracks. Metadata 'liq_video_fade_in' can be used to set the duration for a specific track (float in seconds).\n\n\n#### liq_video_fade_out {#liq_video_fade_out}\n\n\nFade the end of tracks. Metadata 'liq_video_fade_out' can be used to set the duration for a specific track (float in seconds).\n\n\n## LADSPA Plugins {#ladspa-plugins}\n\n\n[LADSPA](https://www.ladspa.org/) is a standard that allows software audio processors and effects to be plugged into a wide range of audio synthesis and recording packages.\n\nOur latest rolling-release Docker image and Ansible scripts add support for LADSPA to Liquidsoap. We include several popular plugins, allowing you to perform powerful equalization in your configuration.\n\nUse the following command to view all the available LADSPA plugins that come pre-installed with AzuraCast:\n\n```bash\ndocker-compose exec --user=azuracast web liquidsoap --list-plugins\n```\n\nTo get detailed information about the usage of a specific LADSPA plugin use the following command and replace the `plugin` part of the `ladspa.plugin` with the name of the plugin you want to look at:\n\n```bash\ndocker-compose exec --user=azuracast web liquidsoap -h ladspa.plugin\n```\n\nWe have modified the [MK Pascal script](https://github.com/mkpascal/mk_liquidsoap_processing/blob/master/process.liq) to work with AzuraCast.\n\nYou can check out the [full script here](https://gist.github.com/BusterNeece/43a06ee6624975273fdc903ba4a39998) that you can include in your Liquidsoap configuration via the `Utilities` -> `Edit Liquidsoap Configuration` page of your station.\n\n\n## Scrobbling to Last.fm {#scrobbling-to-lastfm}\n\n\nLiquidsoap has a native [Last.fm](https://www.last.fm/) extension builtin. To use it, you need to obtain an \"API Key\" and \"API Secret\" from Last.fm's [API account page](https://www.last.fm/api/account/create) and add some custom code to your Liquidsoap config in the third text box (before `add_skip_command(radio)`).\n\n```ruby\nsettings.audioscrobbler.api_key := \"API_KEY\"\nsettings.audioscrobbler.api_secret := \"API_SECRET\"\n\nradio = audioscrobbler.submit(\n username=\"USERNAME\",\n password=\"PASSWORD\",\n force=true, \n metadata_preprocessor=(fun(m) -> if m[\"jingle_mode\"] == \"true\" then [] else m end),\n radio\n)\n```\n\nYou must change `API_KEY`, `API_SECRET`, `USERNAME`, and `PASSWORD` to reflect the credentials of the account you wish to scrobble to.\n\nWhile a track is being played on your station it is marked as \"Scrobbling now\" on the account page of the Last.fm account specified. When the track finishes, it becomes scrobbled. Jingles are not scrobbled. Tracks with no `Artist` or no `Title` are not scrobbled.\n", "documentId": "developers/liquidsoap", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/developers/liquidsoap/", "markdown": "https://sourcey-azuracast.pages.dev/docs/developers/liquidsoap/index.md" } ] }, { "id": "help/troubleshooting/index.md", "kind": "page", "title": "Troubleshooting", "description": "Having trouble with AzuraCast? This page has several resources that can help you solve your problem and be back up and running.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/help/troubleshooting/", "markdown": "https://sourcey-azuracast.pages.dev/docs/help/troubleshooting/index.md", "file": "help/troubleshooting/index.md", "searchText": "Our core maintainers, along with our vast community of station operators, can answer many questions you may have about our software. We also have knowledge base articles set up for common issues encountered by our users.\n\n\n## First Steps {#first-steps}\n\n\nYour first steps should be to check these docs for any tips or pointers. Many common issues can be solved by following the instructions in our guide pages.\n\n\n### Checking System Logs {#checking-system-logs}\n\n\nIf you aren't sure of what is causing your issue, [checking the logs](/docs/help/logs/) can help. Not only do the system logs often explain your error in more detail, but they're essential for our developers to be able to easily diagnose and resolve your issue.\n\n\n### Flushing the System Cache {#flushing-the-system-cache}\n\n\nMany parts of the AzuraCast system depend on caches to speed up site performance. Sometimes, these caches can get out of\ndate, and they may cause errors. You can always flush all site-wide caches using one command-line script:\n\n```bash\n./docker.sh cli cache:clear\n```\n\n\n## Common Liquidsoap Errors {#common-liquidsoap-errors}\n\n\n\n### \"We must catchup x.xx seconds...\" related errors {#we-must-catchup-xxx-seconds-related-errors}\n\n\nIf your station begins to have interrupted audio or crackles, you will often find this \"we must catchup\" error in Liquidsoap's logs. Fundamentally, this is because Liquidsoap's internal audio buffer falls behind the broadcast itself, which often means that it doesn't have the CPU or other resources needed to keep the broadcast running at full speed.\n\nSome common causes of this can be:\n\n - **Underprovisioned Server**: It is possible that your server (or VM, VPS, etc) is not powerful enough to sustain the ongoing CPU and RAM load required to operate your station. To continue broadcasting with all of your settings as they are, you may need to consider a more powerful server.\n\n - **Using CPU-heavy Features (AutoCue, MasterMe, etc.)**: Some features are especially demanding of CPU resources. We try to label these features as \"High CPU\" in AzuraCast's UI so you are aware of them before enabling them; if you encounter skips or other issues with these features enabled, try disabling them to see if the problem improves, or consider using a more powerful server for your installation.\n\n - **Too Many Mount Points/Remotes/HLS Streams**: Each individual mount point, remote relay with AutoDJ enabled, or HLS stream type requires Liquidsoap to transcode the broadcast signal into a new format, and thus requires a roughly constant CPU load over time. In newer versions of AzuraCast, we offer an experimental way to consolidate any common encoding formats, optimizing CPU usage if you output the same format to multiple locations.\n\nIf you are still encountering issues, we would recommend collecting your station logs and its generated Liquidsoap configuration file and [submitting an issue on the Liquidsoap GitHub](https://github.com/savonet/liquidsoap). We cannot provide extended support for Liquidsoap itself, as we don't maintain the software.\n\n\n## Common Docker Errors {#common-docker-errors}\n\n\n\n### \"Client version x.xx is too old/new\" {#client-version-xxx-is-too-oldnew}\n\n\nThis error occurs when your Docker version and Docker Compose version do not match each other.\n\nOur Docker Utility Script will always install \"matching\" versions of Docker and Docker Compose, so this issue can often be fixed by running:\n\n```bash\n# You may need to prefix these commands with `sudo` if running as non-root.\ncd /var/azuracast\n./docker.sh update-self\n./docker.sh install-docker\n./docker.sh install-docker-compose\n```\n\n\n### \"Invalid interpolation format\" related errors {#invalid-interpolation-format-related-errors}\n\n\nThis issue is related to an out of date docker-compose version, since we use a more up to date docker-compose version it'll return these types of errors.\n\n- `ERROR: Invalid interpolation format for \"installer\" option in service \"services\": \"ghcr.io/azuracast/web:${AZURACAST_VERSION:-latest}\"`\n- `ERROR: Invalid interpolation format for \"nginx_proxy\" option in service \"services\": \"ghcr.io/azuracast/nginx_proxy:${AZURACAST_VERSION:-latest}\"`\n\nTo update your Docker Compose version, run the following commands:\n\n```bash\n# You may need to prefix these commands with `sudo` if running as non-root.\ncd /var/azuracast\n./docker.sh update-self\n./docker.sh install-docker-compose\n```\n\n\n### \"bind: address already in use\" {#bind-address-already-in-use}\n\n\nIf you get this error when starting the Docker AzuraCast instance, it means that something else (some other process or server software) is already running on the same port(s) that AzuraCast is trying to reserve for itself.\n\nThere are generally two ways to resolve this:\n\n- Find the process that's currently listening on the port (commands like `netstat -tulpn` can help you with this) and either disable the program that's currently listening, edit its configuration to change the port it listens on, or uninstall it from the server completely.\n- Switch the port AzuraCast uses for its own traffic to an unused one. [See instructions](/docs/administration/docker/)\n\nSince this error is caused by the interaction of some piece of software on your host computer and the Docker daemon, we can't automatically resolve it for you, and the best way to resolve it will depend on how your server is configured and what else is running on it.\n\nCommon services that listen on ports 80 and 443 include web servers like Apache and nginx. One common port to use if you still need these services to remain online alongside AzuraCast is port 8080, which we deliberately leave open due to its common usage with other software.\n\n\n### \"WARNING: The LETSENCRYPT_X variable is not set. Defaulting to a blank string.\" {#warning-the-letsencrypt_x-variable-is-not-set-defaulting-to-a-blank-string}\n\n\nThis message doesn't indicate anything is wrong with your installation; it is simply Docker Compose letting you know that it defaults to an empty string if a certain environment variable isn't present. You will see these messages if you don't have LetsEncrypt configured on your server, and you can safely disregard them.\n\n\n## Other General Errors {#other-general-errors}\n\n\n\n### InnoDB: Upgrade after a crash is not supported {#innodb-upgrade-after-a-crash-is-not-supported}\n\n\nThe DB crashed while using MariaDB 10.4 and was then not restarted with the same MariaDB version so that it can recover from the redo log files but was updated to 10.5 which now is not able to handle the old redo log format (in 10.5 they changed that format).\n\nRenaming the `ib_logfile0` (and if there are more `ib_logfile*` files those too) and then starting the db again should work.\n\nYou can find those files here: `/var/lib/docker/volumes/azuracast_db_data/_data`\n\nStop your AzuraCast via `docker-compose down`, then try renaming them via `mv ib_logfile0 ib_logfile0.old` and after that run the update again.\n\n\n### Failed Database Migrations {#failed-database-migrations}\n\n\nIn some situations, especially if the automated update process is interrupted for any reason, you can wind up in a state where a databse migration has only halfway completed.\n\nAzuraCast now automatically takes a snapshot of your database as it existed immediately before a migration runs, and if any errors are encountered, it will attempt to restore from that snapshot.\n\nNevertheless, we strongly recommend that you take routine backups of your installation, including before software updates. If a migration fails and AzuraCast's automatic restoration fails for some reason, restoring from a database backup is the simplest solution.\n\nFor power users, if you cannot restore a backup during a failed migration, you may be able to manually execute the incomplete migration by manually executing the unfinished SQL commands. We do not officially support this, however, and using our automated recovery or a backup restoration is strongly preferred.\n\n\n## Submitting an Issue {#submitting-an-issue}\n\n\nIf you encounter an issue that you can not resolve with the documentation please refer to our guide on [how to report a bug](/docs/help/report-a-bug/).\n", "documentId": "help/troubleshooting", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/help/troubleshooting/", "markdown": "https://sourcey-azuracast.pages.dev/docs/help/troubleshooting/index.md" } ] }, { "id": "help/logs/index.md", "kind": "page", "title": "Logs", "description": "How to get logs and what logs are available", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/help/logs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/help/logs/index.md", "file": "help/logs/index.md", "searchText": "Before submitting any GitHub issues, you should take a look at the terminal logs that AzuraCast outputs. They can often provide additional information about the error, or include very useful information that should be included in any GitHub issue you create.\n\nUsers with the appropriate permissions can also view many logs directly through AzuraCast itself. The Log Viewer feature is available under \"Logs\" in each station's management page.\n\n\n## System Logs {#system-logs}\n\n\nIf you are administrating your own AzuraCast installation you can check most logs through the `Administration` -> `System Logs`.\n\nIn addition to the `Icecast`, `Shoutcast` and `Liquidsoap` logs you can find the `AzuraCast Application Log` here which contains useful information about what the AzuraCast application itself is doing. Email message logs are also sent here.\n\n\n## Log Viewer {#log-viewer}\n\n\nThe `Logs` link in your station sidebar menu gives you access to the Logs from your station's `Icecast`, `Shoutcast` and `Liquidsoap` processes.\n\nIn addition to the logs, you can also view the Icecast, Shoutcast and Liquidsoap configuration scripts that AzuraCast automatically generates for you.\n\n\n## Log Types {#log-types}\n\n\n\n### AzuraCast Application Log {#azuracast-application-log}\n\n\nThis log file contains the log output of the AzuraCast application itself. If you encounter any errors with the application itself you will most likely find more information about those errors in this log file.\n\n\n### Liquidsoap Log {#liquidsoap-log}\n\n\nThis log file contains the log output of the Liquidsoap instance for your station. Liquidsoap is responsible for the audio transcoding in AzuraCast and interfaces with the AzuraCast application to provide the AutoDJ for your station.\n\nIn this log you can find information on how the streams are generated, what information the AutoDJ sent to Liquidsoap, errors, warnings and more.\n\nIf you encounter any problems with your stream generation this look should contain useful information in diagnosing the issue.\n\n\n### Icecast Access Log {#icecast-access-log}\n\n\nThis log file contains the raw access log data of the Icecast server.\n\nFor most issues this log does not contain any useful information but can be used for analytical purposes.\n\n\n### Icecast Error Log {#icecast-error-log}\n\n\nThis log file contains the error output of the Icecast server.\n\nIf you encounter any problems with accessing the streams or your mount points this is were should start looking into.\n\n\n## Docker Container Logs {#docker-container-logs}\n\n\nSome system logs can only be accessed from a shell session on the host computer. To view the logs for your AzuraCast installation, run:\n\n```bash\ncd /var/azuracast\ndocker-compose logs -f web\n```\n\n\n## For Ansible Installations {#for-ansible-installations}\n\n\nSince the Ansible installation interacts directly with your host server, its logs are in various locations across the system.\n\n- AzuraCast: `/var/azuracast/www_tmp/app.log`\n- Nginx Access: `/var/azuracast/www_tmp/access.log`\n- Nginx Errors: `/var/azuracast/www_tmp/error.log`\n- PHP: `/var/azuracast/www_tmp/php_errors.log`\n- Supervisord: `/var/azuracast/www_tmp/supervisord.log`\n- Redis: `/var/log/redis/redis-server.log`\n- MariaDB: `/var/log/mysql`\n\nFor each station, logs for radio software will be inside `/var/azuracast/stations/{station_short_name}/config`, with the following filenames:\n\n- Liquidsoap: `liquidsoap.log`\n- Icecast: `icecast.log`\n- Shoutcast: `sc_serv.log`\n", "documentId": "help/logs", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/help/logs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/help/logs/index.md" } ] }, { "id": "help/optimizing/index.md", "kind": "page", "title": "Optimizing", "description": "Tips for how to get the most out of AzuraCast on limited-resource installations.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/help/optimizing/", "markdown": "https://sourcey-azuracast.pages.dev/docs/help/optimizing/index.md", "file": "help/optimizing/index.md", "searchText": "If you're running AzuraCast on limited system resources, you may find that you need to tweak or remove some optional features to improve your overall performance. This page includes some of the simplest changes you can take to reduce your overall resource (CPU, RAM, etc.) usage.\n\n\n## Inside AzuraCast {#inside-azuracast}\n\n\n\n### Disable Replaygain or Pre-Calculate Replaygain for Audio Files {#disable-replaygain-or-pre-calculate-replaygain-for-audio-files}\n\n\nIf Replaygain is enabled in your AutoDJ, then Liquidsoap will examine each file to see if it already has Replaygain metadata associated with it; if not, it will try to automatically calculate it on-the-fly, which can be a very CPU-intensive process that can significantly slow your installation.\n\nIn order to resolve this, you can take one of two approaches:\n\n1. Disable Replaygain from the \"AutoDJ\" tab of your station's profile; or\n2. Ensure all of your uploaded media is pre-tagged with Replaygain metadata using a tool like [loudgain](https://github.com/Moonbase59/loudgain)\n\n\n### Disable Audio Post-Processing {#disable-audio-post-processing}\n\n\nIf your installation is limited in available CPU, you should disable any \"Audio Post-Processing\" settings on any stations hosted on your server.\n\nThe total amount of extra resources per station consumed by post-processing is roughly as so:\n\n- Stereo Tool (Most CPU)\n- `master_me` (Med-High CPU)\n- Basic Compression/Normalization (Low-Med CPU)\n- No Post-Processing (Least CPU)\n\n\n### AutoCue {#autocue}\n\n\nAutoCue is a new feature built by the community and offered as part of AzuraCast. It analyzes your music and automatically calculates cue points, fade points, and volume levels for a consistent listening experience.\n\nTo compute these values, it has to analyze every track that plays on your station. This can take time and extra CPU resources, especially when a station first starts up (because it has to analyze every starting track in every playlist, just in case it might have to transition to that track immediately).\n\nIf you have shorter, simpler tracks or have a few large playlists, this will only result in a slight CPU bump, after which the station will stabilize. If you have longer tracks or a large number of individual playlists, the initial CPU load can be so high that it disrupts your station operations entirely.\n\nIf you are in the latter group, it is recommended to either disable AutoCue from the station profile or to precompute the AutoCue values for your files before starting your station. See the [AutoCue project documentation](https://github.com/Moonbase59/autocue/) for the current recommendations on how to achieve this.\n\n\n### Disable Unnecessary Mount Points {#disable-unnecessary-mount-points}\n\n\nIf you have configured multiple mount points for your station, consider reducing the total number of mount points to a smaller subset if possible. Every mount point that the AutoDJ has to broadcast to uses a small, but steady, amount of CPU at all times.\n\nFor example, if you offer a mobile MP3 and AAC/Ogg stream, consider limiting the mobile stream strictly to the (higher-performance per bit) AAC/Ogg stream, if your clients support it.\n\n\n### Keep Less Playback History {#keep-less-playback-history}\n\n\nIn \"System Settings\", you will notice a setting called \"Days of Playback History to Keep\". This setting not only controls how far back you can view song history, but also how far back you can view detailed listener statistics.\n\nSetting it to a large value or \"Indefinitely\" will quickly fill up your available hard drive space. If you change this setting, within an hour or so AzuraCast will automatically \"trim\" any extra song history and listener data, which will often result in a significant reduction in disk space used.\n\n\n### Use Remote Storage for Media, Backups, etc. {#use-remote-storage-for-media-backups-etc}\n\n\nIf your VPS or cloud hosting environment is limited in disk space, you can always configure storage locations that use external storage instead.\n\nThe most popular method of remote storage in AzuraCast is S3-compatible bucket storage. There are very many providers of S3-compatible storage out there, from the namesake Amazon's Simple Storage Service (S3) to Cloudflare's R2, Backblaze B1, or Wasabi. Pricing for storage and bandwidth can vary greatly between providers, so consider which option is best for your setup.\n\nIf configuring a remote storage location for station media, be sure to select one that has little or no fees for so-called \"egress\" bandwidth to your server, as there is a lot of back-and-forth traffic between AzuraCast and media storage locations. This is less of a concern if you are using S3 buckets for backups or recordings.\n\n\n## Docker {#docker}\n\n\n\n### Disable Userland Proxy {#disable-userland-proxy}\n\n\nBy default, Docker ships with a \"Userland Proxy\" feature, which allows you to connect to your Docker containers from inside the same Linux OS that's running Docker itself. For most VPS or cloud hosting scenarios, this is unnecessary, and the userland proxy can often take up *huge* amounts of resources because of the large number of ports forwarded by AzuraCast.\n\nUnfortunately, we can't automatically disable this functionality, but you can configure Docker on your host OS to disable it.\n\nOn your host OS, use an editor to open `/etc/docker/daemon.json`. Add or edit the following line into the JSON:\n\n```json\n{\n \"userland-proxy\": false,\n}\n```\n\nSave your changes, then restart the host OS.\n", "documentId": "help/optimizing", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/help/optimizing/", "markdown": "https://sourcey-azuracast.pages.dev/docs/help/optimizing/index.md" } ] }, { "id": "help/report-a-bug/index.md", "kind": "page", "title": "Reporting a Bug", "description": "How to report a bug with AzuraCast", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/help/report-a-bug/", "markdown": "https://sourcey-azuracast.pages.dev/docs/help/report-a-bug/index.md", "file": "help/report-a-bug/index.md", "searchText": "\n\n> [!TIP]\n> **You must follow [troubleshooting steps](/docs/help/troubleshooting/) prior to filing an issue on GitHub.**\n>\n> In our issue template, we ask for [logs](/docs/help/logs/) and other details that are part of the troubleshooting steps, and supplying these greatly helps us resolve issues.\n>\n> Support for AzuraCast is only provided for the current `Stable` and up to date `Rolling-Release` versions. Make sure to update your installation before reporting an issue. We regularly publish updates that resolve issues and add new features.\n\n\n\nIf your issue isn't in our known issues or common solutions, check out our [GitHub Issues](https://github.com/AzuraCast/AzuraCast/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) board. We use GitHub to track the status of errors, bug reports and general questions.\n\nIf there's already an open GitHub issue for the specific issue you're having, you can follow that issue for updates. If not, you can create a new issue from the same page.\n\nWhen creating a new issue, you'll be presented with a template of questions to answer to help our team provide quick and accurate support.\n\n**Please make sure to answer these questions and provide as much detail as possible!**\n\nPlease include the following:\n\n- Any steps that you have already attempted\n- Any errors you may have encountered\n- A full step-by-step guide on how to reproduce the issue\n- Screenshots if applicable\n- Relevant [logs (click here for instructions on how to get them)](/docs/help/logs/)\n", "documentId": "help/report-a-bug", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/help/report-a-bug/", "markdown": "https://sourcey-azuracast.pages.dev/docs/help/report-a-bug/index.md" } ] }, { "id": "contribute/donate/index.md", "kind": "page", "title": "Donate", "description": "Support AzuraCast and its developers by donating!", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/contribute/donate/", "markdown": "https://sourcey-azuracast.pages.dev/docs/contribute/donate/index.md", "file": "contribute/donate/index.md", "searchText": "AzuraCast is a fully free and open-source project built as a labor of love over the course of many years. AzuraCast has always been, and will remain, both \"free as in freedom\" (libre) and \"free as in beer\" (gratis) for the thousands of stations that depend on it for their day-to-day operations.\n\nAlthough the AzuraCast community has contributed in many ways to the project, much of the day-to-day work of maintaining the application, updating its dependencies and fixing bugs falls upon its lead developer, [Buster Neece](https://github.com/BusterNeece). The AzuraCast project is akin to a full-time job for him, and your support goes to directly helping him pay for essentials like rent and groceries.\n\nNot only are donations to AzuraCast going to good use, but they help us devote the time we need to keep the application new and updated. Almost every day for years now, we've updated the application to fix a bug, add a new feature or improve the user experience. We never stop working to serve our audience, and your donations help make that possible.\n\n\n## Ways to Donate {#ways-to-donate}\n\n\n\n### GitHub Sponsors {#github-sponsors}\n\n\nIf you're a GitHub user, supporting through GitHub Sponsors is one of the best ways to show your support for AzuraCast's development. You can manage your pledge at any time through the Sponsors dashboard.\n\nIf you donate through GitHub Sponsors, you will be listed as a sponsor on your GitHub profile and with any issues or discussions you create.\n\n\n\n\n\n**[Sponsor AzuraCast on GitHub Sponsors](https://github.com/sponsors/AzuraCast)**\n\n\n\n\n\n\n### Patreon {#patreon}\n\n\nSupporting our patreon is another great way to provide ongoing support for the project over a long term. Patreon takes slightly higher fees than GitHub Sponsors, but if you're already a Patreon user it's a convenient way to support this project along with other creative professionals and projects.\n\n\n\n\n\n**[Become a Patron of AzuraCast](https://www.patreon.com/bePatron?u=232463)**\n\n\n\n\n\n\n### OpenCollective {#opencollective}\n\n\nAzuraCast has an OpenCollective account that is fiscally hosted by the Open Source Collective. Contributions made to, and expenses withdrawn from, this account are fully open and transparent.\n\n\n\n\n\n**[Support AzuraCast on OpenCollective](https://opencollective.com/azuracast)**\n\n\n\n\n", "documentId": "contribute/donate", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/contribute/donate/", "markdown": "https://sourcey-azuracast.pages.dev/docs/contribute/donate/index.md" } ] }, { "id": "contribute/translation/index.md", "kind": "page", "title": "Translation", "description": "Translating AzuraCast into other languages", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/contribute/translation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/contribute/translation/index.md", "file": "contribute/translation/index.md", "searchText": "Do you speak both English and another language? You can help us in a big way by helping translate AzuraCast!\n\nAzuraCast is used around the world, and we want our web application to be accessible to users who aren't familiar with English, our primary language.\n\nThanks to the help of our friends at CrowdIn, translating the strings used in our application is easy! Just visit our translation page and create an account, and you can start submitting translations. CrowdIn also provides suggested translations in case you are unsure of certain words or phrases.\n\n\n\n\n\n**[Submit Translations with CrowdIn](https://translate.azuracast.com/)**\n\n\n\n\n\nWe do our best to incorporate translation changes as frequently as possible, but sometimes new updates are delayed. If you have completed a significant translation project, please feel free to give us a gentle reminder by creating a Github issue. Once the translations have been updated, we will close the issue to let you know.\n", "documentId": "contribute/translation", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/contribute/translation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/contribute/translation/index.md" } ] }, { "id": "contribute/suggest-a-new-feature/index.md", "kind": "page", "title": "Suggest a New Feature", "description": "Our community votes on what features we should prioritize via a special web site called FeatureUpvote. Visit the AzuraCast FeatureUpvote Site to submit new feature ideas or vote on existing ones.", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/contribute/suggest-a-new-feature/", "markdown": "https://sourcey-azuracast.pages.dev/docs/contribute/suggest-a-new-feature/index.md", "file": "contribute/suggest-a-new-feature/index.md", "searchText": "Our community votes on what features we should prioritize via a special web site called FeatureUpvote. Visit the AzuraCast FeatureUpvote Site to submit new feature ideas or vote on existing ones.\n\n\n\n\n\n**[Suggest Features on FeatureUpvote](https://features.azuracast.com/)**\n\n\n\n\n", "documentId": "contribute/suggest-a-new-feature", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/contribute/suggest-a-new-feature/", "markdown": "https://sourcey-azuracast.pages.dev/docs/contribute/suggest-a-new-feature/index.md" } ] }, { "id": "contribute/code-of-conduct/index.md", "kind": "page", "title": "Code of Conduct", "description": "Contributor Covenant Code of Conduct", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/contribute/code-of-conduct/", "markdown": "https://sourcey-azuracast.pages.dev/docs/contribute/code-of-conduct/index.md", "file": "contribute/code-of-conduct/index.md", "searchText": "\n## Our Pledge {#our-pledge}\n\n\nWe as members, contributors, and leaders pledge to make participation in our\ncommunity a harassment-free experience for everyone, regardless of age, body\nsize, visible or invisible disability, ethnicity, sex characteristics, gender\nidentity and expression, level of experience, education, socio-economic status,\nnationality, personal appearance, race, religion, or sexual identity\nand orientation.\n\nWe pledge to act and interact in ways that contribute to an open, welcoming,\ndiverse, inclusive, and healthy community.\n\n\n## Our Standards {#our-standards}\n\n\nExamples of behavior that contributes to a positive environment for our\ncommunity include:\n\n* Demonstrating empathy and kindness toward other people\n* Being respectful of differing opinions, viewpoints, and experiences\n* Giving and gracefully accepting constructive feedback\n* Accepting responsibility and apologizing to those affected by our mistakes,\n and learning from the experience\n* Focusing on what is best not just for us as individuals, but for the\n overall community\n\nExamples of unacceptable behavior include:\n\n* The use of sexualized language or imagery, and sexual attention or\n advances of any kind\n* Trolling, insulting or derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or email\n address, without their explicit permission\n* Other conduct which could reasonably be considered inappropriate in a\n professional setting\n\n\n## Enforcement Responsibilities {#enforcement-responsibilities}\n\n\nCommunity leaders are responsible for clarifying and enforcing our standards of\nacceptable behavior and will take appropriate and fair corrective action in\nresponse to any behavior that they deem inappropriate, threatening, offensive,\nor harmful.\n\nCommunity leaders have the right and responsibility to remove, edit, or reject\ncomments, commits, code, wiki edits, issues, and other contributions that are\nnot aligned to this Code of Conduct, and will communicate reasons for moderation\ndecisions when appropriate.\n\n\n## Scope {#scope}\n\n\nThis Code of Conduct applies within all community spaces, and also applies when\nan individual is officially representing the community in public spaces.\nExamples of representing our community include using an official e-mail address,\nposting via an official social media account, or acting as an appointed\nrepresentative at an online or offline event.\n\n\n## Enforcement {#enforcement}\n\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be\nreported to the community leaders responsible for enforcement at [help@azuracast.com](mailto:help@azuracast.com).\nAll complaints will be reviewed and investigated promptly and fairly.\n\nAll community leaders are obligated to respect the privacy and security of the\nreporter of any incident.\n\n\n## Enforcement Guidelines {#enforcement-guidelines}\n\n\nCommunity leaders will follow these Community Impact Guidelines in determining\nthe consequences for any action they deem in violation of this Code of Conduct:\n\n\n### 1. Correction {#1-correction}\n\n\n**Community Impact**: Use of inappropriate language or other behavior deemed\nunprofessional or unwelcome in the community.\n\n**Consequence**: A private, written warning from community leaders, providing\nclarity around the nature of the violation and an explanation of why the\nbehavior was inappropriate. A public apology may be requested.\n\n\n### 2. Warning {#2-warning}\n\n\n**Community Impact**: A violation through a single incident or series\nof actions.\n\n**Consequence**: A warning with consequences for continued behavior. No\ninteraction with the people involved, including unsolicited interaction with\nthose enforcing the Code of Conduct, for a specified period of time. This\nincludes avoiding interactions in community spaces as well as external channels\nlike social media. Violating these terms may lead to a temporary or\npermanent ban.\n\n\n### 3. Temporary Ban {#3-temporary-ban}\n\n\n**Community Impact**: A serious violation of community standards, including\nsustained inappropriate behavior.\n\n**Consequence**: A temporary ban from any sort of interaction or public\ncommunication with the community for a specified period of time. No public or\nprivate interaction with the people involved, including unsolicited interaction\nwith those enforcing the Code of Conduct, is allowed during this period.\nViolating these terms may lead to a permanent ban.\n\n\n### 4. Permanent Ban {#4-permanent-ban}\n\n\n**Community Impact**: Demonstrating a pattern of violation of community\nstandards, including sustained inappropriate behavior, harassment of an\nindividual, or aggression toward or disparagement of classes of individuals.\n\n**Consequence**: A permanent ban from any sort of public interaction within\nthe community.\n\n\n## Attribution {#attribution}\n\n\nThis Code of Conduct is adapted from the [Contributor Covenant][homepage],\nversion 2.0, available at\nhttps://www.contributor-covenant.org/version/2/0/code_of_conduct.html.\n\nCommunity Impact Guidelines were inspired by [Mozilla's code of conduct\nenforcement ladder](https://github.com/mozilla/diversity).\n\n[homepage]: https://www.contributor-covenant.org\n\nFor answers to common questions about this code of conduct, see the FAQ at\nhttps://www.contributor-covenant.org/faq. Translations are available at\nhttps://www.contributor-covenant.org/translations.\n", "documentId": "contribute/code-of-conduct", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/contribute/code-of-conduct/", "markdown": "https://sourcey-azuracast.pages.dev/docs/contribute/code-of-conduct/index.md" } ] }, { "id": "press-kit/index.md", "kind": "page", "title": "Press Kit", "description": "Press Kit for the media and journalists", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/press-kit/", "markdown": "https://sourcey-azuracast.pages.dev/docs/press-kit/index.md", "file": "press-kit/index.md", "searchText": "AzuraCast welcomes any related code projects, hosting partners, media agencies and freelance journalists to utilize our branding as needed to refer to our software.\n\nThis page will provide our images, audio and files that you may wish to include. \n\n\n## About Us {#about-us}\n\n\nAzuraCast is a free and open-source, self-hosted, all-in-one web radio management suite. We like to refer to it as a \"web radio station in a box\", as it includes the full stack of open-source software needed to start up a new radio station, broadcast to listeners and manage everything via a web interface.\n\nAzuraCast's history dates back to late 2012 in the form of our predecessor project [Ponyville Live](https://github.com/slvreagle23/ponyville-live). In spring 2016, the project was rebuilt as the self-hosted web radio management suite it is today. Our branding and marketing still heavily features our unicorn mascot (designed by [Tyson-Tan](https://tysontan.com/)) as a tribute to our fandom roots.\n\nAzuraCast was created by [Buster \"Silver Eagle\" Neece](https://github.com/slvreagle23), who remains the project's lead developer. He is supported by a second developer and a community moderator.\n\nToday, AzuraCast powers thousands of installations and continues to be actively maintained on a daily basis.\n\n\n## Press Kit {#press-kit}\n\n\nThe Press Kit contains the following: \n- Promotional Audio Files along with a License Certificate\n- The AzuraCast Mascot, known as the Azura Ruisselante, created by Tyson Tan\n- Logos with text and without text.\n- Hexagon Logos\n- Discord Emoticons\n\nDownload the Press Kit [Here](https://www.azuracast.com/resources/press_kit.zip) \n\n\n### Press Kit Guidelines {#press-kit-guidelines}\n\n\nAs a courtesy, we ask that the following rules be applied:\n\n- Do not modify and/or alter the AzuraCast Logo, Mascot (Azura Ruisselante), or our Hexagon Logo\n- Do not modify the sound files we provide in any shape or form\n\nAzuraCast is licensed under the Apache 2.0 software license, which expressly protects its name and branding while allowing the source code to be fully free and open. This means that you are free to use our branding to refer to AzuraCast itself (specifically, the version we maintain and distribute), but you are not permitted to call your own fork or code AzuraCast, or use our branding as your company's own logo when offering services related to AzuraCast, such as managed hosting.\n\n\n## AzuraCast in Media {#azuracast-in-media}\n\n\nWe have had many opportunities to speak about AzuraCast in public; these talks have answered many popular questions and can help to share insights about our history and our development process.\n\n- **FLOSS Weekly**: Buster Neece was interviewed on FLOSS Weekly episode 637, on July 7, 2021: https://www.youtube.com/watch?v=_V6ree6cwZ4\n\n- **Liquidshop**: Buster Neece presented a talk entitled \"AzuraCast, Liquidsoap and the Open Radio Ecosystem\" at Liquidsoap's 2022 Liquidshop event on January 23, 2022: https://www.youtube.com/watch?v=rApEODLKY0w\n\n- **Linode**: One of our hosting partners, Linode, published a video guide showing how to get started with AzuraCast on Linode: https://www.youtube.com/watch?v=lEElFHUdFd4\n\n\n## Official Statements, Comments and More. {#official-statements-comments-and-more}\nIf you're a member of a media agency and or a a freelance journalist who seeks a comment, clarification or some more information, reach out to us at pr@azuracast.com and a member of our team will reach out to you. We expect to get back to you within 5 working days. \n\n", "documentId": "press-kit", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/press-kit/", "markdown": "https://sourcey-azuracast.pages.dev/docs/press-kit/index.md" } ] }, { "id": "privacy-policy/index.md", "kind": "page", "title": "Privacy Policy", "description": "AzuraCast (\"us\", \"we\", or \"our\") operates the https://azuracast.com/ website (the \"Service\").", "tab": "", "url": "https://sourcey-azuracast.pages.dev/docs/privacy-policy/", "markdown": "https://sourcey-azuracast.pages.dev/docs/privacy-policy/index.md", "file": "privacy-policy/index.md", "searchText": "> Effective date: November 13, 2018\n\nAzuraCast (\"us\", \"we\", or \"our\") operates the https://azuracast.com/ website (the \"Service\").\n\nThis page informs you of our policies regarding the collection, use, and disclosure of personal data when you use our Service and the choices you have associated with that data.\n\nWe use your data to provide and improve the Service. By using the Service, you agree to the collection and use of information in accordance with this policy. Unless otherwise defined in this Privacy Policy, terms used in this Privacy Policy have the same meanings as in our Terms and Conditions, accessible from https://www.azuracast.com/\n\n\n## Information Collection And Use {#information-collection-and-use}\n\n\nWe collect several different types of information for various purposes to provide and improve our Service to you.\n\n\n### Data Collected via the AzuraCast Central Service {#data-collected-via-the-azuracast-central-service}\n\n\nRadio stations using the self-hosted AzuraCast software may connect to the AzuraCast Central service (central.azuracast.com) in order to submit details about their installation for the purpose of checking for updates, retrieving new announcements, or optionally informing the AzuraCast developers about how their software is being used on the Web.\n\nBy default, all AzuraCast installations will send only the following limited subset of information to the AzuraCast Central server:\n\n- Randomized AzuraCast instance ID\n- SHA hash of the current version of AzuraCast that is running\n- The platform that the AzuraCast instance is running from (Docker or Bare-metal)\n- The public IP address of the self-hosted AzuraCast instance\n\nThis information is collected and stored on AzuraCast servers for the sole purposes of tracking the number of installations across the Web using a specific version and platform of the software, and informing station operators of any important updates or announcements.\n\nThis data is kept exclusively on AzuraCast's servers and is not made available to any third party.\n\nIn the future, AzuraCast may invite installation operators to voluntarily submit additional data about their installations for the purposes of understanding how AzuraCast is used by operators, submission of feedback to core developers, or for providing remote support. These services will all be offered on an opt-in basis only. As these services are introduced, this Privacy Policy will be updated to reflect the data collected by each individual service.\n\n\n### Data Collected on the Public Homepage {#data-collected-on-the-public-homepage}\n\n\n\n#### Personal Data {#personal-data}\n\n\nWhile using our Service, we may ask you to provide us with certain personally identifiable information that can be used to contact or identify you (\"Personal Data\"). Personally identifiable information may include, but is not limited to:\n\n- Cookies and Usage Data\n- Usage Data\n\nWe may also collect information how the Service is accessed and used (\"Usage Data\"). This Usage Data may include information such as your computer's Internet Protocol address (e.g. IP address), browser type, browser version, the pages of our Service that you visit, the time and date of your visit, the time spent on those pages, unique device identifiers and other diagnostic data.\n\n\n#### Tracking & Cookies Data {#tracking--cookies-data}\n\n\nWe use cookies and similar tracking technologies to track the activity on our Service and hold certain information.\n\nCookies are files with small amount of data which may include an anonymous unique identifier. Cookies are sent to your browser from a website and stored on your device. Tracking technologies also used are beacons, tags, and scripts to collect and track information and to improve and analyze our Service.\n\nYou can instruct your browser to refuse all cookies or to indicate when a cookie is being sent. However, if you do not accept cookies, you may not be able to use some portions of our Service.\n\nExamples of Cookies we use:\n\n- Session Cookies. We use Session Cookies to operate our Service.\n- Preference Cookies. We use Preference Cookies to remember your preferences and various settings.\n- Security Cookies. We use Security Cookies for security purposes.\n\n\n## Use of Data {#use-of-data}\n\n\nAzuraCast uses the collected data for various purposes:\n\n- To provide and maintain the Service\n- To notify you about changes to our Service\n- To allow you to participate in interactive features of our Service when you choose to do so\n- To provide customer care and support\n- To provide analysis or valuable information so that we can improve the Service\n- To monitor the usage of the Service\n- To detect, prevent and address technical issues\n\n\n## Transfer Of Data {#transfer-of-data}\n\n\nYour information, including Personal Data, may be transferred to — and maintained on — computers located outside of your state, province, country or other governmental jurisdiction where the data protection laws may differ than those from your jurisdiction.\n\nIf you are located outside United States and choose to provide information to us, please note that we transfer the data, including Personal Data, to United States and process it there.\n\nYour consent to this Privacy Policy followed by your submission of such information represents your agreement to that transfer.\n\nAzuraCast will take all steps reasonably necessary to ensure that your data is treated securely and in accordance with this Privacy Policy and no transfer of your Personal Data will take place to an organization or a country unless there are adequate controls in place including the security of your data and other personal information.\n\n\n## Disclosure Of Data {#disclosure-of-data}\n\n\n\n### Legal Requirements {#legal-requirements}\n\n\nAzuraCast may disclose your Personal Data in the good faith belief that such action is necessary to:\n\n- To comply with a legal obligation\n- To protect and defend the rights or property of AzuraCast\n- To prevent or investigate possible wrongdoing in connection with the Service\n- To protect the personal safety of users of the Service or the public\n- To protect against legal liability\n\n\n## Security Of Data {#security-of-data}\n\n\nThe security of your data is important to us, but remember that no method of transmission over the Internet, or method of electronic storage is 100% secure. While we strive to use commercially acceptable means to protect your Personal Data, we cannot guarantee its absolute security.\n\n\n## Service Providers {#service-providers}\n\n\nWe may employ third party companies and individuals to facilitate our Service (\"Service Providers\"), to provide the Service on our behalf, to perform Service-related services or to assist us in analyzing how our Service is used.\n\nThese third parties have access to your Personal Data only to perform these tasks on our behalf and are obligated not to disclose or use it for any other purpose.\n\n\n### Analytics {#analytics}\n\n\nWe may use third-party Service Providers to monitor and analyze the use of our Service.\n\n\n#### Google Analytics {#google-analytics}\n\n\nGoogle Analytics is a web analytics service offered by Google that tracks and reports website traffic. Google uses the data collected to track and monitor the use of our Service. This data is shared with other Google services. Google may use the collected data to contextualize and personalize the ads of its own advertising network.\n\nYou can opt-out of having made your activity on the Service available to Google Analytics by installing the Google Analytics opt-out browser add-on. The add-on prevents the Google Analytics JavaScript (ga.js, analytics.js, and dc.js) from sharing information with Google Analytics about visits activity.\n\nFor more information on the privacy practices of Google, please visit the Google Privacy & Terms web page: https://policies.google.com/privacy?hl=en\n\n\n## Links To Other Sites {#links-to-other-sites}\n\n\nOur Service may contain links to other sites that are not operated by us. If you click on a third party link, you will be directed to that third party's site. We strongly advise you to review the Privacy Policy of every site you visit.\n\nWe have no control over and assume no responsibility for the content, privacy policies or practices of any third party sites or services.\n\n\n## Children's Privacy {#childrens-privacy}\n\n\nOur Service does not address anyone under the age of 18 (\"Children\").\n\nWe do not knowingly collect personally identifiable information from anyone under the age of 18. If you are a parent or guardian and you are aware that your Children has provided us with Personal Data, please contact us. If we become aware that we have collected Personal Data from children without verification of parental consent, we take steps to remove that information from our servers.\n\n\n## Changes To This Privacy Policy {#changes-to-this-privacy-policy}\n\n\nWe may update our Privacy Policy from time to time. We will notify you of any changes by posting the new Privacy Policy on this page.\n\nYou are advised to review this Privacy Policy periodically for any changes. Changes to this Privacy Policy are effective when they are posted on this page.\n\n\n## Contact Us {#contact-us}\n\n\nIf you have any questions about this Privacy Policy, please contact us by email at: privacy@azuracast.com\n", "documentId": "privacy-policy", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/privacy-policy/", "markdown": "https://sourcey-azuracast.pages.dev/docs/privacy-policy/index.md" } ] }, { "id": "user-guide/station-management/index.md", "kind": "page", "title": "Station Management", "description": "Managing your AzuraCast station and station profile", "tab": "user-guide", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/station-management/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/station-management/index.md", "file": "user-guide/station-management/index.md", "searchText": "\n\n> [!TIP]\n> **Required Permissions**\n>\n> To view a station's administration section, users must be in a role that has the \"View Station Page\" permission for the specified station.\n\n\n\nEach \"Station\" in AzuraCast is a separate entity with its own media, playlists, DJs, mount points, remote relays and statistics.\n\nYou can create any number of stations in a single AzuraCast installation, limited only by the total resources available on the server; for example, by default, only the ports for the first 50 stations are exposed.\n\nEach station has a main \"Profile\" page that offers an overview of that station's currently playing status, the status of its AutoDJ and main broadcasting software, and a list of all of its available mount points and remote relays.\n\nIf a user has the appropriate permissions, they will also see additional management options along the left sidebar of the Station Management page.\n\n\n## AutoDJ (Backend) vs Broadcasting Software (Frontend) {#autodj-backend-vs-broadcasting-software-frontend}\n\n\nEvery station has two essential components that are always running and which generate a broadcasted signal for the station:\n\n- The **AutoDJ** (also occasionally known as the \"Broadcasting Backend\") is a piece of software (in AzuraCast's case, Liquidsoap) that compiles media from various sources, different playlists and live input, and assembles that input into a single composited output stream, which it then transcodes into any number of various formats. Listeners don't connect directly to the AutoDJ to listen to the station, as it is optimized for producing the broadcast rather than serving it to a larger audience.\n\n- The **Broadcasting Software** (or the \"Broadcasting Frontend\") is the lightweight piece of software (Icecast, Shoutcast, or RSAS) whose primary job is to take the signal created by the AutoDJ and broadcast it out to potentially hundreds or thousands of listeners. This software is specifically optimized to support very many concurrent incoming connections with very little impact on system performance.\n\nPart of AzuraCast's function is to ensure both of these processes are properly configured, automatically started and kept running behind the scenes. When running an AzuraCast installation, you don't have to directly start either of these services for any station, and (with the exception of some specific changes, which require a brief restart) don't need to modify them directly for configuration changes in AzuraCast to take effect.\n\n\n### Shoutcast {#shoutcast}\n\n\n\n#### Installing Shoutcast {#installing-shoutcast}\n\n\n1. Download the Linux x64 binary from the [Shoutcast Radio Manager](https://radiomanager.shoutcast.com/register/serverSoftwareFreemium). The file name should look like: `sc_serv2_linux_x64-latest.tar.gz`\n2. Upload the Binary to AzuraCast: In your AzuraCast administration panel, navigate to the \"Install Shoutcast\" page (under the \"Stations\" header). Here, you can upload the `.tar.gz` file you downloaded. AzuraCast will automatically extract it to the correct location.\n\n\n#### Adding a License Key {#adding-a-license-key}\n\n\n- Visit the `Station Profile`\n- Click `Edit Profile`\n- Switch to the `Broadcasting` tab\n- Put the following in the `Custom Configuration` section:\n\n```json\n{ \"licenceid\": \"YOUR_LICENSE_ID\", \"userid\": \"YOUR_USER_ID\" }\n```\n\n\n### Rocket Streaming Audio Server (RSAS) {#rocket-streaming-audio-server-rsas}\n\n\nAzuraCast supports [Rocket Streaming Audio Server (RSAS)](https://www.rocketbroadcaster.com/streaming-audio-server/), a closed-source alternative to Icecast for broadcasting your station. While AzuraCast cannot distribute RSAS directly due to its proprietary nature, you can easily install it and use it with your stations. \n\n\n#### Installing RSAS {#installing-rsas}\n\n\n1. Download the RSAS Binary: Visit the official [RSAS download page](https://www.rocketbroadcaster.com/streaming-audio-server/download/) and get the correct statically linked binary for your server's platform. The file name should look like: `rsas-1.x.x-linux-(amd64/aarch64).tar.gz`\n2. Upload the Binary to AzuraCast: In your AzuraCast administration panel, navigate to the \"Install RSAS\" page (under the \"Stations\" header). Here, you can upload the `.tar.gz` file you downloaded. AzuraCast will automatically extract it to the correct location.\n3. Upload Your License Key (if applicable): If you're using the paid version of RSAS, you'll also receive a license key file. Upload this `.key` file separately on the same \"Install RSAS\" page.\n", "documentId": "station-management", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/station-management/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/station-management/index.md" } ] }, { "id": "user-guide/media-management/index.md", "kind": "page", "title": "Media Management", "description": "Managing and uploading media files in AzuraCast", "tab": "user-guide", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/media-management/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/media-management/index.md", "file": "user-guide/media-management/index.md", "searchText": "Media management is at the core of AzuraCast's built-in AutoDJ. By uploading media and assigning it to a playlist, the AutoDJ will automatically compose a live stream broadcast 24 hours a day, 7 days a week.\n\n\n\n> [!TIP]\n> For your AutoDJ to detect any files in your Media Manager, they must be added to at least one playlist. You can have media files in your station's media directory that aren't associated with any playlist, but they won't be played automatically.\n\n\n\n\n## Uploading Media {#uploading-media}\n\n\n\n### Web Uploader {#web-uploader}\n\n\nYou can upload media directly via your web browser, by either selecting files or clicking and dragging them into a section at the top of the Media Manager.\n\n\n### SFTP (Docker Only) {#sftp-docker-only}\n\n\nFor Docker installations, AzuraCast offers a built-in SFTP server which allows you to easily manage your media in bulk. Visit the [SFTP Server](/docs/user-guide/sftp-server/) guide for more information.\n\n\n### S3 Compatible {#s3-compatible}\n\n\nStations can utilize S3 compatible services (Backblaze, Digital Ocean Spaces, Linode Storage and S3) to manage it's media remotely, view our [S3 configuration](/docs/administration/storage-locations/#s3-compatible-storage-location) guide for more details.\n\n\n## Auto-Assigning Folders to Playlists {#auto-assigning-folders-to-playlists}\n\n\nFrom the media manager, you can select a folder, select \"Set Playlists\" and assign the folder to a playlist.\n\nOnce assigned to a playlist, any files added to the folder will automatically be added to those same playlists. The system won't remove any additional playlists that the media is in, but it will add the missing ones from the folder.\n\n\n## Required Permissions {#required-permissions}\n\n\nTo manage media, users must be in a role that has the \"Manage Station Media\" permission for the given station.\n\n\n## On-Demand Media {#on-demand-media}\n\n\nMusic from playlists with on-demand streaming enabled in playlist settings (under \"Include in On-Demand Player\") will be available to stream via the On-Demand Media public page. For this option to become available, \"Enable On-Demand Streaming\" under `Profile` -> `Edit Profile` -> `On-Demand Streaming` must be enabled.\n", "documentId": "media-management", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/media-management/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/media-management/index.md" } ] }, { "id": "user-guide/playlists/index.md", "kind": "page", "title": "Playlists", "description": "Managing playlists in AzuraCast", "tab": "user-guide", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/playlists/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/playlists/index.md", "file": "user-guide/playlists/index.md", "searchText": "\n\n> [!TIP]\n> **Required Permissions**\n>\n> To manage playlists, users must be in a role that has the \"Manage Station Media\" permission for the given station.\n\n\n\nPlaylists are collections of media that are played by the AutoDJ according to certain rules. For example, you can have one or more playlists that are considered \"General Rotation\" and will play throughout the day, or playlists that only play every few songs, or every few minutes.\n\nAny playlists types can also be scheduled to play in one or more specific time blocks, or to play between a certain date range.\n\n\n## Playlist Priorities {#playlist-priorities}\n\n\nIn newer versions of AzuraCast (released after September 1, 2024), you can specify the priority of individual playlists. If two playlists are both eligible to be played at the same time, the higher priority playlist will always be selected. This allows you to \"stack\" playlists in the same schedule slot, letting the priority system determine the actual playback order. You can also specify the priority of incoming listener requests (if they're enabled) to prevent them from always taking priority over general playlists.\n\n\n### Default Priorities {#default-priorities}\n\n\nIf you don't manually specify the priority of playlists, or if you're on an earlier version of AzuraCast, playlists follow this priority system by default:\n\n| Item Type | Priority\n| - | -\n| Song Requests | Always top priority\n| Once Per X Hour Playlists, Scheduled | 7\n| Once Per X Hour Playlists, Unscheduled | 6\n| Once Per X Songs Playlists, Scheduled | 5\n| Once Per X Songs Playlists, Unscheduled | 4\n| Once Per X Minutes Playlists, Scheduled | 3\n| Once Per X Minutes Playlists, Unscheduled | 2\n| General Rotation Playlists | 0\n\n\n## Advanced Playlists {#advanced-playlists}\n\n\n\n### What are Advanced Playlists? {#what-are-advanced-playlists}\n\n\nIf you create a new playlist in AzuraCast, you will notice one possible option for the playlist type called \"Advanced Playlist\". This article will explain what an advanced playlist is, and what benefits it can offer to power users.\n\nTo summarize, **an advanced playlist is a feature intended for \"power users\" who want to write the entire configuration for their playlist on Liquidsoap by hand, but still take advantage of AzuraCast for managing the contents of the playlist.**\n\nIf you use an advanced playlist, AzuraCast will still manage what songs are on the playlist, and let you add/remove songs via the web interface, but it won't try to automatically insert the corresponding configuration into Liquidsoap for you, like it would with any of the other playlist types.\n\nThis allows you to use far more complex custom rules for when a playlist plays than AzuraCast's web interface would otherwise allow. The example below demonstrates one use case for this feature (and is, in fact, the exact reason it exists in the software).\n\n\n### Case Study: Side-by-side Playlists {#case-study-side-by-side-playlists}\n\n\nOne AzuraCast user wanted to ensure that two playlists always played immediately one-after-the-other, every few songs. While AzuraCast itself has an \"every x songs\" option, it doesn't have any way to force that songs or music clips from two playlists always play right next to each other. This is possible, however, with more advanced Liquidsoap configuration. Thus, the \"Advanced Playlist\" was born.\n\nLet's say you create two playlists named \"Commercials\" and \"Bumpers\". AzuraCast will automatically insert variables for these playlists inside the station's `liquidsoap.liq` file, with the names being prefixed by \"playlist_\", with all characters converted to lower case and spaces replaced with underscores. For example, the corresponding variable names in this case are \"playlist_commercials\" and \"playlist_bumpers\", respectively.\n\nWhen you're using Liquidsoap as your AutoDJ software, on a station's primary management page under \"Broadcasting\" in the sidebar you will see a section named \"Edit Liquidsoap Configuration\". This page allows you to input raw code into the `liquidsoap.liq` file that will be used when the AutoDJ runs your station.\n\nIn this case, the following rule was added to the custom configuration to produce the side-by-side playlist result:\n\n```\nradio = rotate(weights=[1,1,5], [playlist_commercials, playlist_bumpers, radio])\n```\n\nThe variable radio is already defined in the Liquidsoap configuration, and represents the entire composed radio stream as it will broadcast out to listeners. The playlist names were defined using the rules described above. The rotate function is internal to Liquidsoap and follows a specific pattern of playback order, which is exactly what we want in this case.\n\nNote: By default, playlists are considered \"fallible\" in Liquidsoap terminology; that is, they can contain invalid files or otherwise aren't guaranteed to supply reliable output. More information about fallible sources is available on the [Liquidsoap documentation](http://liquidsoap.info/doc-dev/quick_start.html). Liquidsoap always requires an \"infallible\" source of audio to fall back to if the fallible sources don't produce a valid output. In the example above, the infallible source is the existing radio variable, but if you are completely overriding the output signal, you should make sure to have at least one \"safe\" playlist; that is, one playlist wrapped with the mksafe function, like:\n\n```\nradio = rotate(weights=[1,1,5], [mksafe(playlist_jingles), playlist_commercials, playlist_music])\n```\n\nLiquidsoap is itself a very powerful piece of software, and has a robust [API](http://savonet.sourceforge.net/doc-svn/reference.html) that you can use when adding your own advanced configuration options. Feel free to experiment with advanced configuration options on a test instance of AzuraCast, because if something doesn't work quite right, you can always just remove the customization, restart the station and be back up and running.\n", "documentId": "playlists", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/playlists/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/playlists/index.md" } ] }, { "id": "user-guide/mount-points/index.md", "kind": "page", "title": "Mount Points", "description": "Managing how listeners connect and listen to your broadcasts with Mount Points", "tab": "user-guide", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/mount-points/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/mount-points/index.md", "file": "user-guide/mount-points/index.md", "searchText": "\n\n> [!TIP]\n> **Required Permissions**\n>\n> To manage mount points, users must be in a role that has the \"Manage Station Mount Points\" permission for the given station.\n\n\n\nMount Points are how listeners connect and listen to your broadcasts.\n\nEach Station in AzuraCast represents one single broadcast (with one currently playing title, artist, etc.), but with multiple Mount Points you can output that broadcast in multiple formats (i.e. MP3, Ogg Vorbis) or bitrates (i.e. 128kbps or 64kbps).\n\nNote that not all formats are compatible with all platforms. For instance, iOS users won't be able to listen to the Ogg format as it is not supported by Safari on iOS at the moment. [Checking formats compatibility](https://caniuse.com/) can help you decide which one will be better for your station.\n\nFurthermore, it should be noted that OGG Opus and FLAC (OGG FLAC) do NOT send \"Current Song\", \"Artist\", or \"Title\" (and subsequently, \"yp_currently_playing\") information to Icecast.\n\n\n## Advanced {#advanced}\n\n\n\n### Mount Point URL {#mount-point-url}\n\n\nYou can set a custom URL for streams that AzuraCast will use when referring to it in both the web UI and in [API responses](/docs/developers/now-playing-data/#standard-now-playing-api) (specifically, `station.listen_url` and `mounts.*.url`). Leaving the field empty uses the default value, generated in the format: `{HTTP/HTTPS}://{BASE_URL}.TLD/listen/{STATION_URL_STUB}/{MOUNT_POINT_URL}`.\n\n\n### Custom Frontend Configuration {#custom-frontend-configuration}\n\n\nThis is a good spot to define mount-specific settings such as an [intro file](/docs/administration/docker/#stream-intro-file) or [http headers](https://www.stream-meta.info/version_2_headers.html).\n", "documentId": "mount-points", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/mount-points/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/mount-points/index.md" } ] }, { "id": "user-guide/streamers-and-djs/index.md", "kind": "page", "title": "Streamers & DJs", "description": "Managing live DJs with separate connection details, name, settings and how to connect", "tab": "user-guide", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/streamers-and-djs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/streamers-and-djs/index.md", "file": "user-guide/streamers-and-djs/index.md", "searchText": "\n\n> [!TIP]\n> **Required Permissions**\n>\n> To manage streamers and DJs, users must be in a role that has the \"Manage Station Streamers\" permission for the given station.\n\n\n\nIf your station has \"Enable Streamers\" turned on, you can create multiple DJ accounts that can connect and broadcast live audio to your listeners.\n\nIn order to allow a seamless transition between live DJs and the AutoDJ, each streamer connects directly to the AutoDJ software (Liquidsoap). Liquidsoap accepts connections from broadcast software that are compatible with either Icecast or Shoutcast servers.\n\nAzuraCast will keep track of the broadcast history for each DJ that broadcasts live on your station.\n\nWe have guides for how to configure many kinds of popular streaming software. See the [Streaming Software](/docs/user-guide/streaming-software/) page for more information.\n\n\n## Recording Broadcasts {#recording-broadcasts}\n\n\nYou can opt to record live broadcasts by editing the station's profile. Broadcasts will automatically be recorded in the format and bitrate that you specify, and can be downloaded from the \"Broadcasts\" popup menu next to each streamer.\n", "documentId": "streamers-and-djs", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/streamers-and-djs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/streamers-and-djs/index.md" } ] }, { "id": "user-guide/streaming-software/index.md", "kind": "page", "title": "Streaming Software", "description": "Examples and tutorials of software that can be used to stream to AzuraCast", "tab": "user-guide", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/streaming-software/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/streaming-software/index.md", "file": "user-guide/streaming-software/index.md", "searchText": "\n\n> [!CAUTION]\n> If you are using a reverse proxy service (like CloudFlare) in front of your installation, be aware that these services often prevent direct connections to the ports that broadcasters connect to. You should instruct your streamers to use the direct IP address of your server instead.\n\n\n\n\n## Mixxx {#mixxx}\n\n\n**Linux, MacOS, Windows; Free and Open-Source**\n\n[Mixxx](https://www.mixxx.org) is free and open-source DJ software that also supports live broadcasting via Icecast and Shoutcast servers.\n\nLive broadcasting settings can be found in the preferences menu (`Options` -> `Preferences`). It is recommended to use \"Icecast 2\" mode when broadcasting to AzuraCast. Out of the box, Mixxx does not include the LAME MP3 encoder (for licensing reasons), but it is not needed when connecting to AzuraCast; just set your broadcast format to 'Ogg Vorbis' and LiquidSoap will transcode the broadcast into the correct output format.\n\n![Mixxx preferences menu](/docs/_media/98505d1c3fca60d20868.png)\n\n\n## Broadcast Using This Tool (BUTT) {#broadcast-using-this-tool-butt}\n\n\n**Linux, MacOS, Windows; Free and Open-Source**\n\n[BUTT](https://danielnoethen.de/butt/) is cross-platform and available for free. While BUTT supports both Icecast and Shoutcast connection modes, since AzuraCast internally uses Liquidsoap to facilitate all DJ connections, the connection mode used is largely irrelevant. Thus, **we recommend using Icecast mode** as it is more modern.\n\nTo add a new server, click \"Settings\" on the main app panel, then in the \"Server Settings\" section, click the \"ADD\" button to create a new server.\n\n![BUTT Sample Configuration](/docs/_media/9649a4e20be2a339acc4.png)\n\nUsing the \"Connection Information\" from your station's \"Streamers/DJ Accounts\" page, enter:\n\n - In \"Type\", select \"Icecast\".\n - In \"Address\", enter the value from the \"Server\" heading on the info page.\n - In \"Port\", enter the value from the \"Port\" heading on the info page.\n - In \"Icecast user\", enter your DJ username.\n - In \"Password\", enter your DJ password.\n - In \"Icecast mountpoint\", enter the value from the \"Mount Name\" heading on the info page; this is likely \"/\" (without quotes).\n\n\n## Broadcast Using This Tool Modernized (BUTTM) {#broadcast-using-this-tool-modernized-buttm}\n\n\n**MacOS, Windows; Proprietary, Commercial**\n\n[BUTTM](https://buttm.app/) is the spiritual successor to BUTT, but with a modernized user interface and experience. It's available for a one-time fee. Either edition is compatible with AzuraCast, but the Standard edition is limited to broadcasting at a bitrate of 128kbps.\n\nJust like BUTT, BUTTM supports both Icecast and Shoutcast connection modes. Since AzuraCast internally uses Liquidsoap to facilitate all DJ connections, the connection mode used is largely irrelevant; thus, **we recommend using Icecast mode** as it is more modern.\n\nTo add a new server, click \"Server Manager\" on the main app panel, then click the \"+\" button in the bottom left corner to add a new server.\n\n![BUTTM Sample Configuration](/docs/_media/d564a7ce2ba4f318b7be.png)\n\nUsing the \"Connection Information\" from your station's \"Streamers/DJ Accounts\" page, enter:\n\n - In \"Type\", select \"Icecast\".\n - In \"Address\", enter the value from the \"Server\" heading on the info page.\n - In \"Port\", enter the value from the \"Port\" heading on the info page.\n - In \"Username\", enter your DJ username.\n - In \"Mountpoint\", enter the value from the \"Mount Name\" heading on the info page; this is likely \"/\" (without quotes).\n - In \"Password\", enter your DJ password.\n\n\n## SAM Cast {#sam-cast}\n\n\n**Windows; Proprietary, Commercial**\n\n[SAM Cast](https://spacial.com/sam-cast/) is commercial software sold by Spacial. It is compatible with AzuraCast by using the MP3 encoder and the \"Icecast 2\" server connection settings.\n\nFrom the main SAM Cast window, click \"Encoders\" at the bottom left.\n\n![](/docs/_media/c89d7aee740d9affe7c4.png)\n\nIn the Encoders window that pops up, click the plus sign button on the toolbar to add a new encoder.\n\n![](/docs/_media/eefb1eb7ca8fdbdf2d35.png)\n\nYou will be asked to select an encoder. It is recommended to select `MP3 (LAME_ENC)`, because this allows for the easiest constant bit rate (CBR) streaming, which causes the fewest issues when broadcasting.\n\nClick \"OK\" at the bottom to continue to encoder details.\n\n![](/docs/_media/15781bf3fba38dc55440.png)\n\nOn the first tab of the encoder details, change your bitrate from the default 64kbps to your desired bitrate. This should likely match the highest bitrate that you broadcast out to your listeners. By default, it should at least be 128kbps.\n\n![](/docs/_media/53615c7f09def185245d.png)\n\nClick the \"Server Details\" tab. On the \"Server Type\" selector, choose \"Icecast\", then choose \"Icecast 2\" in the secondary selector.\n\nYou can now populate the \"Server Details\" section with the connection information supplied to you via AzuraCast's \"Streamers/DJs\" page. You will want to use the connection information for \"Icecast Clients\", the first section on the page.\n\n![](/docs/_media/c53d5be266a557d30f49.png)\n\nClick OK to return to the main Encoders pane, where you will now see a new encoder with \"Idle\" status.\n\nSelect the encoder, then click the play-button icon in the toolbar to begin broadcasting.\n\n![](/docs/_media/dfbee2df109f07e8ddda.png)\n\n\n## RadioBOSS {#radioboss}\n\n\n**Windows; Proprietary, Commercial**\n\n[RadioBOSS](https://www.djsoft.net/) is a commercial software sold by IP Kuzmitski D.V. at DJSoft.net.\n\nStreaming via both Icecast mode and Shoutcast mode are available; however, because AzuraCast uses Liquidsoap as an intermediary for DJ connections, **it is recommended to use Icecast for connections, as it is more modern**.\n\nThe Live broadcasting feature is possible in their Standard and Advanced edition (not in the Express edition).\n\nNote that for ease of use we use the `Configuration Wizard`, you can also enter all connection details manually.\n\n1. In the top menu bar, select `Settings` -> `Options`\n\n2. In the `Settings` window, select `Broadcast` on the left\n\n3. To add a new encoder, click the `+` button\n\n![RadioBOSS Settings: Broadcast menu](/docs/_media/4fc411382205c160d43e.jpg)\n\n4. The Encoder-window will open, next click the button called `Configuration Wizard`.\n\n![RadioBOSS Encoder window](/docs/_media/d54fb18661b476344e82.jpg)\n\n5. Select `Icecast 1 & 2` and click `Next >`\n\n![RadioBOSS Encoder Configuration Wizard Icecast](/docs/_media/7630246aa77a6473423b.jpg)\n\n6. Take over the corresponding credentials you can find in Azuracast:\n\n![RadioBOSS Encoder Configuration Wizard Icecast Azuracast Example settings](/docs/_media/ee430870c8bb71167d76.jpg)\n\n7. Click `Finish`\n\n8. Finish by changing the rest of the settings by preference:\n - Connection\n - Sample Rate\n - Encoder\n - Bitrate\n - Channels\n - Station info\n\n If needed, here you can override the info that can be found in the main `Settings` (From step 1), under `Broadcasting` -> `Metadata`\n\n9. Then finally click `OK` to save the Encoder.\n\n10. In the Settings window, check the checkboxes for all encoders that you want to use.\n Remember to turn on the option `Broadcasting enabled` on top.\n\nOn succesful connection, the log report in the bottom-left corner of RadioBOSS will show the following message: \"Connected to server! (Output N)\". This means that listeners can now connect to the streaming server (either Icecast or Shoutcast).\n\nIf the logs show \"[E40] Cannot start broadcast\" in red, go over the above steps.\n\nMore information can be found in the RadioBOSS Help System. Press `Ctrl+F1` inside the RadioBOSS application, or in the top menu bar go to `Help` -> `Contents`.\n\nThe following articles in there are helpful:\n\n- `Operation` -> `Broadcasting Internet radio`\n- `Options` -> `Broadcast`\n- `Options` -> `Broadcast` -> `Metadata`\n\n\n## PlayIt Live {#playit-live}\n\n\n**Windows; Proprietary, Free**\n\n[PlayIt Live](https://www.playitsoftware.com/Products/Live) is a free live-assist and automated radio playout system from PlayIt Software.\n\nIt allows streaming via **Icecast**, **Shoutcast v1** and **Shoutcast v2** via a plugin, that you can download for free [here](https://www.playitsoftware.com/Plugins/View/InternetBroadcast), after creating an account on their website. This plugin also allows you to record the stream, in MP3.\n\nThe installation steps for the plugin are relatively simple, so they're not covered in this guide.\n\n***Note:** This software is only capable of streaming via MP3, due to plugin limitations.*\n\nPlayItLive supports both Icecast and Shoutcast connection modes; however, because AzuraCast uses Liquidsoap as an intermediary for all DJ connections, the connection method is not important. Thus, **it is recommended to use the Icecast connection mode, as it is more modern**.\n\n1. After installing the Internet Broadcast plugin, select the menu **Plugins** menu, on the top menu bar and select the **Plugin Manager...** option.\n\n![Plugins menu](/docs/_media/424d1d0f93acd99029b4.png)\n\n_Select the Plugins menu, then the Plugin Manager option_\n\n2. A new window should appear, and within it the Internet Broadcast plugin.\n\n![Plugin Manager](/docs/_media/52f7f73761ddd33334d8.png)\n_The Plugin Manager window_\n\n3. Open the plugin settings, by double clicking on it's name. This window should appear.\n\n![Plugin settings](/docs/_media/6da86db5466738795128.png)\n_Plugin Settings_\n\n**There are a few settings that you can customize here:**\n\n- In **Audio source to broadcast** you can define which input is going to be transmited to the server;\n- **Auto start streams** let's you start streaming after opening the software.\n\n**4.** Under **Streams**, click **Add** to add a new streaming server.\n\n**1.** Using the connection details, available in your AzuraCast instance, under the **Streamers/DJ Accounts** page,\n\n![Connection Details](/docs/_media/19b036ef15241b046809.png)\n\n_Connection Information for Icecast_\n\n... fill this form in the PlayIt Live software.\n\n![Stream Details](/docs/_media/0867f9cde2c49114b012.png)\n\n_Using the details above to fill the form_\n\n**Don't forget to change these details with yours, this is just an example!**\n\n**Notes:**\n\n- The **Save audio to file** field can be left unchecked. Check it if you want to record the stream into a MP3 file.\n- Under **Audio**, select the audio bitrate and the format (stereo or mono) that matches your station.\n\n**2.** After filling the form fields, click **OK** to save the server details.\n\n**3.** To start broadcasting, click on Start Streams here on in the main interface of the software.\n\n![Starting the streams](/docs/_media/c0e44ee187c9540b9614.png)\n\nIf the server is configured correctly, the **OFF AIR** text will change to **ON AIR**. If not, re-check your configuration.\n\n\n## Rocket Broadcaster {#rocket-broadcaster}\n\n\n**Windows; Proprietary (Free & Pro editions)**\n\nRocket Broadcaster is a robust streaming encoder for Windows, designed for internet radio stations and professional broadcasting. It captures audio from various sources, including microphones, line-in devices, and other applications, and streams it to your station. Rocket Broadcaster supports both Icecast and Shoutcast servers.\n\n1. **Configure Your Audio Input**\n\n - Go to **Options** > **Preferences**.\n - In the **Audio Input** tab, select your microphone or audio interface as the **Input device**. Set the **Sample rate**, typically to `44100 Hz`.\n - If you plan to broadcast audio from other applications, configure **System Audio Capture** in the same preferences window.\n - Click **OK**.\n - Return to the main window and ensure the **VU meters** move when audio is present.\n\n2. **Configure Your Stream**\n\n - Go to **Broadcast** > **Streams....**\n - Click **Add** to create a new output stream.\n - Enter the connection details provided by your streaming server (Icecast or Shoutcast). This includes:\n - **Server Type:** Select `Icecast 2` or the appropriate `SHOUTcast` version.\n - **Hostname or IP**\n - **Port**\n - **Mountpoint** (for Icecast)\n - **Username** and **Password** (or `dj_username:dj_password` for some SHOUTcast v1 setups).\n - Under **Encoder Settings**, choose your desired **Codec** (e.g., MP3, Ogg Vorbis, AAC for Pro) and set the **Bitrate** and **Channels**.\n - Click **OK**.\n\n3. **Test Your Stream**\n\n - In the main Rocket Broadcaster window, click **Start Broadcast**.\n - If successful, you'll see \"On Air\". If you encounter an error, double-check your stream settings for typos.\n\n4. **Configure Metadata (Optional)**\n - To display song artist and title to your listeners, go to **Broadcast** > **Metadata Capture**.\n - Configure the capture method to automatically pull metadata from your radio automation system or media player.\n\nSee the official [Rocket Broadcaster documentation](https://www.rocketbroadcaster.com/docs/) for detailed instructions on how to set up and use the software.\n", "documentId": "streaming-software", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/streaming-software/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/streaming-software/index.md" } ] }, { "id": "user-guide/remote-relays/index.md", "kind": "page", "title": "Remote Relays", "description": "Adding and using remote stream relays with AzuraCast and AzuraRelay", "tab": "user-guide", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/remote-relays/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/remote-relays/index.md", "file": "user-guide/remote-relays/index.md", "searchText": "\n\n> [!TIP]\n> **Required Permissions**\n>\n> To manage remote relays, users must be in a role that has the \"Manage Station Media\" permission for the given station.\n\n\n\nWhen you want to broadcast the radio signal created on your AzuraCast installation to a remote source, you should create a remote relay.\n\nThere are two primary types of remote relay:\n\n- **Statistics Only:** You can add a relay, but not instruct the AutoDJ to connect to it; this is useful if the remote relay already connects to your main station and relays the broadcast itself. The relay's statistics will be included with your other station statistics automatically.\n\n- **Full Relay:** In this type of relay, your AzuraCast installation's AutoDJ broadcasts its signal to the remote relay directly, and AzuraCast then includes the remote relay's statistics along with your other station statistics.\n\n\n## AzuraRelay {#azurarelay}\n\n\nIf you're serving radio traffic to a large volume of listeners and want to add redundant relays in the easiest way possible, we offer a separate project called [AzuraRelay](https://github.com/AzuraCast/AzuraRelay) that is the perfect complement to AzuraCast itself.\n\nInstall AzuraRelay on a VPS of your choice, configure it to refer to the base AzuraCast installation, and it will automatically pull a list of available streams and relay them, while sending listener statistics back to the main installation.\n\nYou can add as many AzuraRelay instances as you want, and they will have very little performance impact on the main installation, because the relays are configured to pull the transcoded signal from AzuraCast's mount points and relay it directly.\n\nTake a look at our [documentation of the AzuraRelay](/docs/administration/azurarelay/) for installation instructions.\n", "documentId": "remote-relays", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/remote-relays/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/remote-relays/index.md" } ] }, { "id": "user-guide/promoting-your-station/index.md", "kind": "page", "title": "Promoting Your Station", "description": "Tools for helping listeners discover your station.", "tab": "user-guide", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/promoting-your-station/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/promoting-your-station/index.md", "file": "user-guide/promoting-your-station/index.md", "searchText": "There are many directories around the Web where users can find new radio stations to listen to. This page documents how to integrate your AzuraCast station with these directories.\n\n\n## Webhook-Based Directories {#webhook-based-directories}\n\n\nThese directories support any broadcast technology and receive \"Now Playing\" metadata updates via a custom API, which we implement in AzuraCast via our Web Hooks feature.\n\n\n### TuneIn AIR {#tunein-air}\n\n\nAzuraCast supports sending automatic metadata updates to TuneIn's [AIR broadcasting API](https://tunein.com/broadcasters/api/) via a Web Hook.\n\nYou will first need a station ID from TuneIn. Contact them directly for more information about signing up for an API account.\n\nOnce you have a station ID, you can create a new web hook via the `Web Hooks` station sidebar menu inside AzuraCast.\n\n\n### Radio.de {#radiode}\n\n\nAzuraCast supports sending automatic metadata updates to [Radio.de's Metadata Push API](https://corporate.radio.de/sender/) as of Version 0.19.1.\n\nYou should first contact the Radio.de team directly to gain access to the API. Once you have the necessary credentials, you can create a new web hook via the `Web Hooks` station sidebar inside AzuraCast.\n\n\n### GetMeRadio {#getmeradio}\n\n\nAzuraCast supprots sending automatic metadata updates to [GetMeRadio](https://my.getmeradio.com) as of Version 0.19.2.\n\nContact the GetMeRadio team first to gain access to their API. Once you have the necessary credentials, you can create a new web hook via the `Web Hooks` station sidebar inside AzuraCast.\n\n\n## YellowPages Directories {#yellowpages-directories}\n\n\nThese directories use Icecast's built-in YellowPages (YP) discovery mechanism to submit routine updates. They require using Icecast to broadcast rather than Shoutcast or HLS.\n\n\n\n> [!TIP]\n> Adding YellowPages directories requires that the \"Enable Advanced Settings\" system setting is enabled in AzuraCast. An installation administrator can enable this setting at any time from the web interface.\n\n\n\n\n\n> [!TIP]\n> By default, all mount points on a station will be advertised to any Yellow Pages directory. To limit which mount points are visible,you can edit a mount point and uncheck the `Publish to \"Yellow Pages\" Directories` setting.\n\n\n\n\n### Xiph Icecast Directory {#xiph-icecast-directory}\n\n\nXiph, the maintainers of Icecast, also maintain a public directory of stations at [dir.xiph.org](https://dir.xiph.org/).\n\nTo add your station to the directory, edit your station's profile, then under the \"Broadcasting\" tab, you will find \"Custom Configuration\" at the bottom of the page.\n\nYou can add the following entry to broadcast to the Xiph directory:\n\n```xml\n\n 15\n http://dir.xiph.org/cgi-bin/yp-cgi\n\n```\n\n\n### Internet-radio.com {#internet-radiocom}\n\n\n\n\n> [!TIP]\n> Listing on this directory requires that your station description and other profile fields be 255 characters or fewer.\n\n\n\nThe station directory at [internet-radio.com](https://www.internet-radio.com/) supports and recommends using Icecast's YellowPages directory to manage your station listing on their web site. Their forum includes [specific instructions for Icecast](https://www.internet-radio.com/community/threads/icecast-server-yp-directory-settings.22223/).\n\nTo integrate the custom directory code into AzuraCast, edit your station's profile, then under the \"Broadcasting\" tab, you will find \"Custom Configuration\" at the bottom of the page.\n\nYou can add the following entry:\n\n```xml\n\n 15\n http://icecast-yp.internet-radio.com\n\n```\n\n\n## Icecast Header Directories {#icecast-header-directories}\n\n\nThese directories receive metadata updates via custom headers provided directly in your Icecast stream. They require using Icecast to broadcast rather than Shoutcast or HLS.\n\n\n\n> [!TIP]\n> Adding custom Icecast headers requires that the \"Enable Advanced Settings\" system setting is enabled in AzuraCast. An installation administrator can enable this setting at any time from the web interface.\n\n\n\n\n### radio-browser.info {#radio-browserinfo}\n\n\nFirst, review the [Station owner instructions](https://www.radio-browser.info/owners) on the directory web site.\n\nTo add custom headers to a station, open the `Broadcasting` sidebar menu, then click `Mount Points`. Click `Edit` on a mount point, and supply the custom headers in the advanced configuration for the mount point:\n\n```xml\n\n
\n
\n
\n
\n
\n
\n
\n\n```\n\n\n\n> [!CAUTION]\n> **Power users only!**\n>\n> HTTP-headers must be added to each individual mount point. Adding them to the station-wide Custom Configuration (under `Profile` -> `Edit Profile` -> `Broadcasting`) will not work.\n\n\n", "documentId": "promoting-your-station", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/promoting-your-station/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/promoting-your-station/index.md" } ] }, { "id": "user-guide/sftp-server/index.md", "kind": "page", "title": "SFTP Server", "description": "The built-in SFTP server for Docker installations", "tab": "user-guide", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/sftp-server/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/sftp-server/index.md", "file": "user-guide/sftp-server/index.md", "searchText": "\n\n> [!TIP]\n> The Built-in SFTP server is only available on the Docker installation.\n\n\n\nAll AzuraCast Docker installations come with a built-in SFTP server that allows you to easily connect to your media directory, upload and move files using software of your choice.\n\n\n## Creating SFTP Users {#creating-sftp-users}\n\n\n\n\n> [!TIP]\n> You will only be able to connect to the SFTP server to manage your media if your station's storage location is a \"Local\" one to the server. If you're connecting to S3, Dropbox, etc. then you can instead use clients that can connect directly to the same storage location your station is using.\n\n\n\nUnder the `Media` sidebar menu for a given station, you will see an entry labeled `SFTP Users`. Click this to view existing users and the connection details for connecting to your server via an SFTP client of your choice.\n\n\n## Default Port {#default-port}\n\n\nBy default, the SFTP service listens externally on port 2022. If there is something else using this port or you want to change it for any other reason, you can edit the `.env` file on your host machine and add or modify this line:\n\n```\nAZURACAST_SFTP_PORT=2022\n```\n\n\n\n> [!TIP]\n> Note, this is a file named `.env`, with no filename, and not the `azuracast.env` file\n\n\n\n\n## Connecting to SFTP {#connecting-to-sftp}\n\n\n\n### SFTP clients {#sftp-clients}\n\n\nHere's a small list of FTP clients you can use that are known to work with AzuraCast's SFTP system.\n\n- [Filezilla](https://filezilla-project.org/) - Windows, MacOS and Linux 32 bit & 64 bit\n- [WinSCP](https://winscp.net/eng/download.php) - Windows only\n- [Cyberduck](https://cyberduck.io/) - Windows and MacOS\n\nA more exhaustive list can be found [here](https://en.wikipedia.org/wiki/Comparison_of_FTP_client_software).\n\n\n### Mounting as a Directory on Your Computer {#mounting-as-a-directory-on-your-computer}\n\n\nThere are also numerous tools that let you create a virtual filesystem based on an SFTP connection, which then lets you drag and drop files to and from the filesystem using your OS's standard file explorer:\n\n- [Mountain Duck](https://mountainduck.io/) - Windows and MacOS\n- [ExpanDrive](https://www.expandrive.com/) - Windows, MacOS and Linux\n- [SSHFS for Linux/MacOS](https://github.com/libfuse/sshfs)\n- [SSHFS for Windows](https://github.com/winfsp/sshfs-win)\n\nFor more information on configuring SSHFS, see [this thread](https://github.com/AzuraCast/AzuraCast/discussions/6510).\n", "documentId": "sftp-server", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/user-guide/sftp-server/", "markdown": "https://sourcey-azuracast.pages.dev/docs/user-guide/sftp-server/index.md" } ] }, { "id": "api/index.md", "kind": "page", "title": "AzuraCast", "description": "AzuraCast 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.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/index.md", "file": "api/index.md", "searchText": "info title AzuraCast summary version 0.23.8 description AzuraCast 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. termsOfService contact license name GNU Affero General Public License v3.0 or later url https://www.gnu.org/licenses/agpl-3.0.txt identifier logo servers 0 url https://demo.azuracast.com/api description AzuraCast Public Demo Server variables tags 0 name Public: Now Playing summary description Endpoints that provide full summaries of the current state of stations. externalDocs 1 name Public: Stations summary description externalDocs 2 name Public: Miscellaneous summary description externalDocs 3 name Stations: General summary description externalDocs 4 name Stations: Broadcasting summary description externalDocs 5 name Stations: HLS Streams summary description externalDocs 6 name Stations: Media summary description externalDocs 7 name Stations: Mount Points summary description externalDocs 8 name Stations: Playlists summary description externalDocs 9 name Stations: Podcasts summary description externalDocs 10 name Stations: Queue summary description externalDocs 11 name Stations: Remote Relays summary description externalDocs 12 name Stations: Reports summary description externalDocs 13 name Stations: SFTP Users summary description externalDocs 14 name Stations: Streamers/DJs summary description externalDocs 15 name Stations: Web Hooks summary description externalDocs 16 name Administration: General summary description externalDocs 17 name Administration: Debugging summary description externalDocs 18 name Administration: Backups summary description externalDocs 19 name Administration: Custom Fields summary description externalDocs 20 name Administration: Users summary description externalDocs 21 name Administration: Roles summary description externalDocs 22 name Administration: Settings summary description externalDocs 23 name Administration: Stations summary description externalDocs 24 name Administration: Storage Locations summary description externalDocs 25 name My Account summary description externalDocs 26 name Miscellaneous summary description externalDocs securitySchemes ApiKey type apiKey name X-API-Key description in header scheme bearerFormat flows openIdConnectUrl oauth2MetadataUrl deprecated ", "documentId": "introduction", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/index.md" } ] }, { "id": "api/operations/adminacmeviewlog/index.md", "kind": "operation", "title": "View the logs of a manually run ACME certificate renewal.", "description": "GET /admin/acme-log/{path}: returns Api_LogContents.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminacmeviewlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminacmeviewlog/index.md", "file": "api/operations/adminacmeviewlog/index.md", "searchText": "operationId adminAcmeViewLog summary View the logs of a manually run ACME certificate renewal. description method get path /admin/acme-log/{path} tags 0 Administration: General parameters 0 name path in path description Log path as returned by the Run action. required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogContents properties contents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName eof name type boolean format title description Whether the log file has ended at this point or has additional data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName position name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 contents 1 eof 2 position example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/acme-log/{path}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminacmeviewlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminacmeviewlog/index.md" } ] }, { "id": "api/operations/putadmingenerateacmecert/index.md", "kind": "operation", "title": "Generate or renew ACME certificate.", "description": "PUT /admin/acme: returns Api_TaskWithLog.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putadmingenerateacmecert/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putadmingenerateacmecert/index.md", "file": "api/operations/putadmingenerateacmecert/index.md", "searchText": "operationId putAdminGenerateAcmeCert summary Generate or renew ACME certificate. description method put path /admin/acme tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_TaskWithLog properties logUrl name type string format uri title description The URL to view logs of the ongoing background task. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 logUrl example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/acme", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putadmingenerateacmecert/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putadmingenerateacmecert/index.md" } ] }, { "id": "api/operations/adminlistapikeys/index.md", "kind": "operation", "title": "List all current API keys across the system.", "description": "GET /admin/api-keys.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminlistapikeys/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminlistapikeys/index.md", "file": "api/operations/adminlistapikeys/index.md", "searchText": "operationId adminListApiKeys summary List all current API keys across the system. description method get path /admin/api-keys tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ApiKey allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/api-keys", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminlistapikeys/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminlistapikeys/index.md" } ] }, { "id": "api/operations/admincreateapikey/index.md", "kind": "operation", "title": "Create a new API key for a specified user.", "description": "POST /admin/api-keys: takes Api_Admin_NewApiKey.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admincreateapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admincreateapikey/index.md", "file": "api/operations/admincreateapikey/index.md", "searchText": "operationId adminCreateApiKey summary Create a new API key for a specified user. description method post path /admin/api-keys tags 0 Administration: General parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_NewApiKey properties user name type format title description User ID or e-mail address. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Admin-generated API key examples refName required 0 user example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Account_NewApiKey properties key name type string format title description The newly generated API key. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 key 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ApiKey allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/api-keys", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admincreateapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admincreateapikey/index.md" } ] }, { "id": "api/operations/admindeleteapikey/index.md", "kind": "operation", "title": "Delete a single API key.", "description": "DELETE /admin/api-key/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindeleteapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindeleteapikey/index.md", "file": "api/operations/admindeleteapikey/index.md", "searchText": "operationId adminDeleteApiKey summary Delete a single API key. description method delete path /admin/api-key/{id} tags 0 Administration: General parameters 0 name id in path description API Key ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/api-key/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindeleteapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindeleteapikey/index.md" } ] }, { "id": "api/operations/getauditlog/index.md", "kind": "operation", "title": "List all Audit Log actions that have taken place on the installation.", "description": "GET /admin/auditlog: returns a list of AuditLog.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getauditlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getauditlog/index.md", "file": "api/operations/getauditlog/index.md", "searchText": "operationId getAuditlog summary List all Audit Log actions that have taken place on the installation. description method get path /admin/auditlog tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName AuditLog required 0 timestamp 1 operation 2 operationText 3 class 4 identifier 5 targetClass 6 target 7 changes 8 user allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties timestamp name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName operation name type format title description default enum 0 1 1 2 2 3 enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName operationText name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName class name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName identifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName targetClass name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName target name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName changes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_AuditLogChangeset properties field name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName from name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName to name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 field 1 from 2 to user name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/auditlog", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getauditlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getauditlog/index.md" } ] }, { "id": "api/operations/deletebackup/index.md", "kind": "operation", "title": "Delete a given backup.", "description": "DELETE /admin/backups/delete/{path}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletebackup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletebackup/index.md", "file": "api/operations/deletebackup/index.md", "searchText": "operationId deleteBackup summary Delete a given backup. description method delete path /admin/backups/delete/{path} tags 0 Administration: Backups parameters 0 name path in path description Download path (base64-encoded \"StorageLocationID | Path\") required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/backups/delete/{path}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletebackup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletebackup/index.md" } ] }, { "id": "api/operations/downloadbackup/index.md", "kind": "operation", "title": "Download a given backup.", "description": "GET /admin/backups/download/{path}.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/downloadbackup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/downloadbackup/index.md", "file": "api/operations/downloadbackup/index.md", "searchText": "operationId downloadBackup summary Download a given backup. description method get path /admin/backups/download/{path} tags 0 Administration: Backups parameters 0 name path in path description Download path (base64-encoded \"StorageLocationID | Path\") required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/backups/download/{path}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/downloadbackup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/downloadbackup/index.md" } ] }, { "id": "api/operations/getbackups/index.md", "kind": "operation", "title": "Return a list of all current backups.", "description": "GET /admin/backups: returns a list of Api_Admin_Backup.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getbackups/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getbackups/index.md", "file": "api/operations/getbackups/index.md", "searchText": "operationId getBackups summary Return a list of all current backups. description method get path /admin/backups tags 0 Administration: Backups parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Backup required 0 path 1 basename 2 pathEncoded 3 timestamp 4 size 5 storageLocationId allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName basename name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName pathEncoded name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timestamp name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storageLocationId name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/backups", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getbackups/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getbackups/index.md" } ] }, { "id": "api/operations/adminbackupsviewlog/index.md", "kind": "operation", "title": "View a specific backup log contents.", "description": "GET /admin/backups/log/{path}: returns Api_LogContents.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminbackupsviewlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminbackupsviewlog/index.md", "file": "api/operations/adminbackupsviewlog/index.md", "searchText": "operationId adminBackupsViewLog summary View a specific backup log contents. description method get path /admin/backups/log/{path} tags 0 Administration: Backups parameters 0 name path in path description Log path as returned by the Run action. required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogContents properties contents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName eof name type boolean format title description Whether the log file has ended at this point or has additional data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName position name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 contents 1 eof 2 position example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/backups/log/{path}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminbackupsviewlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminbackupsviewlog/index.md" } ] }, { "id": "api/operations/postadmindobackup/index.md", "kind": "operation", "title": "Initialize a manual backup.", "description": "POST /admin/backups/run: returns Api_TaskWithLog.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadmindobackup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadmindobackup/index.md", "file": "api/operations/postadmindobackup/index.md", "searchText": "operationId postAdminDoBackup summary Initialize a manual backup. description method post path /admin/backups/run tags 0 Administration: Backups parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_TaskWithLog properties logUrl name type string format uri title description The URL to view logs of the ongoing background task. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 logUrl example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/backups/run", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadmindobackup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadmindobackup/index.md" } ] }, { "id": "api/operations/getadmincustomasset/index.md", "kind": "operation", "title": "Get the details of the custom asset of the specified type.", "description": "GET /admin/custom_assets/{type}: returns Api_UploadedRecordStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmincustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmincustomasset/index.md", "file": "api/operations/getadmincustomasset/index.md", "searchText": "operationId getAdminCustomAsset summary Get the details of the custom asset of the specified type. description method get path /admin/custom_assets/{type} tags 0 Administration: General parameters 0 name type in path description Asset Type required deprecated style explode allowReserved schema name type string format title description default enum 0 album_art 1 background 2 browser_icon enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_UploadedRecordStatus properties hasRecord name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 hasRecord 1 url example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/custom_assets/{type}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmincustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmincustomasset/index.md" } ] }, { "id": "api/operations/postadmincustomasset/index.md", "kind": "operation", "title": "Upload a new custom asset of the specified type.", "description": "POST /admin/custom_assets/{type}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadmincustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadmincustomasset/index.md", "file": "api/operations/postadmincustomasset/index.md", "searchText": "operationId postAdminCustomAsset summary Upload a new custom asset of the specified type. description method post path /admin/custom_assets/{type} tags 0 Administration: General parameters 0 name type in path description Asset Type required deprecated style explode allowReserved schema name type string format title description default enum 0 album_art 1 background 2 browser_icon enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/custom_assets/{type}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadmincustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadmincustomasset/index.md" } ] }, { "id": "api/operations/deleteadmincustomasset/index.md", "kind": "operation", "title": "Removes the custom asset of the specified type.", "description": "DELETE /admin/custom_assets/{type}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteadmincustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteadmincustomasset/index.md", "file": "api/operations/deleteadmincustomasset/index.md", "searchText": "operationId deleteAdminCustomAsset summary Removes the custom asset of the specified type. description method delete path /admin/custom_assets/{type} tags 0 Administration: General parameters 0 name type in path description Asset Type required deprecated style explode allowReserved schema name type string format title description default enum 0 album_art 1 background 2 browser_icon enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/custom_assets/{type}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteadmincustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteadmincustomasset/index.md" } ] }, { "id": "api/operations/getcustomfields/index.md", "kind": "operation", "title": "List all current custom fields in the system.", "description": "GET /admin/custom_fields.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getcustomfields/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getcustomfields/index.md", "file": "api/operations/getcustomfields/index.md", "searchText": "operationId getCustomFields summary List all current custom fields in the system. description method get path /admin/custom_fields tags 0 Administration: Custom Fields parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName CustomField required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description The programmatic name for the field. Can be auto-generated from the full name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName auto_assign name type string format title description An ID3v2 field to automatically assign to this value, if it exists in the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/custom_fields", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getcustomfields/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getcustomfields/index.md" } ] }, { "id": "api/operations/addcustomfield/index.md", "kind": "operation", "title": "Create a new custom field.", "description": "POST /admin/custom_fields: takes CustomField.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addcustomfield/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addcustomfield/index.md", "file": "api/operations/addcustomfield/index.md", "searchText": "operationId addCustomField summary Create a new custom field. description method post path /admin/custom_fields tags 0 Administration: Custom Fields parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName CustomField required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description The programmatic name for the field. Can be auto-generated from the full name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName auto_assign name type string format title description An ID3v2 field to automatically assign to this value, if it exists in the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName CustomField required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description The programmatic name for the field. Can be auto-generated from the full name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName auto_assign name type string format title description An ID3v2 field to automatically assign to this value, if it exists in the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/custom_fields", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addcustomfield/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addcustomfield/index.md" } ] }, { "id": "api/operations/getcustomfield/index.md", "kind": "operation", "title": "Retrieve details for a single custom field.", "description": "GET /admin/custom_field/{id}.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getcustomfield/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getcustomfield/index.md", "file": "api/operations/getcustomfield/index.md", "searchText": "operationId getCustomField summary Retrieve details for a single custom field. description method get path /admin/custom_field/{id} tags 0 Administration: Custom Fields parameters 0 name id in path description Custom Field ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName CustomField required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description The programmatic name for the field. Can be auto-generated from the full name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName auto_assign name type string format title description An ID3v2 field to automatically assign to this value, if it exists in the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/custom_field/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getcustomfield/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getcustomfield/index.md" } ] }, { "id": "api/operations/editcustomfield/index.md", "kind": "operation", "title": "Update details of a single custom field.", "description": "PUT /admin/custom_field/{id}: takes CustomField, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editcustomfield/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editcustomfield/index.md", "file": "api/operations/editcustomfield/index.md", "searchText": "operationId editCustomField summary Update details of a single custom field. description method put path /admin/custom_field/{id} tags 0 Administration: Custom Fields parameters 0 name id in path description Custom Field ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName CustomField required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description The programmatic name for the field. Can be auto-generated from the full name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName auto_assign name type string format title description An ID3v2 field to automatically assign to this value, if it exists in the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/custom_field/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editcustomfield/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editcustomfield/index.md" } ] }, { "id": "api/operations/deletecustomfield/index.md", "kind": "operation", "title": "Delete a single custom field.", "description": "DELETE /admin/custom_field/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletecustomfield/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletecustomfield/index.md", "file": "api/operations/deletecustomfield/index.md", "searchText": "operationId deleteCustomField summary Delete a single custom field. description method delete path /admin/custom_field/{id} tags 0 Administration: Custom Fields parameters 0 name id in path description Custom Field ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/custom_field/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletecustomfield/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletecustomfield/index.md" } ] }, { "id": "api/operations/admindebugclearcache/index.md", "kind": "operation", "title": "Clear the application cache (Redis).", "description": "PUT /admin/debug/clear-cache: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearcache/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearcache/index.md", "file": "api/operations/admindebugclearcache/index.md", "searchText": "operationId adminDebugClearCache summary Clear the application cache (Redis). description method put path /admin/debug/clear-cache tags 0 Administration: Debugging parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/debug/clear-cache", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearcache/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearcache/index.md" } ] }, { "id": "api/operations/admindebugclearqueue/index.md", "kind": "operation", "title": "Clear the specified message queue.", "description": "PUT /admin/debug/clear-queue/{queue}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearqueue/index.md", "file": "api/operations/admindebugclearqueue/index.md", "searchText": "operationId adminDebugClearQueue summary Clear the specified message queue. description method put path /admin/debug/clear-queue/{queue} tags 0 Administration: Debugging parameters 0 name queue in path description Message queue type. required deprecated style explode allowReserved schema name type string format title description default enum 0 high_priority 1 normal_priority 2 low_priority 3 search_index 4 media 5 podcast_media enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/debug/clear-queue/{queue}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearqueue/index.md" } ] }, { "id": "api/operations/admindebugclearstationqueue/index.md", "kind": "operation", "title": "Clear the upcoming song queue and generate a new one.", "description": "PUT /admin/debug/station/{station_id}/clearqueue: returns Api_Admin_Debug_LogResult.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearstationqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearstationqueue/index.md", "file": "api/operations/admindebugclearstationqueue/index.md", "searchText": "operationId adminDebugClearStationQueue summary Clear the upcoming song queue and generate a new one. description method put path /admin/debug/station/{station_id}/clearqueue tags 0 Administration: Debugging parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogResult properties logs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogEntry properties datetime name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName channel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName level name type integer format title description default enum 0 100 1 200 2 250 3 300 4 400 5 500 6 550 7 600 enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName context name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName extra name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName formatted name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 datetime 1 channel 2 level 3 message 4 context 5 extra 6 formatted required 0 logs example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/debug/station/{station_id}/clearqueue", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearstationqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugclearstationqueue/index.md" } ] }, { "id": "api/operations/getadmindebugqueues/index.md", "kind": "operation", "title": "List all message queues.", "description": "GET /admin/debug/queues: returns a list of Api_Admin_Debug_Queue.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugqueues/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugqueues/index.md", "file": "api/operations/getadmindebugqueues/index.md", "searchText": "operationId getAdminDebugQueues summary List all message queues. description method get path /admin/debug/queues tags 0 Administration: Debugging parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_Queue properties name name type string format title description default enum 0 high_priority 1 normal_priority 2 low_priority 3 search_index 4 media 5 podcast_media enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 name 1 count 2 url example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/debug/queues", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugqueues/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugqueues/index.md" } ] }, { "id": "api/operations/getadmindebugstations/index.md", "kind": "operation", "title": "List all stations with their debug links.", "description": "GET /admin/debug/stations: returns a list of Api_Admin_Debug_Station.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugstations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugstations/index.md", "file": "api/operations/getadmindebugstations/index.md", "searchText": "operationId getAdminDebugStations summary List all stations with their debug links. description method get path /admin/debug/stations tags 0 Administration: Debugging parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_Station properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName clearQueueUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName getNextSongUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName getNowPlayingUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name 2 clearQueueUrl 3 getNextSongUrl 4 getNowPlayingUrl example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/debug/stations", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugstations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugstations/index.md" } ] }, { "id": "api/operations/getadmindebugsynctasks/index.md", "kind": "operation", "title": "List all sync tasks and details about their run times.", "description": "GET /admin/debug/sync-tasks: returns a list of Api_Admin_Debug_SyncTask.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugsynctasks/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugsynctasks/index.md", "file": "api/operations/getadmindebugsynctasks/index.md", "searchText": "operationId getAdminDebugSyncTasks summary List all sync tasks and details about their run times. description method get path /admin/debug/sync-tasks tags 0 Administration: Debugging parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_SyncTask properties task name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName pattern name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName time name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName nextRun name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 task 1 pattern 2 time 3 nextRun 4 url example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/debug/sync-tasks", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugsynctasks/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadmindebugsynctasks/index.md" } ] }, { "id": "api/operations/admindebugstationnextsong/index.md", "kind": "operation", "title": "Get the next song to be played by the AutoDJ for a given station.", "description": "PUT /admin/debug/station/{station_id}/nextsong: returns Api_Admin_Debug_LogResult.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugstationnextsong/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugstationnextsong/index.md", "file": "api/operations/admindebugstationnextsong/index.md", "searchText": "operationId adminDebugStationNextSong summary Get the next song to be played by the AutoDJ for a given station. description method put path /admin/debug/station/{station_id}/nextsong tags 0 Administration: Debugging parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogResult properties logs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogEntry properties datetime name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName channel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName level name type integer format title description default enum 0 100 1 200 2 250 3 300 4 400 5 500 6 550 7 600 enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName context name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName extra name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName formatted name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 datetime 1 channel 2 level 3 message 4 context 5 extra 6 formatted required 0 logs example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/debug/station/{station_id}/nextsong", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugstationnextsong/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugstationnextsong/index.md" } ] }, { "id": "api/operations/admindebugstationnowplaying/index.md", "kind": "operation", "title": "Generate the raw Now Playing data for a given station.", "description": "PUT /admin/debug/station/{station_id}/nowplaying: returns Api_Admin_Debug_LogResult.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugstationnowplaying/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugstationnowplaying/index.md", "file": "api/operations/admindebugstationnowplaying/index.md", "searchText": "operationId adminDebugStationNowPlaying summary Generate the raw Now Playing data for a given station. description method put path /admin/debug/station/{station_id}/nowplaying tags 0 Administration: Debugging parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogResult properties logs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogEntry properties datetime name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName channel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName level name type integer format title description default enum 0 100 1 200 2 250 3 300 4 400 5 500 6 550 7 600 enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName context name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName extra name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName formatted name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 datetime 1 channel 2 level 3 message 4 context 5 extra 6 formatted required 0 logs example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/debug/station/{station_id}/nowplaying", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugstationnowplaying/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugstationnowplaying/index.md" } ] }, { "id": "api/operations/admindebugrunsynctask/index.md", "kind": "operation", "title": "Manually run a scheduled synchronized task by name.", "description": "PUT /admin/debug/sync/{task}: returns Api_Admin_Debug_LogResult.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugrunsynctask/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugrunsynctask/index.md", "file": "api/operations/admindebugrunsynctask/index.md", "searchText": "operationId adminDebugRunSyncTask summary Manually run a scheduled synchronized task by name. description method put path /admin/debug/sync/{task} tags 0 Administration: Debugging parameters 0 name task in path description Synchronized task (either class name or \"all\"). required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogResult properties logs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogEntry properties datetime name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName channel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName level name type integer format title description default enum 0 100 1 200 2 250 3 300 4 400 5 500 6 550 7 600 enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName context name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName extra name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName formatted name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 datetime 1 channel 2 level 3 message 4 context 5 extra 6 formatted required 0 logs example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/debug/sync/{task}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugrunsynctask/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindebugrunsynctask/index.md" } ] }, { "id": "api/operations/putadmindebugtelnetcommand/index.md", "kind": "operation", "title": "Manually run a Telnet command on a station backend.", "description": "PUT /admin/debug/station/{station_id}/telnet: returns Api_Admin_Debug_LogResult.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putadmindebugtelnetcommand/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putadmindebugtelnetcommand/index.md", "file": "api/operations/putadmindebugtelnetcommand/index.md", "searchText": "operationId putAdminDebugTelnetCommand summary Manually run a Telnet command on a station backend. description method put path /admin/debug/station/{station_id}/telnet tags 0 Administration: Debugging parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogResult properties logs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogEntry properties datetime name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName channel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName level name type integer format title description default enum 0 100 1 200 2 250 3 300 4 400 5 500 6 550 7 600 enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName context name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName extra name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName formatted name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 datetime 1 channel 2 level 3 message 4 context 5 extra 6 formatted required 0 logs example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/debug/station/{station_id}/telnet", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putadmindebugtelnetcommand/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putadmindebugtelnetcommand/index.md" } ] }, { "id": "api/operations/getgeolite/index.md", "kind": "operation", "title": "Get the current MaxMindDB GeoLite Database status.", "description": "GET /admin/geolite: returns Api_Admin_GeoLiteStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getgeolite/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getgeolite/index.md", "file": "api/operations/getgeolite/index.md", "searchText": "operationId getGeoLite summary Get the current MaxMindDB GeoLite Database status. description method get path /admin/geolite tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_GeoLiteStatus properties version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 version 1 key example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/geolite", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getgeolite/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getgeolite/index.md" } ] }, { "id": "api/operations/postgeolite/index.md", "kind": "operation", "title": "Set the GeoLite MaxMindDB Database license key.", "description": "POST /admin/geolite: returns Api_Admin_GeoLiteStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postgeolite/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postgeolite/index.md", "file": "api/operations/postgeolite/index.md", "searchText": "operationId postGeoLite summary Set the GeoLite MaxMindDB Database license key. description method post path /admin/geolite tags 0 Administration: General parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_GeoLiteStatus properties version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 version 1 key example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/geolite", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postgeolite/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postgeolite/index.md" } ] }, { "id": "api/operations/getlogintokens/index.md", "kind": "operation", "title": "List all current unexpired login tokens in the system.", "description": "GET /admin/login_tokens.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getlogintokens/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getlogintokens/index.md", "file": "api/operations/getlogintokens/index.md", "searchText": "operationId getLoginTokens summary List all current unexpired login tokens in the system. description method get path /admin/login_tokens tags 0 Administration: Users parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName UserLoginToken allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 reset_password 1 login enumNames 0 ResetPassword 1 Login enumDescriptions const nullable readOnly writeOnly deprecated example examples refName LoginTokenTypes comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example SSO Login examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1640998800 examples refName expires_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1640998800 examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/login_tokens", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getlogintokens/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getlogintokens/index.md" } ] }, { "id": "api/operations/addlogintoken/index.md", "kind": "operation", "title": "Create a new login token.", "description": "POST /admin/login_tokens: takes Api_Admin_NewLoginToken, returns Api_Admin_NewLoginTokenResponse.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addlogintoken/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addlogintoken/index.md", "file": "api/operations/addlogintoken/index.md", "searchText": "operationId addLoginToken summary Create a new login token. description method post path /admin/login_tokens tags 0 Administration: Users parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_NewLoginToken properties user name type format title description User ID or e-mail address. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 reset_password 1 login enumNames 0 ResetPassword 1 Login enumDescriptions const nullable readOnly writeOnly deprecated example examples refName LoginTokenTypes comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example SSO Login examples refName expires_minutes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 user example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_NewLoginTokenResponse properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName record name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName UserLoginToken allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum enumNames 0 ResetPassword 1 Login enumDescriptions const nullable readOnly writeOnly deprecated example examples refName LoginTokenTypes comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example SSO Login examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1640998800 examples refName expires_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1640998800 examples refName links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 success 1 message 2 formatted_message 3 record 4 links example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/login_tokens", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addlogintoken/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addlogintoken/index.md" } ] }, { "id": "api/operations/getlogintoken/index.md", "kind": "operation", "title": "Retrieve details for a single login token.", "description": "GET /admin/login_token/{id}.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getlogintoken/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getlogintoken/index.md", "file": "api/operations/getlogintoken/index.md", "searchText": "operationId getLoginToken summary Retrieve details for a single login token. description method get path /admin/login_token/{id} tags 0 Administration: Users parameters 0 name id in path description Token identifier required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName UserLoginToken allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 reset_password 1 login enumNames 0 ResetPassword 1 Login enumDescriptions const nullable readOnly writeOnly deprecated example examples refName LoginTokenTypes comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example SSO Login examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1640998800 examples refName expires_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1640998800 examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/login_token/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getlogintoken/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getlogintoken/index.md" } ] }, { "id": "api/operations/deletelogintoken/index.md", "kind": "operation", "title": "Delete a single login token.", "description": "DELETE /admin/login_token/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletelogintoken/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletelogintoken/index.md", "file": "api/operations/deletelogintoken/index.md", "searchText": "operationId deleteLoginToken summary Delete a single login token. description method delete path /admin/login_token/{id} tags 0 Administration: Users parameters 0 name id in path description Token identifier required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/login_token/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletelogintoken/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletelogintoken/index.md" } ] }, { "id": "api/operations/adminlistlogs/index.md", "kind": "operation", "title": "List all available log types for viewing.", "description": "GET /admin/logs: returns Api_Admin_LogList.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminlistlogs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminlistlogs/index.md", "file": "api/operations/adminlistlogs/index.md", "searchText": "operationId adminListLogs summary List all available log types for viewing. description method get path /admin/logs tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_LogList properties globalLogs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogType required 0 key 1 name 2 path 3 tail allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName tail name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stationLogs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_StationLogList properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName logs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogType required 0 key 1 name 2 path 3 tail allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName tail name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name 2 logs required 0 globalLogs 1 stationLogs example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/logs", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminlistlogs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminlistlogs/index.md" } ] }, { "id": "api/operations/adminviewlog/index.md", "kind": "operation", "title": "View a specific log contents.", "description": "GET /admin/log/{key}: returns Api_LogContents.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminviewlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminviewlog/index.md", "file": "api/operations/adminviewlog/index.md", "searchText": "operationId adminViewLog summary View a specific log contents. description method get path /admin/log/{key} tags 0 Administration: General parameters 0 name key in path description Log Key from listing return. required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogContents properties contents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName eof name type boolean format title description Whether the log file has ended at this point or has additional data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName position name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 contents 1 eof 2 position example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/log/{key}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminviewlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminviewlog/index.md" } ] }, { "id": "api/operations/getpermissions/index.md", "kind": "operation", "title": "Return a list of all available permissions.", "description": "GET /admin/permissions: returns Api_Admin_Permissions.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpermissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpermissions/index.md", "file": "api/operations/getpermissions/index.md", "searchText": "operationId getPermissions summary Return a list of all available permissions. description method get path /admin/permissions tags 0 Administration: Roles parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Permissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Permission properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Permission properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name required 0 global 1 station example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/permissions", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpermissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpermissions/index.md" } ] }, { "id": "api/operations/admingetrelays/index.md", "kind": "operation", "title": "Return a list of all currently active AzuraRelay instances.", "description": "GET /admin/relays/list: returns a list of Relay.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetrelays/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetrelays/index.md", "file": "api/operations/admingetrelays/index.md", "searchText": "operationId adminGetRelays summary Return a list of all currently active AzuraRelay instances. description method get path /admin/relays/list tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Relay allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties base_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-url.example.com examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Relay examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2025-01-31T21:31:58+00:00 examples refName updated_at name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2025-01-31T21:31:58+00:00 examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/relays/list", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetrelays/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetrelays/index.md" } ] }, { "id": "api/operations/getroles/index.md", "kind": "operation", "title": "List all current roles in the system.", "description": "GET /admin/roles: returns a list of Api_Admin_Role.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getroles/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getroles/index.md", "file": "api/operations/getroles/index.md", "searchText": "operationId getRoles summary List all current roles in the system. description method get path /admin/roles tags 0 Administration: Roles parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Role required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Super Administrator examples refName permissions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RolePermissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view administration 2 view system logs 3 administer settings 4 administer api keys 5 administer stations 6 administer custom fields 7 administer backups 8 administer storage locations enumNames 0 All 1 View 2 Logs 3 Settings 4 ApiKeys 5 Stations 6 CustomFields 7 Backups 8 StorageLocations enumDescriptions const nullable readOnly writeOnly deprecated example examples refName GlobalPermissions station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RoleStationPermission properties id name type integer format title description The station ID. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view station management 2 view station reports 3 view station logs 4 manage station profile 5 manage station broadcasting 6 manage station streamers 7 manage station mounts 8 manage station remotes 9 manage station media 10 delete station media 11 manage station automation 12 manage station web hooks 13 manage station podcasts enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions required 0 id 1 permissions required 0 global 1 station is_super_admin name type boolean format title description Whether this role is the protected \"Super Administrator\" role. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/roles", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getroles/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getroles/index.md" } ] }, { "id": "api/operations/addrole/index.md", "kind": "operation", "title": "Create a new role.", "description": "POST /admin/roles: takes Api_Admin_Role, returns Api_Admin_Role.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addrole/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addrole/index.md", "file": "api/operations/addrole/index.md", "searchText": "operationId addRole summary Create a new role. description method post path /admin/roles tags 0 Administration: Roles parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Role required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Super Administrator examples refName permissions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RolePermissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view administration 2 view system logs 3 administer settings 4 administer api keys 5 administer stations 6 administer custom fields 7 administer backups 8 administer storage locations enumNames 0 All 1 View 2 Logs 3 Settings 4 ApiKeys 5 Stations 6 CustomFields 7 Backups 8 StorageLocations enumDescriptions const nullable readOnly writeOnly deprecated example examples refName GlobalPermissions station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RoleStationPermission properties id name type integer format title description The station ID. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view station management 2 view station reports 3 view station logs 4 manage station profile 5 manage station broadcasting 6 manage station streamers 7 manage station mounts 8 manage station remotes 9 manage station media 10 delete station media 11 manage station automation 12 manage station web hooks 13 manage station podcasts enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions required 0 id 1 permissions required 0 global 1 station is_super_admin name type boolean format title description Whether this role is the protected \"Super Administrator\" role. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Role required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Super Administrator examples refName permissions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RolePermissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames 0 All 1 View 2 Logs 3 Settings 4 ApiKeys 5 Stations 6 CustomFields 7 Backups 8 StorageLocations enumDescriptions const nullable readOnly writeOnly deprecated example examples refName GlobalPermissions station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RoleStationPermission properties id name type integer format title description The station ID. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions required 0 id 1 permissions required 0 global 1 station is_super_admin name type boolean format title description Whether this role is the protected \"Super Administrator\" role. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/roles", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addrole/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addrole/index.md" } ] }, { "id": "api/operations/getrole/index.md", "kind": "operation", "title": "Retrieve details for a single current role.", "description": "GET /admin/role/{id}: returns Api_Admin_Role.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrole/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrole/index.md", "file": "api/operations/getrole/index.md", "searchText": "operationId getRole summary Retrieve details for a single current role. description method get path /admin/role/{id} tags 0 Administration: Roles parameters 0 name id in path description Role ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Role required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Super Administrator examples refName permissions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RolePermissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view administration 2 view system logs 3 administer settings 4 administer api keys 5 administer stations 6 administer custom fields 7 administer backups 8 administer storage locations enumNames 0 All 1 View 2 Logs 3 Settings 4 ApiKeys 5 Stations 6 CustomFields 7 Backups 8 StorageLocations enumDescriptions const nullable readOnly writeOnly deprecated example examples refName GlobalPermissions station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RoleStationPermission properties id name type integer format title description The station ID. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view station management 2 view station reports 3 view station logs 4 manage station profile 5 manage station broadcasting 6 manage station streamers 7 manage station mounts 8 manage station remotes 9 manage station media 10 delete station media 11 manage station automation 12 manage station web hooks 13 manage station podcasts enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions required 0 id 1 permissions required 0 global 1 station is_super_admin name type boolean format title description Whether this role is the protected \"Super Administrator\" role. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/role/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrole/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrole/index.md" } ] }, { "id": "api/operations/editrole/index.md", "kind": "operation", "title": "Update details of a single role.", "description": "PUT /admin/role/{id}: takes Api_Admin_Role, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editrole/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editrole/index.md", "file": "api/operations/editrole/index.md", "searchText": "operationId editRole summary Update details of a single role. description method put path /admin/role/{id} tags 0 Administration: Roles parameters 0 name id in path description Role ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Role required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Super Administrator examples refName permissions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RolePermissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view administration 2 view system logs 3 administer settings 4 administer api keys 5 administer stations 6 administer custom fields 7 administer backups 8 administer storage locations enumNames 0 All 1 View 2 Logs 3 Settings 4 ApiKeys 5 Stations 6 CustomFields 7 Backups 8 StorageLocations enumDescriptions const nullable readOnly writeOnly deprecated example examples refName GlobalPermissions station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RoleStationPermission properties id name type integer format title description The station ID. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view station management 2 view station reports 3 view station logs 4 manage station profile 5 manage station broadcasting 6 manage station streamers 7 manage station mounts 8 manage station remotes 9 manage station media 10 delete station media 11 manage station automation 12 manage station web hooks 13 manage station podcasts enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions required 0 id 1 permissions required 0 global 1 station is_super_admin name type boolean format title description Whether this role is the protected \"Super Administrator\" role. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/role/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editrole/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editrole/index.md" } ] }, { "id": "api/operations/deleterole/index.md", "kind": "operation", "title": "Delete a single role.", "description": "DELETE /admin/role/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleterole/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleterole/index.md", "file": "api/operations/deleterole/index.md", "searchText": "operationId deleteRole summary Delete a single role. description method delete path /admin/role/{id} tags 0 Administration: Roles parameters 0 name id in path description Role ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/role/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleterole/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleterole/index.md" } ] }, { "id": "api/operations/getrsas/index.md", "kind": "operation", "title": "Get the current Rocket Streaming Audio Server (RSAS) status.", "description": "GET /admin/rsas: returns Api_Admin_RsasStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrsas/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrsas/index.md", "file": "api/operations/getrsas/index.md", "searchText": "operationId getRsas summary Get the current Rocket Streaming Audio Server (RSAS) status. description method get path /admin/rsas tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RsasStatus properties version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hasLicense name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 version 1 hasLicense example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/rsas", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrsas/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrsas/index.md" } ] }, { "id": "api/operations/postrsas/index.md", "kind": "operation", "title": "Upload a new Rocket Streaming Audio Server (RSAS) binary.", "description": "POST /admin/rsas: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postrsas/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postrsas/index.md", "file": "api/operations/postrsas/index.md", "searchText": "operationId postRsas summary Upload a new Rocket Streaming Audio Server (RSAS) binary. description method post path /admin/rsas tags 0 Administration: General parameters requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/rsas", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postrsas/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postrsas/index.md" } ] }, { "id": "api/operations/deletersas/index.md", "kind": "operation", "title": "Removes the Rocket Streaming Audio Server (RSAS) installation.", "description": "DELETE /admin/rsas: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletersas/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletersas/index.md", "file": "api/operations/deletersas/index.md", "searchText": "operationId deleteRsas summary Removes the Rocket Streaming Audio Server (RSAS) installation. description method delete path /admin/rsas tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/rsas", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletersas/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletersas/index.md" } ] }, { "id": "api/operations/postrsaslicense/index.md", "kind": "operation", "title": "Upload a new Rocket Streaming Audio Server (RSAS) license key.", "description": "POST /admin/rsas/license: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postrsaslicense/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postrsaslicense/index.md", "file": "api/operations/postrsaslicense/index.md", "searchText": "operationId postRsasLicense summary Upload a new Rocket Streaming Audio Server (RSAS) license key. description method post path /admin/rsas/license tags 0 Administration: General parameters requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/rsas/license", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postrsaslicense/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postrsaslicense/index.md" } ] }, { "id": "api/operations/deletersaslicense/index.md", "kind": "operation", "title": "Removes the Rocket Streaming Audio Server (RSAS) license.", "description": "DELETE /admin/rsas/license: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletersaslicense/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletersaslicense/index.md", "file": "api/operations/deletersaslicense/index.md", "searchText": "operationId deleteRsasLicense summary Removes the Rocket Streaming Audio Server (RSAS) license. description method delete path /admin/rsas/license tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/rsas/license", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletersaslicense/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletersaslicense/index.md" } ] }, { "id": "api/operations/adminsendtestemail/index.md", "kind": "operation", "title": "Send a test e-mail to confirm mail delivery settings.", "description": "POST /admin/send-test-message: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminsendtestemail/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminsendtestemail/index.md", "file": "api/operations/adminsendtestemail/index.md", "searchText": "operationId adminSendTestEmail summary Send a test e-mail to confirm mail delivery settings. description method post path /admin/send-test-message tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/send-test-message", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminsendtestemail/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminsendtestemail/index.md" } ] }, { "id": "api/operations/getserverstats/index.md", "kind": "operation", "title": "Return a list of all CPU usage stats.", "description": "GET /admin/server/stats: returns Api_Admin_ServerStats.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getserverstats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getserverstats/index.md", "file": "api/operations/getserverstats/index.md", "searchText": "operationId getServerStats summary Return a list of all CPU usage stats. description method get path /admin/server/stats tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats properties cpu name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_CpuStats properties total name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_CpuStatsSection properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName usage name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName idle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName io_wait name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName steal name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 name 1 usage 2 idle 3 io_wait 4 steal cores name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_CpuStatsSection properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName usage name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName idle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName io_wait name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName steal name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 name 1 usage 2 idle 3 io_wait 4 steal load name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total 1 cores 2 load memory name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_MemoryStats properties total_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName total_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName buffers_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName buffers_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName cached_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName cached_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sReclaimable_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sReclaimable_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName shmem_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName shmem_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total_bytes 1 total_readable 2 free_bytes 3 free_readable 4 buffers_bytes 5 buffers_readable 6 cached_bytes 7 cached_readable 8 sReclaimable_bytes 9 sReclaimable_readable 10 shmem_bytes 11 shmem_readable 12 used_bytes 13 used_readable swap name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_StorageStats properties total_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName total_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total_bytes 1 total_readable 2 free_bytes 3 free_readable 4 used_bytes 5 used_readable disk name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_StorageStats properties total_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName total_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total_bytes 1 total_readable 2 free_bytes 3 free_readable 4 used_bytes 5 used_readable network name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceStats properties interface_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName received name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceReceived properties speed_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName speed_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName packets name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errs name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName drop name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fifo name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frame name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName compressed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName multicast name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 speed_bytes 1 speed_readable 2 packets 3 errs 4 drop 5 fifo 6 frame 7 compressed 8 multicast transmitted name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceTransmitted properties speed_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName speed_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName packets name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errs name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName drop name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fifo name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frame name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName carrier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName compressed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 speed_bytes 1 speed_readable 2 packets 3 errs 4 drop 5 fifo 6 frame 7 carrier 8 compressed required 0 interface_name 1 received 2 transmitted required 0 cpu 1 memory 2 swap 3 disk 4 network example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/server/stats", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getserverstats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getserverstats/index.md" } ] }, { "id": "api/operations/getservicedetails/index.md", "kind": "operation", "title": "List the status of essential system services.", "description": "GET /admin/services: returns a list of Api_Admin_ServiceData.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getservicedetails/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getservicedetails/index.md", "file": "api/operations/getservicedetails/index.md", "searchText": "operationId getServiceDetails summary List the status of essential system services. description method get path /admin/services tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServiceData required 0 name 1 description 2 running allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName running name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/services", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getservicedetails/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getservicedetails/index.md" } ] }, { "id": "api/operations/restartservice/index.md", "kind": "operation", "title": "Restart the specified service.", "description": "POST /admin/services/restart/{service}: takes CustomField, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/restartservice/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/restartservice/index.md", "file": "api/operations/restartservice/index.md", "searchText": "operationId restartService summary Restart the specified service. description method post path /admin/services/restart/{service} tags 0 Administration: General parameters 0 name service in path description Service name. required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName CustomField required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description The programmatic name for the field. Can be auto-generated from the full name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName auto_assign name type string format title description An ID3v2 field to automatically assign to this value, if it exists in the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/services/restart/{service}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/restartservice/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/restartservice/index.md" } ] }, { "id": "api/operations/getsettings/index.md", "kind": "operation", "title": "List the current values of all editable system settings.", "description": "GET /admin/settings: returns Settings.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsettings/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsettings/index.md", "file": "api/operations/getsettings/index.md", "searchText": "operationId getSettings summary List the current values of all editable system settings. description method get path /admin/settings tags 0 Administration: Settings parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Settings properties app_unique_identifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName base_url name type string format title description Site Base URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://your.azuracast.site examples refName instance_name name type string format title description AzuraCast Instance Name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example My AzuraCast Instance examples refName prefer_browser_url name type boolean format title description Prefer Browser URL (If Available) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName use_radio_proxy name type boolean format title description Use Web Proxy for Radio default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName history_keep_days name type integer format title description Days of Playback History to Keep default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName always_use_ssl name type boolean format title description Always Use HTTPS default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName api_access_control name type string format title description API 'Access-Control-Allow-Origin' header default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example * examples refName enable_liquidsoap_editing name type boolean format title description Allow stations to manually edit Liquidsoap code. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_all_webhooks name type boolean format title description Allow stations to dispatch webhooks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName filter_local_user_urls name type boolean format title description Prevent users from using local IPs or URLs in Webhooks, etc. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_static_nowplaying name type boolean format title description Whether to use high-performance static JSON for Now Playing data updates. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName analytics name type format title description Listener Analytics Collection default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 all 1 no_ip 2 none enumNames 0 All 1 NoIp 2 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName AnalyticsLevel check_for_updates name type boolean format title description Check for Updates and Announcements default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName update_results name type format title description Results of the latest update check. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_UpdateDetails properties current_release name type string format title description The stable-equivalent branch your installation currently appears to be on. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.3 examples refName latest_release name type string format title description The current latest stable release of the software. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.4 examples refName needs_rolling_update name type boolean format title description If you are on the Rolling Release, whether your installation needs to be updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName needs_release_update name type boolean format title description Whether a newer stable release is available than the version you are currently using. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName rolling_updates_available name type integer format title description If you are on the Rolling Release, the number of updates released since your version. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName can_switch_to_stable name type boolean format title description Whether you can seamlessly move from the Rolling Release channel to Stable without issues. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName update_last_run name type integer format title description The UNIX timestamp when updates were last checked. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName public_theme name type format title description Base Theme for Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example light examples refName oneOf 0 name type string format title description default enum 0 browser 1 light 2 dark enumNames 0 Browser 1 Light 2 Dark enumDescriptions const nullable readOnly writeOnly deprecated example examples refName SupportedThemes hide_album_art name type boolean format title description Hide Album Art on Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName homepage_redirect_url name type string format title description Homepage Redirect URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName default_album_art_url name type string format title description Default Album Art URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/image.jpg examples refName use_external_album_art_when_processing_media name type boolean format title description Attempt to fetch album art from external sources when processing media. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName use_external_album_art_in_apis name type boolean format title description Attempt to fetch album art from external sources in API requests. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName last_fm_api_key name type string format title description An API key to connect to Last.fm services, if provided. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example SAMPLE-API-KEY examples refName hide_product_name name type boolean format title description Hide AzuraCast Branding on Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName public_custom_css name type string format title description Custom CSS for Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_js name type string format title description Custom JS for Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName internal_custom_css name type string format title description Custom CSS for Internal Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backup_enabled name type boolean format title description Whether backup is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName backup_time_code name type string format title description The timecode (i.e. 400 for 4:00AM) when automated backups should run. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 400 examples refName backup_exclude_media name type boolean format title description Whether to exclude media in automated backups. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName backup_keep_copies name type integer format title description Number of backups to keep, or infinite if zero/null. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2 examples refName backup_storage_location name type integer format title description The storage location ID for automated backups. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName backup_format name type string format title description The output format for the automated backup. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example zip examples refName backup_last_run name type integer format title description The UNIX timestamp when automated backup was last run. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName backup_last_output name type string format title description The output of the latest automated backup task. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName setup_complete_time name type integer format title description The UNIX timestamp when setup was last completed. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName sync_disabled name type boolean format title description Temporarily disable all sync tasks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName sync_last_run name type integer format title description The last run timestamp for the unified sync task. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName external_ip name type string format title description This installation's external IP. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 192.168.1.1 examples refName geolite_license_key name type string format title description The license key for the Maxmind Geolite download. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName geolite_last_run name type integer format title description The UNIX timestamp when the Maxmind Geolite was last downloaded. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName mail_enabled name type boolean format title description Enable e-mail delivery across the application. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName mail_sender_name name type string format title description The name of the sender of system e-mails. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraCast examples refName mail_sender_email name type string format title description The e-mail address of the sender of system e-mails. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example example@example.com examples refName mail_smtp_host name type string format title description The host to send outbound SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example smtp.example.com examples refName mail_smtp_port name type integer format title description The port for sending outbound SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 465 examples refName mail_smtp_username name type string format title description The username when connecting to SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example username examples refName mail_smtp_password name type string format title description The password when connecting to SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName mail_smtp_secure name type boolean format title description Whether to use a secure (TLS) connection when sending SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName avatar_service name type string format title description The external avatar service to use when fetching avatars. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example libravatar examples refName avatar_default_url name type string format title description The default avatar URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName acme_email name type string format title description ACME (LetsEncrypt) e-mail address. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName acme_domains name type string format title description ACME (LetsEncrypt) domain name(s). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ip_source name type format title description IP Address Source default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 local 1 xff 2 cloudflare enumNames 0 Local 1 XForwardedFor 2 Cloudflare enumDescriptions const nullable readOnly writeOnly deprecated example examples refName IpSources example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/settings", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsettings/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsettings/index.md" } ] }, { "id": "api/operations/editsettings/index.md", "kind": "operation", "title": "Update settings to modify any settings provided.", "description": "PUT /admin/settings: takes Settings, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editsettings/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editsettings/index.md", "file": "api/operations/editsettings/index.md", "searchText": "operationId editSettings summary Update settings to modify any settings provided. description method put path /admin/settings tags 0 Administration: Settings parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Settings properties app_unique_identifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName base_url name type string format title description Site Base URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://your.azuracast.site examples refName instance_name name type string format title description AzuraCast Instance Name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example My AzuraCast Instance examples refName prefer_browser_url name type boolean format title description Prefer Browser URL (If Available) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName use_radio_proxy name type boolean format title description Use Web Proxy for Radio default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName history_keep_days name type integer format title description Days of Playback History to Keep default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName always_use_ssl name type boolean format title description Always Use HTTPS default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName api_access_control name type string format title description API 'Access-Control-Allow-Origin' header default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example * examples refName enable_liquidsoap_editing name type boolean format title description Allow stations to manually edit Liquidsoap code. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_all_webhooks name type boolean format title description Allow stations to dispatch webhooks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName filter_local_user_urls name type boolean format title description Prevent users from using local IPs or URLs in Webhooks, etc. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_static_nowplaying name type boolean format title description Whether to use high-performance static JSON for Now Playing data updates. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName analytics name type format title description Listener Analytics Collection default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 all 1 no_ip 2 none enumNames 0 All 1 NoIp 2 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName AnalyticsLevel check_for_updates name type boolean format title description Check for Updates and Announcements default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName update_results name type format title description Results of the latest update check. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_UpdateDetails properties current_release name type string format title description The stable-equivalent branch your installation currently appears to be on. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.3 examples refName latest_release name type string format title description The current latest stable release of the software. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.4 examples refName needs_rolling_update name type boolean format title description If you are on the Rolling Release, whether your installation needs to be updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName needs_release_update name type boolean format title description Whether a newer stable release is available than the version you are currently using. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName rolling_updates_available name type integer format title description If you are on the Rolling Release, the number of updates released since your version. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName can_switch_to_stable name type boolean format title description Whether you can seamlessly move from the Rolling Release channel to Stable without issues. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName update_last_run name type integer format title description The UNIX timestamp when updates were last checked. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName public_theme name type format title description Base Theme for Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example light examples refName oneOf 0 name type string format title description default enum 0 browser 1 light 2 dark enumNames 0 Browser 1 Light 2 Dark enumDescriptions const nullable readOnly writeOnly deprecated example examples refName SupportedThemes hide_album_art name type boolean format title description Hide Album Art on Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName homepage_redirect_url name type string format title description Homepage Redirect URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName default_album_art_url name type string format title description Default Album Art URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/image.jpg examples refName use_external_album_art_when_processing_media name type boolean format title description Attempt to fetch album art from external sources when processing media. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName use_external_album_art_in_apis name type boolean format title description Attempt to fetch album art from external sources in API requests. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName last_fm_api_key name type string format title description An API key to connect to Last.fm services, if provided. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example SAMPLE-API-KEY examples refName hide_product_name name type boolean format title description Hide AzuraCast Branding on Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName public_custom_css name type string format title description Custom CSS for Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_js name type string format title description Custom JS for Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName internal_custom_css name type string format title description Custom CSS for Internal Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backup_enabled name type boolean format title description Whether backup is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName backup_time_code name type string format title description The timecode (i.e. 400 for 4:00AM) when automated backups should run. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 400 examples refName backup_exclude_media name type boolean format title description Whether to exclude media in automated backups. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName backup_keep_copies name type integer format title description Number of backups to keep, or infinite if zero/null. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2 examples refName backup_storage_location name type integer format title description The storage location ID for automated backups. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName backup_format name type string format title description The output format for the automated backup. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example zip examples refName backup_last_run name type integer format title description The UNIX timestamp when automated backup was last run. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName backup_last_output name type string format title description The output of the latest automated backup task. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName setup_complete_time name type integer format title description The UNIX timestamp when setup was last completed. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName sync_disabled name type boolean format title description Temporarily disable all sync tasks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName sync_last_run name type integer format title description The last run timestamp for the unified sync task. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName external_ip name type string format title description This installation's external IP. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 192.168.1.1 examples refName geolite_license_key name type string format title description The license key for the Maxmind Geolite download. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName geolite_last_run name type integer format title description The UNIX timestamp when the Maxmind Geolite was last downloaded. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName mail_enabled name type boolean format title description Enable e-mail delivery across the application. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName mail_sender_name name type string format title description The name of the sender of system e-mails. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraCast examples refName mail_sender_email name type string format title description The e-mail address of the sender of system e-mails. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example example@example.com examples refName mail_smtp_host name type string format title description The host to send outbound SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example smtp.example.com examples refName mail_smtp_port name type integer format title description The port for sending outbound SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 465 examples refName mail_smtp_username name type string format title description The username when connecting to SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example username examples refName mail_smtp_password name type string format title description The password when connecting to SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName mail_smtp_secure name type boolean format title description Whether to use a secure (TLS) connection when sending SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName avatar_service name type string format title description The external avatar service to use when fetching avatars. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example libravatar examples refName avatar_default_url name type string format title description The default avatar URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName acme_email name type string format title description ACME (LetsEncrypt) e-mail address. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName acme_domains name type string format title description ACME (LetsEncrypt) domain name(s). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ip_source name type format title description IP Address Source default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 local 1 xff 2 cloudflare enumNames 0 Local 1 XForwardedFor 2 Cloudflare enumDescriptions const nullable readOnly writeOnly deprecated example examples refName IpSources example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/settings", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editsettings/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editsettings/index.md" } ] }, { "id": "api/operations/getshoutcast/index.md", "kind": "operation", "title": "Get details about the Shoutcast installation.", "description": "GET /admin/shoutcast: returns Api_Admin_ShoutcastStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getshoutcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getshoutcast/index.md", "file": "api/operations/getshoutcast/index.md", "searchText": "operationId getShoutcast summary Get details about the Shoutcast installation. description method get path /admin/shoutcast tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ShoutcastStatus properties version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 version example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/shoutcast", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getshoutcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getshoutcast/index.md" } ] }, { "id": "api/operations/postshoutcast/index.md", "kind": "operation", "title": "Upload a new Shoutcast binary.", "description": "POST /admin/shoutcast: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postshoutcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postshoutcast/index.md", "file": "api/operations/postshoutcast/index.md", "searchText": "operationId postShoutcast summary Upload a new Shoutcast binary. description method post path /admin/shoutcast tags 0 Administration: General parameters requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/shoutcast", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postshoutcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postshoutcast/index.md" } ] }, { "id": "api/operations/deleteshoutcast/index.md", "kind": "operation", "title": "Removes the installed Shoutcast binary.", "description": "DELETE /admin/shoutcast: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteshoutcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteshoutcast/index.md", "file": "api/operations/deleteshoutcast/index.md", "searchText": "operationId deleteShoutcast summary Removes the installed Shoutcast binary. description method delete path /admin/shoutcast tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/shoutcast", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteshoutcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteshoutcast/index.md" } ] }, { "id": "api/operations/postadminstationsclone/index.md", "kind": "operation", "title": "Clone a station, preserving certain settings.", "description": "POST /admin/station/{id}/clone: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadminstationsclone/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadminstationsclone/index.md", "file": "api/operations/postadminstationsclone/index.md", "searchText": "operationId postAdminStationsClone summary Clone a station, preserving certain settings. description method post path /admin/station/{id}/clone tags 0 Administration: Stations parameters 0 name id in path description Station ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The name of the newly cloned station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description The description of the newly cloned station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName clone name type array format title description Which parts of the original station to clone. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 media_storage 1 recordings_storage 2 podcasts_storage 3 playlists 4 mounts 5 remotes 6 streamers 7 permissions 8 webhooks enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/station/{id}/clone", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadminstationsclone/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postadminstationsclone/index.md" } ] }, { "id": "api/operations/getadminstationstoragelocations/index.md", "kind": "operation", "title": "List storage locations available for assignment to a station.", "description": "GET /admin/stations/storage-locations.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadminstationstoragelocations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadminstationstoragelocations/index.md", "file": "api/operations/getadminstationstoragelocations/index.md", "searchText": "operationId getAdminStationStorageLocations summary List storage locations available for assignment to a station. description method get path /admin/stations/storage-locations tags 0 Administration: Stations parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_SimpleOptions items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_Option properties value name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 value 1 text example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/stations/storage-locations", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadminstationstoragelocations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getadminstationstoragelocations/index.md" } ] }, { "id": "api/operations/admingetstations/index.md", "kind": "operation", "title": "List all current stations in the system.", "description": "GET /admin/stations: returns a list of Station.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetstations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetstations/index.md", "file": "api/operations/admingetstations/index.md", "searchText": "operationId adminGetStations summary List all current stations in the system. description method get path /admin/stations tags 0 Administration: Stations parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Station allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The full display name of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName short_name name type string format title description The URL-friendly name for the station, typically auto-generated from the full station name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName is_enabled name type boolean format title description If set to 'false', prevents the station from broadcasting but leaves it in the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontend_type name type string format title description default enum 0 icecast 1 shoutcast2 2 rsas 3 remote enumNames 0 Icecast 1 Shoutcast 2 Rsas 3 Remote enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FrontendAdapters frontend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationFrontendConfiguration properties custom_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName admin_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName relay_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listeners name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_user_agents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_countries name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allowed_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_license_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_user_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_type name type string format title description default enum 0 liquidsoap 1 none enumNames 0 Liquidsoap 1 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName BackendAdapters backend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBackendConfiguration properties charset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName telnet_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_format name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName use_manual_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reset_sequential_queues_on_restart name type boolean format title description Reset the internal queue of sequential playlists when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_queue_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_mount_point name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_buffer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName audio_processing_method name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName post_processing_include_live name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_license_key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_configuration_path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_preset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_loudness_target name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_replaygain_metadata name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_type name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_high name type number format float title description The dB level above which a track is considered 'loud' ('high' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_medium name type number format float title description The dB level below which a track is considered 'quiet' ('medium' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_margin name type number format float title description The dB difference above which two tracks are considered too different to overlap ('margin' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName duplicate_prevention_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks tracks and titles against, also applies to artists when duplicate_prevention_artist_time_range is not set. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName duplicate_prevention_artist_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks artists against, uses duplicate_prevention_time_range if set to null. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName performance_mode name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segment_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_in_playlist name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_overhead name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_enable_on_public_player name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName live_broadcast_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_auto_cue name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName write_playlists_to_liquidsoap name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName share_encoders name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_top name type string format title description Custom Liquidsoap Configuration: Top Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_playlists name type string format title description Custom Liquidsoap Configuration: Pre-Playlists Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_live name type string format title description Custom Liquidsoap Configuration: Pre-Live Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_fade name type string format title description Custom Liquidsoap Configuration: Pre-Fade Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config name type string format title description Custom Liquidsoap Configuration: Pre-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_bottom name type string format title description Custom Liquidsoap Configuration: Post-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A sample radio station. examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://demo.azuracast.com/ examples refName genre name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Various examples refName radio_base_dir name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio examples refName enable_requests name type boolean format title description Whether listeners can request songs to play on this station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName request_delay name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName request_threshold name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName requests_only_via_playlists name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName disconnect_deactivate_streamer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName enable_streamers name type boolean format title description Whether streamers are allowed to broadcast to this station at all. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_streamer_live name type boolean format title description Whether a streamer is currently active on the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_page name type boolean format title description Whether this station's public pages (player, on-demand streaming, etc.) are visible to non-authenticated users. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_api name type boolean format title description Whether the public-facing API endpoints (now playing, art, etc.) are visible to non-authenticated users. Automatically enabled if 'enable_public_page' is true. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand name type boolean format title description Whether this station has a public 'on-demand' streaming and download page. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand_download name type boolean format title description Whether the 'on-demand' page offers download capability. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_hls name type boolean format title description Whether HLS streaming is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName api_history_items name type integer format title description The number of 'last played' history items to show for a station in API responses. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName timezone name type string format title description The time zone that station operations should take place in. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example UTC examples refName max_bitrate name type integer format title description The maximum bitrate at which a station may broadcast, in Kbps. 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName max_mounts name type integer format title description The maximum number of mount points the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName max_hls_streams name type integer format title description The maximum number of HLS streams the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBrandingConfiguration properties default_album_art_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_css name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_js name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName offline_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/stations", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetstations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetstations/index.md" } ] }, { "id": "api/operations/adminaddstation/index.md", "kind": "operation", "title": "Create a new station.", "description": "POST /admin/stations: takes Station, returns Station.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminaddstation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminaddstation/index.md", "file": "api/operations/adminaddstation/index.md", "searchText": "operationId adminAddStation summary Create a new station. description method post path /admin/stations tags 0 Administration: Stations parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Station allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The full display name of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName short_name name type string format title description The URL-friendly name for the station, typically auto-generated from the full station name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName is_enabled name type boolean format title description If set to 'false', prevents the station from broadcasting but leaves it in the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontend_type name type string format title description default enum 0 icecast 1 shoutcast2 2 rsas 3 remote enumNames 0 Icecast 1 Shoutcast 2 Rsas 3 Remote enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FrontendAdapters frontend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationFrontendConfiguration properties custom_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName admin_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName relay_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listeners name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_user_agents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_countries name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allowed_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_license_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_user_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_type name type string format title description default enum 0 liquidsoap 1 none enumNames 0 Liquidsoap 1 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName BackendAdapters backend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBackendConfiguration properties charset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName telnet_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_format name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName use_manual_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reset_sequential_queues_on_restart name type boolean format title description Reset the internal queue of sequential playlists when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_queue_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_mount_point name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_buffer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName audio_processing_method name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName post_processing_include_live name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_license_key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_configuration_path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_preset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_loudness_target name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_replaygain_metadata name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_type name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_high name type number format float title description The dB level above which a track is considered 'loud' ('high' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_medium name type number format float title description The dB level below which a track is considered 'quiet' ('medium' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_margin name type number format float title description The dB difference above which two tracks are considered too different to overlap ('margin' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName duplicate_prevention_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks tracks and titles against, also applies to artists when duplicate_prevention_artist_time_range is not set. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName duplicate_prevention_artist_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks artists against, uses duplicate_prevention_time_range if set to null. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName performance_mode name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segment_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_in_playlist name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_overhead name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_enable_on_public_player name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName live_broadcast_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_auto_cue name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName write_playlists_to_liquidsoap name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName share_encoders name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_top name type string format title description Custom Liquidsoap Configuration: Top Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_playlists name type string format title description Custom Liquidsoap Configuration: Pre-Playlists Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_live name type string format title description Custom Liquidsoap Configuration: Pre-Live Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_fade name type string format title description Custom Liquidsoap Configuration: Pre-Fade Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config name type string format title description Custom Liquidsoap Configuration: Pre-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_bottom name type string format title description Custom Liquidsoap Configuration: Post-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A sample radio station. examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://demo.azuracast.com/ examples refName genre name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Various examples refName radio_base_dir name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio examples refName enable_requests name type boolean format title description Whether listeners can request songs to play on this station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName request_delay name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName request_threshold name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName requests_only_via_playlists name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName disconnect_deactivate_streamer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName enable_streamers name type boolean format title description Whether streamers are allowed to broadcast to this station at all. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_streamer_live name type boolean format title description Whether a streamer is currently active on the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_page name type boolean format title description Whether this station's public pages (player, on-demand streaming, etc.) are visible to non-authenticated users. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_api name type boolean format title description Whether the public-facing API endpoints (now playing, art, etc.) are visible to non-authenticated users. Automatically enabled if 'enable_public_page' is true. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand name type boolean format title description Whether this station has a public 'on-demand' streaming and download page. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand_download name type boolean format title description Whether the 'on-demand' page offers download capability. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_hls name type boolean format title description Whether HLS streaming is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName api_history_items name type integer format title description The number of 'last played' history items to show for a station in API responses. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName timezone name type string format title description The time zone that station operations should take place in. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example UTC examples refName max_bitrate name type integer format title description The maximum bitrate at which a station may broadcast, in Kbps. 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName max_mounts name type integer format title description The maximum number of mount points the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName max_hls_streams name type integer format title description The maximum number of HLS streams the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBrandingConfiguration properties default_album_art_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_css name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_js name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName offline_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Station allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The full display name of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName short_name name type string format title description The URL-friendly name for the station, typically auto-generated from the full station name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName is_enabled name type boolean format title description If set to 'false', prevents the station from broadcasting but leaves it in the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontend_type name type string format title description default enum enumNames 0 Icecast 1 Shoutcast 2 Rsas 3 Remote enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FrontendAdapters frontend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationFrontendConfiguration properties custom_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName admin_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName relay_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listeners name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_user_agents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_countries name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allowed_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_license_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_user_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_type name type string format title description default enum enumNames 0 Liquidsoap 1 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName BackendAdapters backend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBackendConfiguration properties charset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName telnet_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_format name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName use_manual_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reset_sequential_queues_on_restart name type boolean format title description Reset the internal queue of sequential playlists when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_queue_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_mount_point name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_buffer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName audio_processing_method name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName post_processing_include_live name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_license_key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_configuration_path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_preset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_loudness_target name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_replaygain_metadata name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_type name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_high name type number format float title description The dB level above which a track is considered 'loud' ('high' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_medium name type number format float title description The dB level below which a track is considered 'quiet' ('medium' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_margin name type number format float title description The dB difference above which two tracks are considered too different to overlap ('margin' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName duplicate_prevention_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks tracks and titles against, also applies to artists when duplicate_prevention_artist_time_range is not set. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName duplicate_prevention_artist_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks artists against, uses duplicate_prevention_time_range if set to null. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName performance_mode name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segment_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_in_playlist name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_overhead name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_enable_on_public_player name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName live_broadcast_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_auto_cue name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName write_playlists_to_liquidsoap name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName share_encoders name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_top name type string format title description Custom Liquidsoap Configuration: Top Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_playlists name type string format title description Custom Liquidsoap Configuration: Pre-Playlists Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_live name type string format title description Custom Liquidsoap Configuration: Pre-Live Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_fade name type string format title description Custom Liquidsoap Configuration: Pre-Fade Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config name type string format title description Custom Liquidsoap Configuration: Pre-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_bottom name type string format title description Custom Liquidsoap Configuration: Post-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A sample radio station. examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://demo.azuracast.com/ examples refName genre name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Various examples refName radio_base_dir name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio examples refName enable_requests name type boolean format title description Whether listeners can request songs to play on this station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName request_delay name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName request_threshold name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName requests_only_via_playlists name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName disconnect_deactivate_streamer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName enable_streamers name type boolean format title description Whether streamers are allowed to broadcast to this station at all. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_streamer_live name type boolean format title description Whether a streamer is currently active on the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_page name type boolean format title description Whether this station's public pages (player, on-demand streaming, etc.) are visible to non-authenticated users. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_api name type boolean format title description Whether the public-facing API endpoints (now playing, art, etc.) are visible to non-authenticated users. Automatically enabled if 'enable_public_page' is true. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand name type boolean format title description Whether this station has a public 'on-demand' streaming and download page. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand_download name type boolean format title description Whether the 'on-demand' page offers download capability. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_hls name type boolean format title description Whether HLS streaming is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName api_history_items name type integer format title description The number of 'last played' history items to show for a station in API responses. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName timezone name type string format title description The time zone that station operations should take place in. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example UTC examples refName max_bitrate name type integer format title description The maximum bitrate at which a station may broadcast, in Kbps. 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName max_mounts name type integer format title description The maximum number of mount points the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName max_hls_streams name type integer format title description The maximum number of HLS streams the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBrandingConfiguration properties default_album_art_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_css name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_js name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName offline_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/stations", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminaddstation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adminaddstation/index.md" } ] }, { "id": "api/operations/admingetstation/index.md", "kind": "operation", "title": "Retrieve details for a single station.", "description": "GET /admin/station/{id}: returns Station.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetstation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetstation/index.md", "file": "api/operations/admingetstation/index.md", "searchText": "operationId adminGetStation summary Retrieve details for a single station. description method get path /admin/station/{id} tags 0 Administration: Stations parameters 0 name id in path description ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Station allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The full display name of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName short_name name type string format title description The URL-friendly name for the station, typically auto-generated from the full station name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName is_enabled name type boolean format title description If set to 'false', prevents the station from broadcasting but leaves it in the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontend_type name type string format title description default enum 0 icecast 1 shoutcast2 2 rsas 3 remote enumNames 0 Icecast 1 Shoutcast 2 Rsas 3 Remote enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FrontendAdapters frontend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationFrontendConfiguration properties custom_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName admin_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName relay_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listeners name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_user_agents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_countries name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allowed_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_license_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_user_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_type name type string format title description default enum 0 liquidsoap 1 none enumNames 0 Liquidsoap 1 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName BackendAdapters backend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBackendConfiguration properties charset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName telnet_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_format name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName use_manual_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reset_sequential_queues_on_restart name type boolean format title description Reset the internal queue of sequential playlists when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_queue_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_mount_point name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_buffer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName audio_processing_method name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName post_processing_include_live name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_license_key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_configuration_path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_preset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_loudness_target name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_replaygain_metadata name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_type name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_high name type number format float title description The dB level above which a track is considered 'loud' ('high' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_medium name type number format float title description The dB level below which a track is considered 'quiet' ('medium' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_margin name type number format float title description The dB difference above which two tracks are considered too different to overlap ('margin' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName duplicate_prevention_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks tracks and titles against, also applies to artists when duplicate_prevention_artist_time_range is not set. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName duplicate_prevention_artist_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks artists against, uses duplicate_prevention_time_range if set to null. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName performance_mode name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segment_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_in_playlist name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_overhead name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_enable_on_public_player name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName live_broadcast_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_auto_cue name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName write_playlists_to_liquidsoap name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName share_encoders name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_top name type string format title description Custom Liquidsoap Configuration: Top Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_playlists name type string format title description Custom Liquidsoap Configuration: Pre-Playlists Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_live name type string format title description Custom Liquidsoap Configuration: Pre-Live Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_fade name type string format title description Custom Liquidsoap Configuration: Pre-Fade Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config name type string format title description Custom Liquidsoap Configuration: Pre-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_bottom name type string format title description Custom Liquidsoap Configuration: Post-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A sample radio station. examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://demo.azuracast.com/ examples refName genre name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Various examples refName radio_base_dir name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio examples refName enable_requests name type boolean format title description Whether listeners can request songs to play on this station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName request_delay name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName request_threshold name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName requests_only_via_playlists name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName disconnect_deactivate_streamer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName enable_streamers name type boolean format title description Whether streamers are allowed to broadcast to this station at all. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_streamer_live name type boolean format title description Whether a streamer is currently active on the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_page name type boolean format title description Whether this station's public pages (player, on-demand streaming, etc.) are visible to non-authenticated users. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_api name type boolean format title description Whether the public-facing API endpoints (now playing, art, etc.) are visible to non-authenticated users. Automatically enabled if 'enable_public_page' is true. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand name type boolean format title description Whether this station has a public 'on-demand' streaming and download page. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand_download name type boolean format title description Whether the 'on-demand' page offers download capability. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_hls name type boolean format title description Whether HLS streaming is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName api_history_items name type integer format title description The number of 'last played' history items to show for a station in API responses. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName timezone name type string format title description The time zone that station operations should take place in. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example UTC examples refName max_bitrate name type integer format title description The maximum bitrate at which a station may broadcast, in Kbps. 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName max_mounts name type integer format title description The maximum number of mount points the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName max_hls_streams name type integer format title description The maximum number of HLS streams the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBrandingConfiguration properties default_album_art_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_css name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_js name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName offline_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/station/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetstation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admingetstation/index.md" } ] }, { "id": "api/operations/admineditstation/index.md", "kind": "operation", "title": "Update details of a single station.", "description": "PUT /admin/station/{id}: takes Station, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admineditstation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admineditstation/index.md", "file": "api/operations/admineditstation/index.md", "searchText": "operationId adminEditStation summary Update details of a single station. description method put path /admin/station/{id} tags 0 Administration: Stations parameters 0 name id in path description ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Station allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The full display name of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName short_name name type string format title description The URL-friendly name for the station, typically auto-generated from the full station name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName is_enabled name type boolean format title description If set to 'false', prevents the station from broadcasting but leaves it in the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontend_type name type string format title description default enum 0 icecast 1 shoutcast2 2 rsas 3 remote enumNames 0 Icecast 1 Shoutcast 2 Rsas 3 Remote enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FrontendAdapters frontend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationFrontendConfiguration properties custom_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName admin_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName relay_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listeners name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_user_agents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_countries name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allowed_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_license_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_user_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_type name type string format title description default enum 0 liquidsoap 1 none enumNames 0 Liquidsoap 1 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName BackendAdapters backend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBackendConfiguration properties charset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName telnet_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_format name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName use_manual_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reset_sequential_queues_on_restart name type boolean format title description Reset the internal queue of sequential playlists when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_queue_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_mount_point name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_buffer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName audio_processing_method name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName post_processing_include_live name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_license_key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_configuration_path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_preset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_loudness_target name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_replaygain_metadata name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_type name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_high name type number format float title description The dB level above which a track is considered 'loud' ('high' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_medium name type number format float title description The dB level below which a track is considered 'quiet' ('medium' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_margin name type number format float title description The dB difference above which two tracks are considered too different to overlap ('margin' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName duplicate_prevention_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks tracks and titles against, also applies to artists when duplicate_prevention_artist_time_range is not set. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName duplicate_prevention_artist_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks artists against, uses duplicate_prevention_time_range if set to null. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName performance_mode name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segment_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_in_playlist name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_overhead name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_enable_on_public_player name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName live_broadcast_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_auto_cue name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName write_playlists_to_liquidsoap name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName share_encoders name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_top name type string format title description Custom Liquidsoap Configuration: Top Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_playlists name type string format title description Custom Liquidsoap Configuration: Pre-Playlists Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_live name type string format title description Custom Liquidsoap Configuration: Pre-Live Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_fade name type string format title description Custom Liquidsoap Configuration: Pre-Fade Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config name type string format title description Custom Liquidsoap Configuration: Pre-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_bottom name type string format title description Custom Liquidsoap Configuration: Post-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A sample radio station. examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://demo.azuracast.com/ examples refName genre name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Various examples refName radio_base_dir name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio examples refName enable_requests name type boolean format title description Whether listeners can request songs to play on this station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName request_delay name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName request_threshold name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName requests_only_via_playlists name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName disconnect_deactivate_streamer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName enable_streamers name type boolean format title description Whether streamers are allowed to broadcast to this station at all. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_streamer_live name type boolean format title description Whether a streamer is currently active on the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_page name type boolean format title description Whether this station's public pages (player, on-demand streaming, etc.) are visible to non-authenticated users. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_api name type boolean format title description Whether the public-facing API endpoints (now playing, art, etc.) are visible to non-authenticated users. Automatically enabled if 'enable_public_page' is true. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand name type boolean format title description Whether this station has a public 'on-demand' streaming and download page. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand_download name type boolean format title description Whether the 'on-demand' page offers download capability. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_hls name type boolean format title description Whether HLS streaming is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName api_history_items name type integer format title description The number of 'last played' history items to show for a station in API responses. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName timezone name type string format title description The time zone that station operations should take place in. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example UTC examples refName max_bitrate name type integer format title description The maximum bitrate at which a station may broadcast, in Kbps. 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName max_mounts name type integer format title description The maximum number of mount points the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName max_hls_streams name type integer format title description The maximum number of HLS streams the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBrandingConfiguration properties default_album_art_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_css name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_js name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName offline_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/station/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admineditstation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admineditstation/index.md" } ] }, { "id": "api/operations/admindeletestation/index.md", "kind": "operation", "title": "Delete a single station.", "description": "DELETE /admin/station/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindeletestation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindeletestation/index.md", "file": "api/operations/admindeletestation/index.md", "searchText": "operationId adminDeleteStation summary Delete a single station. description method delete path /admin/station/{id} tags 0 Administration: Stations parameters 0 name id in path description ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/station/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindeletestation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/admindeletestation/index.md" } ] }, { "id": "api/operations/getstereotool/index.md", "kind": "operation", "title": "Get information about the Stereo Tool installation.", "description": "GET /admin/stereo_tool: returns Api_Admin_StereoToolStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstereotool/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstereotool/index.md", "file": "api/operations/getstereotool/index.md", "searchText": "operationId getStereoTool summary Get information about the Stereo Tool installation. description method get path /admin/stereo_tool tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_StereoToolStatus properties version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 version example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/stereo_tool", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstereotool/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstereotool/index.md" } ] }, { "id": "api/operations/poststereotool/index.md", "kind": "operation", "title": "Upload a new Stereo Tool binary.", "description": "POST /admin/stereo_tool: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststereotool/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststereotool/index.md", "file": "api/operations/poststereotool/index.md", "searchText": "operationId postStereoTool summary Upload a new Stereo Tool binary. description method post path /admin/stereo_tool tags 0 Administration: General parameters requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/stereo_tool", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststereotool/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststereotool/index.md" } ] }, { "id": "api/operations/deletestereotool/index.md", "kind": "operation", "title": "Removes the installed Stereo Tool binary.", "description": "DELETE /admin/stereo_tool: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestereotool/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestereotool/index.md", "file": "api/operations/deletestereotool/index.md", "searchText": "operationId deleteStereoTool summary Removes the installed Stereo Tool binary. description method delete path /admin/stereo_tool tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/stereo_tool", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestereotool/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestereotool/index.md" } ] }, { "id": "api/operations/getstoragelocations/index.md", "kind": "operation", "title": "List all current storage locations in the system.", "description": "GET /admin/storage_locations.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstoragelocations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstoragelocations/index.md", "file": "api/operations/getstoragelocations/index.md", "searchText": "operationId getStorageLocations summary List all current storage locations in the system. description method get path /admin/storage_locations tags 0 Administration: Storage Locations parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocation allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties type name type string format title description default enum 0 backup 1 station_media 2 station_recordings 3 station_podcasts enumNames 0 Backup 1 StationMedia 2 StationRecordings 3 StationPodcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationTypes adapter name type string format title description default enum 0 local 1 s3 2 dropbox 3 sftp enumNames 0 Local 1 S3 2 Dropbox 3 Sftp enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationAdapters path name type string format title description The local path, if the local adapter is used, or path prefix for S3/remote adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio/media examples refName s3CredentialKey name type string format title description The credential key for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-key-here examples refName s3CredentialSecret name type string format title description The credential secret for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-secret-here examples refName s3Region name type string format title description The region for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-region examples refName s3Version name type string format title description The API version for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example latest examples refName s3Bucket name type string format title description The S3 bucket name for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-bucket-name examples refName s3Endpoint name type string format title description The optional custom S3 endpoint S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://your-region.digitaloceanspaces.com examples refName s3UsePathStyle name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAppKey name type string format title description The optional Dropbox App Key. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAppSecret name type string format title description The optional Dropbox App Secret. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAuthToken name type string format title description The optional Dropbox Auth Token. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftpHost name type string format title description The host for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 127.0.0.1 examples refName sftpUsername name type string format title description The username for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example root examples refName sftpPassword name type string format title description The password for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example abc123 examples refName sftpPort name type integer format title description The port for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName sftpPrivateKey name type string format title description The private key for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftpPrivateKeyPassPhrase name type string format title description The private key pass phrase for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storageQuotaBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120000 examples refName storageQuota name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 50 GB examples refName storageUsedBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 60000 examples refName storageUsed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 GB examples refName storageAvailableBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120000 examples refName storageAvailable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 GB examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_StorageLocation allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties storageUsedPercent name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 75 examples refName isFull name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName uri name type string format title description The URI associated with the storage location. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/www examples refName stations name type array format title description The stations using this storage location, if any. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/storage_locations", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstoragelocations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstoragelocations/index.md" } ] }, { "id": "api/operations/addstoragelocation/index.md", "kind": "operation", "title": "Create a new storage location.", "description": "POST /admin/storage_locations: takes Api_Admin_StorageLocation.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addstoragelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addstoragelocation/index.md", "file": "api/operations/addstoragelocation/index.md", "searchText": "operationId addStorageLocation summary Create a new storage location. description method post path /admin/storage_locations tags 0 Administration: Storage Locations parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_StorageLocation allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties storageUsedPercent name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 75 examples refName isFull name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName uri name type string format title description The URI associated with the storage location. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/www examples refName stations name type array format title description The stations using this storage location, if any. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocation allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties type name type string format title description default enum 0 backup 1 station_media 2 station_recordings 3 station_podcasts enumNames 0 Backup 1 StationMedia 2 StationRecordings 3 StationPodcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationTypes adapter name type string format title description default enum 0 local 1 s3 2 dropbox 3 sftp enumNames 0 Local 1 S3 2 Dropbox 3 Sftp enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationAdapters path name type string format title description The local path, if the local adapter is used, or path prefix for S3/remote adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio/media examples refName s3CredentialKey name type string format title description The credential key for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-key-here examples refName s3CredentialSecret name type string format title description The credential secret for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-secret-here examples refName s3Region name type string format title description The region for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-region examples refName s3Version name type string format title description The API version for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example latest examples refName s3Bucket name type string format title description The S3 bucket name for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-bucket-name examples refName s3Endpoint name type string format title description The optional custom S3 endpoint S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://your-region.digitaloceanspaces.com examples refName s3UsePathStyle name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAppKey name type string format title description The optional Dropbox App Key. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAppSecret name type string format title description The optional Dropbox App Secret. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAuthToken name type string format title description The optional Dropbox Auth Token. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftpHost name type string format title description The host for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 127.0.0.1 examples refName sftpUsername name type string format title description The username for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example root examples refName sftpPassword name type string format title description The password for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example abc123 examples refName sftpPort name type integer format title description The port for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName sftpPrivateKey name type string format title description The private key for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftpPrivateKeyPassPhrase name type string format title description The private key pass phrase for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storageQuotaBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120000 examples refName storageQuota name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 50 GB examples refName storageUsedBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 60000 examples refName storageUsed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 GB examples refName storageAvailableBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120000 examples refName storageAvailable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 GB examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_StorageLocation allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties storageUsedPercent name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 75 examples refName isFull name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName uri name type string format title description The URI associated with the storage location. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/www examples refName stations name type array format title description The stations using this storage location, if any. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/storage_locations", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addstoragelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addstoragelocation/index.md" } ] }, { "id": "api/operations/getstoragelocation/index.md", "kind": "operation", "title": "Retrieve details for a single storage location.", "description": "GET /admin/storage_location/{id}.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstoragelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstoragelocation/index.md", "file": "api/operations/getstoragelocation/index.md", "searchText": "operationId getStorageLocation summary Retrieve details for a single storage location. description method get path /admin/storage_location/{id} tags 0 Administration: Storage Locations parameters 0 name id in path description User ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocation allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties type name type string format title description default enum 0 backup 1 station_media 2 station_recordings 3 station_podcasts enumNames 0 Backup 1 StationMedia 2 StationRecordings 3 StationPodcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationTypes adapter name type string format title description default enum 0 local 1 s3 2 dropbox 3 sftp enumNames 0 Local 1 S3 2 Dropbox 3 Sftp enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationAdapters path name type string format title description The local path, if the local adapter is used, or path prefix for S3/remote adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio/media examples refName s3CredentialKey name type string format title description The credential key for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-key-here examples refName s3CredentialSecret name type string format title description The credential secret for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-secret-here examples refName s3Region name type string format title description The region for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-region examples refName s3Version name type string format title description The API version for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example latest examples refName s3Bucket name type string format title description The S3 bucket name for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-bucket-name examples refName s3Endpoint name type string format title description The optional custom S3 endpoint S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://your-region.digitaloceanspaces.com examples refName s3UsePathStyle name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAppKey name type string format title description The optional Dropbox App Key. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAppSecret name type string format title description The optional Dropbox App Secret. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAuthToken name type string format title description The optional Dropbox Auth Token. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftpHost name type string format title description The host for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 127.0.0.1 examples refName sftpUsername name type string format title description The username for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example root examples refName sftpPassword name type string format title description The password for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example abc123 examples refName sftpPort name type integer format title description The port for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName sftpPrivateKey name type string format title description The private key for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftpPrivateKeyPassPhrase name type string format title description The private key pass phrase for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storageQuotaBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120000 examples refName storageQuota name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 50 GB examples refName storageUsedBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 60000 examples refName storageUsed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 GB examples refName storageAvailableBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120000 examples refName storageAvailable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 GB examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_StorageLocation allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties storageUsedPercent name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 75 examples refName isFull name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName uri name type string format title description The URI associated with the storage location. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/www examples refName stations name type array format title description The stations using this storage location, if any. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/storage_location/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstoragelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstoragelocation/index.md" } ] }, { "id": "api/operations/editstoragelocation/index.md", "kind": "operation", "title": "Update details of a single storage location.", "description": "PUT /admin/storage_location/{id}: takes StorageLocation, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editstoragelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editstoragelocation/index.md", "file": "api/operations/editstoragelocation/index.md", "searchText": "operationId editStorageLocation summary Update details of a single storage location. description method put path /admin/storage_location/{id} tags 0 Administration: Storage Locations parameters 0 name id in path description Storage Location ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocation allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties type name type string format title description default enum 0 backup 1 station_media 2 station_recordings 3 station_podcasts enumNames 0 Backup 1 StationMedia 2 StationRecordings 3 StationPodcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationTypes adapter name type string format title description default enum 0 local 1 s3 2 dropbox 3 sftp enumNames 0 Local 1 S3 2 Dropbox 3 Sftp enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationAdapters path name type string format title description The local path, if the local adapter is used, or path prefix for S3/remote adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio/media examples refName s3CredentialKey name type string format title description The credential key for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-key-here examples refName s3CredentialSecret name type string format title description The credential secret for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-secret-here examples refName s3Region name type string format title description The region for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-region examples refName s3Version name type string format title description The API version for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example latest examples refName s3Bucket name type string format title description The S3 bucket name for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-bucket-name examples refName s3Endpoint name type string format title description The optional custom S3 endpoint S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://your-region.digitaloceanspaces.com examples refName s3UsePathStyle name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAppKey name type string format title description The optional Dropbox App Key. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAppSecret name type string format title description The optional Dropbox App Secret. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAuthToken name type string format title description The optional Dropbox Auth Token. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftpHost name type string format title description The host for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 127.0.0.1 examples refName sftpUsername name type string format title description The username for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example root examples refName sftpPassword name type string format title description The password for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example abc123 examples refName sftpPort name type integer format title description The port for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName sftpPrivateKey name type string format title description The private key for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftpPrivateKeyPassPhrase name type string format title description The private key pass phrase for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storageQuotaBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120000 examples refName storageQuota name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 50 GB examples refName storageUsedBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 60000 examples refName storageUsed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 GB examples refName storageAvailableBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120000 examples refName storageAvailable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 GB examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/storage_location/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editstoragelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editstoragelocation/index.md" } ] }, { "id": "api/operations/deletestoragelocation/index.md", "kind": "operation", "title": "Delete a single storage location.", "description": "DELETE /admin/storage_location/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestoragelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestoragelocation/index.md", "file": "api/operations/deletestoragelocation/index.md", "searchText": "operationId deleteStorageLocation summary Delete a single storage location. description method delete path /admin/storage_location/{id} tags 0 Administration: Storage Locations parameters 0 name id in path description Storage Location ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/storage_location/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestoragelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestoragelocation/index.md" } ] }, { "id": "api/operations/getupdatestatus/index.md", "kind": "operation", "title": "Show information about this installation and its update status.", "description": "GET /admin/updates: returns Api_Admin_UpdateDetails.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getupdatestatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getupdatestatus/index.md", "file": "api/operations/getupdatestatus/index.md", "searchText": "operationId getUpdateStatus summary Show information about this installation and its update status. description method get path /admin/updates tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_UpdateDetails properties current_release name type string format title description The stable-equivalent branch your installation currently appears to be on. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.3 examples refName latest_release name type string format title description The current latest stable release of the software. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.4 examples refName needs_rolling_update name type boolean format title description If you are on the Rolling Release, whether your installation needs to be updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName needs_release_update name type boolean format title description Whether a newer stable release is available than the version you are currently using. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName rolling_updates_available name type integer format title description If you are on the Rolling Release, the number of updates released since your version. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName can_switch_to_stable name type boolean format title description Whether you can seamlessly move from the Rolling Release channel to Stable without issues. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/updates", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getupdatestatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getupdatestatus/index.md" } ] }, { "id": "api/operations/putwebupdate/index.md", "kind": "operation", "title": "Attempts to trigger a web-based update.", "description": "PUT /admin/updates: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putwebupdate/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putwebupdate/index.md", "file": "api/operations/putwebupdate/index.md", "searchText": "operationId putWebUpdate summary Attempts to trigger a web-based update. description method put path /admin/updates tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/updates", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putwebupdate/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putwebupdate/index.md" } ] }, { "id": "api/operations/getusers/index.md", "kind": "operation", "title": "List all current users in the system.", "description": "GET /admin/users: returns a list of Api_Admin_UserWithDetails.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getusers/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getusers/index.md", "file": "api/operations/getusers/index.md", "searchText": "operationId getUsers summary List all current users in the system. description method get path /admin/users tags 0 Administration: Users parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_UserWithDetails required 0 is_me allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties is_me name type boolean format title description Whether this user record represents the currently logged-in user. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/users", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getusers/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getusers/index.md" } ] }, { "id": "api/operations/adduser/index.md", "kind": "operation", "title": "Create a new user.", "description": "POST /admin/users: takes User, returns Api_Admin_UserWithDetails.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adduser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adduser/index.md", "file": "api/operations/adduser/index.md", "searchText": "operationId addUser summary Create a new user. description method post path /admin/users tags 0 Administration: Users parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_UserWithDetails required 0 is_me allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties is_me name type boolean format title description Whether this user record represents the currently logged-in user. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /admin/users", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/adduser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/adduser/index.md" } ] }, { "id": "api/operations/getuser/index.md", "kind": "operation", "title": "Retrieve details for a single current user.", "description": "GET /admin/user/{id}: returns Api_Admin_UserWithDetails.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getuser/index.md", "file": "api/operations/getuser/index.md", "searchText": "operationId getUser summary Retrieve details for a single current user. description method get path /admin/user/{id} tags 0 Administration: Users parameters 0 name id in path description User ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_UserWithDetails required 0 is_me allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties is_me name type boolean format title description Whether this user record represents the currently logged-in user. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /admin/user/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getuser/index.md" } ] }, { "id": "api/operations/edituser/index.md", "kind": "operation", "title": "Update details of a single user.", "description": "PUT /admin/user/{id}: takes User, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/edituser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/edituser/index.md", "file": "api/operations/edituser/index.md", "searchText": "operationId editUser summary Update details of a single user. description method put path /admin/user/{id} tags 0 Administration: Users parameters 0 name id in path description User ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /admin/user/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/edituser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/edituser/index.md" } ] }, { "id": "api/operations/deleteuser/index.md", "kind": "operation", "title": "Delete a single user.", "description": "DELETE /admin/user/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteuser/index.md", "file": "api/operations/deleteuser/index.md", "searchText": "operationId deleteUser summary Delete a single user. description method delete path /admin/user/{id} tags 0 Administration: Users parameters 0 name id in path description User ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /admin/user/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteuser/index.md" } ] }, { "id": "api/operations/getmyapikeys/index.md", "kind": "operation", "title": "List all API keys associated with your account.", "description": "GET /frontend/account/api-keys.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmyapikeys/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmyapikeys/index.md", "file": "api/operations/getmyapikeys/index.md", "searchText": "operationId getMyApiKeys summary List all API keys associated with your account. description method get path /frontend/account/api-keys tags 0 My Account parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ApiKey allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /frontend/account/api-keys", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmyapikeys/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmyapikeys/index.md" } ] }, { "id": "api/operations/addmyapikey/index.md", "kind": "operation", "title": "Create a new API key associated with your account.", "description": "POST /frontend/account/api-keys: takes ApiKey.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addmyapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addmyapikey/index.md", "file": "api/operations/addmyapikey/index.md", "searchText": "operationId addMyApiKey summary Create a new API key associated with your account. description method post path /frontend/account/api-keys tags 0 My Account parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ApiKey allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Account_NewApiKey properties key name type string format title description The newly generated API key. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 key 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ApiKey allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /frontend/account/api-keys", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addmyapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addmyapikey/index.md" } ] }, { "id": "api/operations/getmyapikey/index.md", "kind": "operation", "title": "Retrieve details for a single API key.", "description": "GET /frontend/account/api-key/{id}.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmyapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmyapikey/index.md", "file": "api/operations/getmyapikey/index.md", "searchText": "operationId getMyApiKey summary Retrieve details for a single API key. description method get path /frontend/account/api-key/{id} tags 0 My Account parameters 0 name id in path description API Key ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ApiKey allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /frontend/account/api-key/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmyapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmyapikey/index.md" } ] }, { "id": "api/operations/deletemyapikey/index.md", "kind": "operation", "title": "Delete a single API key associated with your account.", "description": "DELETE /frontend/account/api-key/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemyapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemyapikey/index.md", "file": "api/operations/deletemyapikey/index.md", "searchText": "operationId deleteMyApiKey summary Delete a single API key associated with your account. description method delete path /frontend/account/api-key/{id} tags 0 My Account parameters 0 name id in path description API Key ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /frontend/account/api-key/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemyapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemyapikey/index.md" } ] }, { "id": "api/operations/getmytwofactor/index.md", "kind": "operation", "title": "Get the current two-factor authentication status of your account.", "description": "GET /frontend/account/two-factor: returns Api_Account_TwoFactorStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmytwofactor/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmytwofactor/index.md", "file": "api/operations/getmytwofactor/index.md", "searchText": "operationId getMyTwoFactor summary Get the current two-factor authentication status of your account. description method get path /frontend/account/two-factor tags 0 My Account parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Account_TwoFactorStatus properties two_factor_enabled name type boolean format title description The current two-factor status for this account. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 two_factor_enabled example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /frontend/account/two-factor", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmytwofactor/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmytwofactor/index.md" } ] }, { "id": "api/operations/putaccounttwofactor/index.md", "kind": "operation", "title": "Register a new two-factor authentication method.", "description": "PUT /frontend/account/two-factor: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putaccounttwofactor/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putaccounttwofactor/index.md", "file": "api/operations/putaccounttwofactor/index.md", "searchText": "operationId putAccountTwoFactor summary Register a new two-factor authentication method. description method put path /frontend/account/two-factor tags 0 My Account parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /frontend/account/two-factor", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putaccounttwofactor/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putaccounttwofactor/index.md" } ] }, { "id": "api/operations/deletemytwofactor/index.md", "kind": "operation", "title": "Remove two-factor authentication from your account.", "description": "DELETE /frontend/account/two-factor: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemytwofactor/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemytwofactor/index.md", "file": "api/operations/deletemytwofactor/index.md", "searchText": "operationId deleteMyTwoFactor summary Remove two-factor authentication from your account. description method delete path /frontend/account/two-factor tags 0 My Account parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /frontend/account/two-factor", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemytwofactor/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemytwofactor/index.md" } ] }, { "id": "api/operations/getme/index.md", "kind": "operation", "title": "Show the details for your current logged-in account.", "description": "GET /frontend/account/me: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getme/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getme/index.md", "file": "api/operations/getme/index.md", "searchText": "operationId getMe summary Show the details for your current logged-in account. description method get path /frontend/account/me tags 0 My Account parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /frontend/account/me", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getme/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getme/index.md" } ] }, { "id": "api/operations/putme/index.md", "kind": "operation", "title": "Save changes to your logged in account.", "description": "PUT /frontend/account/me: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putme/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putme/index.md", "file": "api/operations/putme/index.md", "searchText": "operationId putMe summary Save changes to your logged in account. description method put path /frontend/account/me tags 0 My Account parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /frontend/account/me", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putme/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putme/index.md" } ] }, { "id": "api/operations/getaccountlistpasskeys/index.md", "kind": "operation", "title": "List currently registered passkeys.", "description": "GET /frontend/account/passkeys: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountlistpasskeys/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountlistpasskeys/index.md", "file": "api/operations/getaccountlistpasskeys/index.md", "searchText": "operationId getAccountListPasskeys summary List currently registered passkeys. description method get path /frontend/account/passkeys tags 0 My Account parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /frontend/account/passkeys", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountlistpasskeys/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountlistpasskeys/index.md" } ] }, { "id": "api/operations/getaccountgetpasskey/index.md", "kind": "operation", "title": "Get the details of a single passkey.", "description": "GET /frontend/account/passkey/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountgetpasskey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountgetpasskey/index.md", "file": "api/operations/getaccountgetpasskey/index.md", "searchText": "operationId getAccountGetPasskey summary Get the details of a single passkey. description method get path /frontend/account/passkey/{id} tags 0 My Account parameters 0 name id in path description Passkey ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /frontend/account/passkey/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountgetpasskey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountgetpasskey/index.md" } ] }, { "id": "api/operations/deleteaccountpasskey/index.md", "kind": "operation", "title": "Delete a specified passkey by ID.", "description": "DELETE /frontend/account/passkey/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteaccountpasskey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteaccountpasskey/index.md", "file": "api/operations/deleteaccountpasskey/index.md", "searchText": "operationId deleteAccountPasskey summary Delete a specified passkey by ID. description method delete path /frontend/account/passkey/{id} tags 0 My Account parameters 0 name id in path description Passkey ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /frontend/account/passkey/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteaccountpasskey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteaccountpasskey/index.md" } ] }, { "id": "api/operations/changemypassword/index.md", "kind": "operation", "title": "Change the password of your account.", "description": "PUT /frontend/account/password: takes Api_Account_ChangePassword, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/changemypassword/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/changemypassword/index.md", "file": "api/operations/changemypassword/index.md", "searchText": "operationId changeMyPassword summary Change the password of your account. description method put path /frontend/account/password tags 0 My Account parameters requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Account_ChangePassword properties current_password name type string format title description The current account password. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName new_password name type string format title description The new account password. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 current_password 1 new_password example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /frontend/account/password", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/changemypassword/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/changemypassword/index.md" } ] }, { "id": "api/operations/getaccountwebauthnregister/index.md", "kind": "operation", "title": "Get registration details for WebAuthn registration.", "description": "GET /frontend/account/webauthn/register: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountwebauthnregister/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountwebauthnregister/index.md", "file": "api/operations/getaccountwebauthnregister/index.md", "searchText": "operationId getAccountWebAuthnRegister summary Get registration details for WebAuthn registration. description method get path /frontend/account/webauthn/register tags 0 My Account parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /frontend/account/webauthn/register", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountwebauthnregister/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getaccountwebauthnregister/index.md" } ] }, { "id": "api/operations/putaccountwebauthnregister/index.md", "kind": "operation", "title": "Submit a new registration request for WebAuthn.", "description": "PUT /frontend/account/webauthn/register: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putaccountwebauthnregister/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putaccountwebauthnregister/index.md", "file": "api/operations/putaccountwebauthnregister/index.md", "searchText": "operationId putAccountWebAuthnRegister summary Submit a new registration request for WebAuthn. description method put path /frontend/account/webauthn/register tags 0 My Account parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /frontend/account/webauthn/register", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putaccountwebauthnregister/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putaccountwebauthnregister/index.md" } ] }, { "id": "api/operations/getdashboardcharts/index.md", "kind": "operation", "title": "Get the measurements for the dashboard charts.", "description": "PUT /frontend/dashboard/charts: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getdashboardcharts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getdashboardcharts/index.md", "file": "api/operations/getdashboardcharts/index.md", "searchText": "operationId getDashboardCharts summary Get the measurements for the dashboard charts. description method put path /frontend/dashboard/charts tags 0 Miscellaneous parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /frontend/dashboard/charts", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getdashboardcharts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getdashboardcharts/index.md" } ] }, { "id": "api/operations/getnotifications/index.md", "kind": "operation", "title": "Show all notifications your current account should see.", "description": "GET /frontend/dashboard/notifications: returns a list of Api_Notification.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getnotifications/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getnotifications/index.md", "file": "api/operations/getnotifications/index.md", "searchText": "operationId getNotifications summary Show all notifications your current account should see. description method get path /frontend/dashboard/notifications tags 0 Miscellaneous parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Notification properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName body name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 success 1 warning 2 danger 3 info enumNames 0 Success 1 Warning 2 Error 3 Info enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FlashLevels actionLabel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName actionUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 title 2 body 3 type 4 actionLabel 5 actionUrl example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /frontend/dashboard/notifications", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getnotifications/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getnotifications/index.md" } ] }, { "id": "api/operations/getdashboardstations/index.md", "kind": "operation", "title": "List stations that can be managed by the current user account on the dashboard.", "description": "GET /frontend/dashboard/stations.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getdashboardstations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getdashboardstations/index.md", "file": "api/operations/getdashboardstations/index.md", "searchText": "operationId getDashboardStations summary List stations that can be managed by the current user account on the dashboard. description method get path /frontend/dashboard/stations tags 0 Miscellaneous parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying properties station name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Station properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName frontend name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName backend name type string format title description Which AutoDJ software (backend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example liquidsoap examples refName timezone name type string format title description The station's IANA time zone default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example America/Chicago examples refName listen_url name type string format title description The full URL to listen to the default mount of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName url name type string format title description The public URL of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName public_player_url name type string format title description The public player URL for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station examples refName playlist_pls_url name type string format title description The playlist download URL in PLS format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.pls examples refName playlist_m3u_url name type string format title description The playlist download URL in M3U format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.m3u examples refName is_public name type boolean format title description If the station is public (i.e. should be shown in listings of all stations) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests_enabled name type boolean format title description If the station has song requests enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remotes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners hls_enabled name type boolean format title description If the station has HLS streaming enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description If the HLS stream should be the default one for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_url name type string format title description The full URL to listen to the HLS stream for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/hls/azuratest_radio/live.m3u8 examples refName hls_listeners name type integer format title description HLS Listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName required 0 id 1 name 2 shortcode 3 description 4 frontend 5 backend 6 timezone 7 listen_url 8 url 9 public_player_url 10 playlist_pls_url 11 playlist_m3u_url 12 is_public 13 requests_enabled 14 mounts 15 remotes 16 hls_enabled 17 hls_is_default 18 hls_url 19 hls_listeners listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current live name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Live properties is_live name type boolean format title description Whether the stream is known to currently have a live DJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_name name type string format title description The current active streamer/DJ, if one is available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example DJ Jazzy Jeff examples refName broadcast_start name type integer format title description The start timestamp of the current broadcast, if one is available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1591548318 examples refName art name type string format title description URL to the streamer artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName required 0 is_live 1 streamer_name 2 broadcast_start 3 art now_playing name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_CurrentSong required 0 elapsed 1 remaining allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties elapsed name type integer format title description Elapsed time of the song's playback since it started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName remaining name type integer format title description Remaining time in the song, in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 155 examples refName playing_next name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationQueue properties cued_at name type integer format title description UNIX timestamp when the AutoDJ is expected to queue the song for playback. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName played_at name type integer format title description UNIX timestamp when playback is expected to start. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type number format float title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 cued_at 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 is_request 7 song song_history name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song is_online name type boolean format title description Whether the stream is currently online. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName cache name type string format title description Debugging information about where the now playing data comes from. default enum 0 hit 1 database 2 station enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 station 1 listeners 2 live 3 now_playing 4 playing_next 5 song_history 6 is_online 7 cache 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /frontend/dashboard/stations", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getdashboardstations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getdashboardstations/index.md" } ] }, { "id": "api/operations/getstatus/index.md", "kind": "operation", "title": "Returns an affirmative response if the API is active.", "description": "GET /status: returns Api_SystemStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstatus/index.md", "file": "api/operations/getstatus/index.md", "searchText": "operationId getStatus summary Returns an affirmative response if the API is active. description method get path /status tags 0 Public: Miscellaneous parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_SystemStatus properties online name type boolean format title description Whether the service is online or not (should always be true) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timestamp name type integer format title description The current UNIX timestamp default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName required 0 online 1 timestamp example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /status", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstatus/index.md" } ] }, { "id": "api/operations/gettime/index.md", "kind": "operation", "title": "GET /time", "description": "Returns the time (with formatting) in GMT and the user's local time zone, if logged in.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/gettime/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/gettime/index.md", "file": "api/operations/gettime/index.md", "searchText": "operationId getTime summary description Returns the time (with formatting) in GMT and the user's local time zone, if logged in. method get path /time tags 0 Public: Miscellaneous parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Time properties timestamp name type integer format title description The current UNIX timestamp default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1497652397 examples refName utc_datetime name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2017-06-16 10:33:17 examples refName utc_date name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example June 16, 2017 examples refName utc_time name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10:33pm examples refName utc_json name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2012-12-25T16:30:00.000000Z examples refName required 0 timestamp 1 utc_datetime 2 utc_date 3 utc_time 4 utc_json example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /time", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/gettime/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/gettime/index.md" } ] }, { "id": "api/operations/internalgetrelaydetails/index.md", "kind": "operation", "title": "GET /internal/relays", "description": "Returns all necessary information to relay all 'relayable' stations.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/internalgetrelaydetails/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/internalgetrelaydetails/index.md", "file": "api/operations/internalgetrelaydetails/index.md", "searchText": "operationId internalGetRelayDetails summary description Returns all necessary information to relay all 'relayable' stations. method get path /internal/relays tags 0 Administration: General parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Relay properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName url name type string format title description Station homepage URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://www.azuracast.com/ examples refName genre name type string format title description The genre of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Variety examples refName type name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName port name type integer format title description The port used by this station to serve its broadcasts. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 8000 examples refName relay_pw name type string format title description The relay password for the frontend (if applicable). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example p4ssw0rd examples refName admin_pw name type string format title description The administrator password for the frontend (if applicable). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example p4ssw0rd examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /internal/relays", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/internalgetrelaydetails/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/internalgetrelaydetails/index.md" } ] }, { "id": "api/operations/getallnowplaying/index.md", "kind": "operation", "title": "GET /nowplaying", "description": "Returns a full summary of all stations' current state.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getallnowplaying/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getallnowplaying/index.md", "file": "api/operations/getallnowplaying/index.md", "searchText": "operationId getAllNowPlaying summary description Returns a full summary of all stations' current state. method get path /nowplaying tags 0 Public: Now Playing parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying properties station name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Station properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName frontend name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName backend name type string format title description Which AutoDJ software (backend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example liquidsoap examples refName timezone name type string format title description The station's IANA time zone default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example America/Chicago examples refName listen_url name type string format title description The full URL to listen to the default mount of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName url name type string format title description The public URL of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName public_player_url name type string format title description The public player URL for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station examples refName playlist_pls_url name type string format title description The playlist download URL in PLS format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.pls examples refName playlist_m3u_url name type string format title description The playlist download URL in M3U format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.m3u examples refName is_public name type boolean format title description If the station is public (i.e. should be shown in listings of all stations) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests_enabled name type boolean format title description If the station has song requests enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remotes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners hls_enabled name type boolean format title description If the station has HLS streaming enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description If the HLS stream should be the default one for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_url name type string format title description The full URL to listen to the HLS stream for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/hls/azuratest_radio/live.m3u8 examples refName hls_listeners name type integer format title description HLS Listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName required 0 id 1 name 2 shortcode 3 description 4 frontend 5 backend 6 timezone 7 listen_url 8 url 9 public_player_url 10 playlist_pls_url 11 playlist_m3u_url 12 is_public 13 requests_enabled 14 mounts 15 remotes 16 hls_enabled 17 hls_is_default 18 hls_url 19 hls_listeners listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current live name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Live properties is_live name type boolean format title description Whether the stream is known to currently have a live DJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_name name type string format title description The current active streamer/DJ, if one is available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example DJ Jazzy Jeff examples refName broadcast_start name type integer format title description The start timestamp of the current broadcast, if one is available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1591548318 examples refName art name type string format title description URL to the streamer artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName required 0 is_live 1 streamer_name 2 broadcast_start 3 art now_playing name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_CurrentSong required 0 elapsed 1 remaining allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties elapsed name type integer format title description Elapsed time of the song's playback since it started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName remaining name type integer format title description Remaining time in the song, in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 155 examples refName playing_next name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationQueue properties cued_at name type integer format title description UNIX timestamp when the AutoDJ is expected to queue the song for playback. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName played_at name type integer format title description UNIX timestamp when playback is expected to start. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type number format float title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 cued_at 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 is_request 7 song song_history name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song is_online name type boolean format title description Whether the stream is currently online. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName cache name type string format title description Debugging information about where the now playing data comes from. default enum 0 hit 1 database 2 station enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 station 1 listeners 2 live 3 now_playing 4 playing_next 5 song_history 6 is_online 7 cache example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /nowplaying", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getallnowplaying/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getallnowplaying/index.md" } ] }, { "id": "api/operations/getstationnowplaying/index.md", "kind": "operation", "title": "GET /nowplaying/{station_id}", "description": "Returns a full summary of the specified station's current state.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationnowplaying/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationnowplaying/index.md", "file": "api/operations/getstationnowplaying/index.md", "searchText": "operationId getStationNowPlaying summary description Returns a full summary of the specified station's current state. method get path /nowplaying/{station_id} tags 0 Public: Now Playing parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying properties station name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Station properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName frontend name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName backend name type string format title description Which AutoDJ software (backend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example liquidsoap examples refName timezone name type string format title description The station's IANA time zone default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example America/Chicago examples refName listen_url name type string format title description The full URL to listen to the default mount of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName url name type string format title description The public URL of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName public_player_url name type string format title description The public player URL for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station examples refName playlist_pls_url name type string format title description The playlist download URL in PLS format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.pls examples refName playlist_m3u_url name type string format title description The playlist download URL in M3U format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.m3u examples refName is_public name type boolean format title description If the station is public (i.e. should be shown in listings of all stations) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests_enabled name type boolean format title description If the station has song requests enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remotes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners hls_enabled name type boolean format title description If the station has HLS streaming enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description If the HLS stream should be the default one for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_url name type string format title description The full URL to listen to the HLS stream for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/hls/azuratest_radio/live.m3u8 examples refName hls_listeners name type integer format title description HLS Listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName required 0 id 1 name 2 shortcode 3 description 4 frontend 5 backend 6 timezone 7 listen_url 8 url 9 public_player_url 10 playlist_pls_url 11 playlist_m3u_url 12 is_public 13 requests_enabled 14 mounts 15 remotes 16 hls_enabled 17 hls_is_default 18 hls_url 19 hls_listeners listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current live name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Live properties is_live name type boolean format title description Whether the stream is known to currently have a live DJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_name name type string format title description The current active streamer/DJ, if one is available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example DJ Jazzy Jeff examples refName broadcast_start name type integer format title description The start timestamp of the current broadcast, if one is available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1591548318 examples refName art name type string format title description URL to the streamer artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName required 0 is_live 1 streamer_name 2 broadcast_start 3 art now_playing name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_CurrentSong required 0 elapsed 1 remaining allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties elapsed name type integer format title description Elapsed time of the song's playback since it started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName remaining name type integer format title description Remaining time in the song, in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 155 examples refName playing_next name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationQueue properties cued_at name type integer format title description UNIX timestamp when the AutoDJ is expected to queue the song for playback. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName played_at name type integer format title description UNIX timestamp when playback is expected to start. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type number format float title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 cued_at 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 is_request 7 song song_history name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song is_online name type boolean format title description Whether the stream is currently online. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName cache name type string format title description Debugging information about where the now playing data comes from. default enum 0 hit 1 database 2 station enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 station 1 listeners 2 live 3 now_playing 4 playing_next 5 song_history 6 is_online 7 cache example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /nowplaying/{station_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationnowplaying/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationnowplaying/index.md" } ] }, { "id": "api/operations/getstationnowplayingart/index.md", "kind": "operation", "title": "Always redirects to the current art for the given station.", "description": "GET /nowplaying/{station_id}/art.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationnowplayingart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationnowplayingart/index.md", "file": "api/operations/getstationnowplayingart/index.md", "searchText": "operationId getStationNowPlayingArt summary Always redirects to the current art for the given station. description method get path /nowplaying/{station_id}/art tags 0 Public: Now Playing parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 302 summary description A temporary redirect to the correct resource. content headers location name location in header description The current URL of the resource. required deprecated schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /nowplaying/{station_id}/art", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationnowplayingart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationnowplayingart/index.md" } ] }, { "id": "api/operations/getopenapispec/index.md", "kind": "operation", "title": "Returns the OpenAPI specification document for this installation.", "description": "GET /openapi.yml.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getopenapispec/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getopenapispec/index.md", "file": "api/operations/getopenapispec/index.md", "searchText": "operationId getOpenApiSpec summary Returns the OpenAPI specification document for this installation. description method get path /openapi.yml tags 0 Public: Miscellaneous parameters requestBody responses 0 statusCode 200 summary description Success content text/x-yaml schema name type string format binary title description The OpenAPI specification document for this installation. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /openapi.yml", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getopenapispec/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getopenapispec/index.md" } ] }, { "id": "api/operations/getprometheus/index.md", "kind": "operation", "title": "Returns the Prometheus measurements for this installation.", "description": "GET /prometheus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getprometheus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getprometheus/index.md", "file": "api/operations/getprometheus/index.md", "searchText": "operationId getPrometheus summary Returns the Prometheus measurements for this installation. description method get path /prometheus tags 0 Miscellaneous parameters requestBody responses 0 statusCode 200 summary description Success content text/plain schema name type string format binary title description The Prometheus measurements for this installation. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /prometheus", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getprometheus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getprometheus/index.md" } ] }, { "id": "api/operations/getmediaart/index.md", "kind": "operation", "title": "Returns the album art for a song, or a generic image.", "description": "GET /station/{station_id}/art/{media_id}.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmediaart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmediaart/index.md", "file": "api/operations/getmediaart/index.md", "searchText": "operationId getMediaArt summary Returns the album art for a song, or a generic image. description method get path /station/{station_id}/art/{media_id} tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name media_id in path description The station media unique ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary image download. content image/* schema name type string format binary title description An image (album art, background, etc) in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 302 summary description Image not found; generic filler image. content headers location name location in header description The current URL of the resource. required deprecated schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/art/{media_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmediaart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmediaart/index.md" } ] }, { "id": "api/operations/postmediaart/index.md", "kind": "operation", "title": "Sets the album art for a track.", "description": "POST /station/{station_id}/art/{media_id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postmediaart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postmediaart/index.md", "file": "api/operations/postmediaart/index.md", "searchText": "operationId postMediaArt summary Sets the album art for a track. description method post path /station/{station_id}/art/{media_id} tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name media_id in path description Media ID required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/art/{media_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postmediaart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postmediaart/index.md" } ] }, { "id": "api/operations/deletemediaart/index.md", "kind": "operation", "title": "Removes the album art for a track.", "description": "DELETE /station/{station_id}/art/{media_id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemediaart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemediaart/index.md", "file": "api/operations/deletemediaart/index.md", "searchText": "operationId deleteMediaArt summary Removes the album art for a track. description method delete path /station/{station_id}/art/{media_id} tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name media_id in path description Media ID required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/art/{media_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemediaart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemediaart/index.md" } ] }, { "id": "api/operations/getstationbulkmediadownload/index.md", "kind": "operation", "title": "Download a CSV containing details about all station media.", "description": "GET /station/{station_id}/files/bulk.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationbulkmediadownload/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationbulkmediadownload/index.md", "file": "api/operations/getstationbulkmediadownload/index.md", "searchText": "operationId getStationBulkMediaDownload summary Download a CSV containing details about all station media. description method get path /station/{station_id}/files/bulk tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content text/csv schema name type string format binary title description A CSV file containing bulk media details. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/files/bulk", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationbulkmediadownload/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationbulkmediadownload/index.md" } ] }, { "id": "api/operations/poststationbulkmediaupload/index.md", "kind": "operation", "title": "Upload a CSV containing details about all station media.", "description": "POST /station/{station_id}/files/bulk: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationbulkmediaupload/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationbulkmediaupload/index.md", "file": "api/operations/poststationbulkmediaupload/index.md", "searchText": "operationId postStationBulkMediaUpload summary Upload a CSV containing details about all station media. description method post path /station/{station_id}/files/bulk tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/files/bulk", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationbulkmediaupload/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationbulkmediaupload/index.md" } ] }, { "id": "api/operations/poststationbulkmediapreview/index.md", "kind": "operation", "title": "Preview changes from a CSV containing details about all station media.", "description": "POST /station/{station_id}/files/bulk/preview: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationbulkmediapreview/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationbulkmediapreview/index.md", "file": "api/operations/poststationbulkmediapreview/index.md", "searchText": "operationId postStationBulkMediaPreview summary Preview changes from a CSV containing details about all station media. description method post path /station/{station_id}/files/bulk/preview tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/files/bulk/preview", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationbulkmediapreview/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationbulkmediapreview/index.md" } ] }, { "id": "api/operations/getstationcustomasset/index.md", "kind": "operation", "title": "Get the details of the custom asset of the specified type.", "description": "GET /station/{station_id}/custom_assets/{type}: returns Api_UploadedRecordStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationcustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationcustomasset/index.md", "file": "api/operations/getstationcustomasset/index.md", "searchText": "operationId getStationCustomAsset summary Get the details of the custom asset of the specified type. description method get path /station/{station_id}/custom_assets/{type} tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name type in path description Asset Type required deprecated style explode allowReserved schema name type string format title description default enum 0 album_art 1 background 2 browser_icon enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_UploadedRecordStatus properties hasRecord name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 hasRecord 1 url example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/custom_assets/{type}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationcustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationcustomasset/index.md" } ] }, { "id": "api/operations/poststationcustomasset/index.md", "kind": "operation", "title": "Upload a new custom asset of the specified type.", "description": "POST /station/{station_id}/custom_assets/{type}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationcustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationcustomasset/index.md", "file": "api/operations/poststationcustomasset/index.md", "searchText": "operationId postStationCustomAsset summary Upload a new custom asset of the specified type. description method post path /station/{station_id}/custom_assets/{type} tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name type in path description Asset Type required deprecated style explode allowReserved schema name type string format title description default enum 0 album_art 1 background 2 browser_icon enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/custom_assets/{type}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationcustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationcustomasset/index.md" } ] }, { "id": "api/operations/deletestationcustomasset/index.md", "kind": "operation", "title": "Removes the custom asset of the specified type.", "description": "DELETE /station/{station_id}/custom_assets/{type}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationcustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationcustomasset/index.md", "file": "api/operations/deletestationcustomasset/index.md", "searchText": "operationId deleteStationCustomAsset summary Removes the custom asset of the specified type. description method delete path /station/{station_id}/custom_assets/{type} tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name type in path description Asset Type required deprecated style explode allowReserved schema name type string format title description default enum 0 album_art 1 background 2 browser_icon enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/custom_assets/{type}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationcustomasset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationcustomasset/index.md" } ] }, { "id": "api/operations/getstationfallback/index.md", "kind": "operation", "title": "Get the custom fallback track for a station.", "description": "GET /station/{station_id}/fallback: returns Api_UploadedRecordStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfallback/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfallback/index.md", "file": "api/operations/getstationfallback/index.md", "searchText": "operationId getStationFallback summary Get the custom fallback track for a station. description method get path /station/{station_id}/fallback tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_UploadedRecordStatus properties hasRecord name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 hasRecord 1 url example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/fallback", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfallback/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfallback/index.md" } ] }, { "id": "api/operations/poststationfallback/index.md", "kind": "operation", "title": "Update the custom fallback track for the station.", "description": "POST /station/{station_id}/fallback: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfallback/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfallback/index.md", "file": "api/operations/poststationfallback/index.md", "searchText": "operationId postStationFallback summary Update the custom fallback track for the station. description method post path /station/{station_id}/fallback tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/fallback", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfallback/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfallback/index.md" } ] }, { "id": "api/operations/deletestationfallback/index.md", "kind": "operation", "title": "Removes the custom fallback track for a station.", "description": "DELETE /station/{station_id}/fallback: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationfallback/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationfallback/index.md", "file": "api/operations/deletestationfallback/index.md", "searchText": "operationId deleteStationFallback summary Removes the custom fallback track for a station. description method delete path /station/{station_id}/fallback tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/fallback", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationfallback/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationfallback/index.md" } ] }, { "id": "api/operations/putstationfilebatchaction/index.md", "kind": "operation", "title": "Perform a batch action on a collection of files/directories.", "description": "PUT /station/{station_id}/files/batch: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationfilebatchaction/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationfilebatchaction/index.md", "file": "api/operations/putstationfilebatchaction/index.md", "searchText": "operationId putStationFileBatchAction summary Perform a batch action on a collection of files/directories. description method put path /station/{station_id}/files/batch tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/files/batch", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationfilebatchaction/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationfilebatchaction/index.md" } ] }, { "id": "api/operations/getstationfiledownload/index.md", "kind": "operation", "title": "Download a file by relative path.", "description": "GET /station/{station_id}/files/download.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfiledownload/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfiledownload/index.md", "file": "api/operations/getstationfiledownload/index.md", "searchText": "operationId getStationFileDownload summary Download a file by relative path. description method get path /station/{station_id}/files/download tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name file in query description The relative path of the file in the Media filesystem. required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/files/download", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfiledownload/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfiledownload/index.md" } ] }, { "id": "api/operations/postuploadfile/index.md", "kind": "operation", "title": "Upload and process a new media file.", "description": "POST /station/{station_id}/files/upload: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postuploadfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postuploadfile/index.md", "file": "api/operations/postuploadfile/index.md", "searchText": "operationId postUploadFile summary Upload and process a new media file. description method post path /station/{station_id}/files/upload tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/files/upload", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postuploadfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postuploadfile/index.md" } ] }, { "id": "api/operations/getstationfilelist/index.md", "kind": "operation", "title": "List files in the media directory by path.", "description": "GET /station/{station_id}/files/list: returns a list of Api_FileList.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfilelist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfilelist/index.md", "file": "api/operations/getstationfilelist/index.md", "searchText": "operationId getStationFileList summary List files in the media directory by path. description method get path /station/{station_id}/files/list tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name currentDirectory in query description required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name searchPhrase in query description required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 3 name flushCache in query description required deprecated style explode allowReserved schema name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_FileList allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 directory 1 media 2 cover_art 3 unprocessable_file 4 other enumNames 0 Directory 1 Media 2 CoverArt 3 UnprocessableFile 4 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FileTypes timestamp name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMedia allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description The media's identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName unique_id name type string format title description A unique identifier for this specific media item in the station's library. Each entry in the media table has a unique ID, even if it refers to a song that exists elsewhere. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 69b536afc7ebbf16457b8645 examples refName song_id name type string format title description The media file's 32-character unique song identifier hash. This hash is based on track metadata, so the same song uploaded multiple times will have the same `song_id`. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album art. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName path name type string format title description The relative path of the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example test.mp3 examples refName mtime name type integer format title description The UNIX timestamp when the database was last modified. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName uploaded_at name type integer format title description The UNIX timestamp when the item was first imported into the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName art_updated_at name type integer format title description The latest time (UNIX timestamp) when album art was updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName length name type number format float title description The song duration in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 240 examples refName length_text name type string format title description The formatted song duration (in mm:ss format) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 4:00 examples refName custom_fields name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap extra_metadata name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dir name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_FileListDir properties playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/files/list", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfilelist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfilelist/index.md" } ] }, { "id": "api/operations/getstationfiledirectories/index.md", "kind": "operation", "title": "List directories in a station media library for moving/renaming.", "description": "GET /station/{station_id}/files/directories: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfiledirectories/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfiledirectories/index.md", "file": "api/operations/getstationfiledirectories/index.md", "searchText": "operationId getStationFileDirectories summary List directories in a station media library for moving/renaming. description method get path /station/{station_id}/files/directories tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/files/directories", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfiledirectories/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationfiledirectories/index.md" } ] }, { "id": "api/operations/poststationfilesmkdir/index.md", "kind": "operation", "title": "Create a directory in a station media directory.", "description": "POST /station/{station_id}/files/mkdir: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfilesmkdir/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfilesmkdir/index.md", "file": "api/operations/poststationfilesmkdir/index.md", "searchText": "operationId postStationFilesMkdir summary Create a directory in a station media directory. description method post path /station/{station_id}/files/mkdir tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/files/mkdir", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfilesmkdir/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfilesmkdir/index.md" } ] }, { "id": "api/operations/getplayfile/index.md", "kind": "operation", "title": "Download or play a given file by ID.", "description": "GET /station/{station_id}/file/{id}/play.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplayfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplayfile/index.md", "file": "api/operations/getplayfile/index.md", "searchText": "operationId getPlayFile summary Download or play a given file by ID. description method get path /station/{station_id}/file/{id}/play tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name media_id in path description Media ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/file/{id}/play", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplayfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplayfile/index.md" } ] }, { "id": "api/operations/getplayfilesongid/index.md", "kind": "operation", "title": "Download or play a given file by song_id.", "description": "GET /station/{station_id}/file/{song_id}/play.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplayfilesongid/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplayfilesongid/index.md", "file": "api/operations/getplayfilesongid/index.md", "searchText": "operationId getPlayFileSongId summary Download or play a given file by song_id. description method get path /station/{station_id}/file/{song_id}/play tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name song_id in path description Media ID required deprecated style explode allowReserved schema name type string format guid title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/file/{song_id}/play", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplayfilesongid/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplayfilesongid/index.md" } ] }, { "id": "api/operations/poststationfilesrename/index.md", "kind": "operation", "title": "Rename the specified files in the station media directory.", "description": "PUT /station/{station_id}/files/rename: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfilesrename/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfilesrename/index.md", "file": "api/operations/poststationfilesrename/index.md", "searchText": "operationId postStationFilesRename summary Rename the specified files in the station media directory. description method put path /station/{station_id}/files/rename tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/files/rename", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfilesrename/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationfilesrename/index.md" } ] }, { "id": "api/operations/getfiles/index.md", "kind": "operation", "title": "List all current uploaded files.", "description": "GET /station/{station_id}/files: returns a list of Api_StationMedia.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getfiles/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getfiles/index.md", "file": "api/operations/getfiles/index.md", "searchText": "operationId getFiles summary List all current uploaded files. description method get path /station/{station_id}/files tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMedia allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description The media's identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName unique_id name type string format title description A unique identifier for this specific media item in the station's library. Each entry in the media table has a unique ID, even if it refers to a song that exists elsewhere. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 69b536afc7ebbf16457b8645 examples refName song_id name type string format title description The media file's 32-character unique song identifier hash. This hash is based on track metadata, so the same song uploaded multiple times will have the same `song_id`. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album art. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName path name type string format title description The relative path of the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example test.mp3 examples refName mtime name type integer format title description The UNIX timestamp when the database was last modified. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName uploaded_at name type integer format title description The UNIX timestamp when the item was first imported into the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName art_updated_at name type integer format title description The latest time (UNIX timestamp) when album art was updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName length name type number format float title description The song duration in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 240 examples refName length_text name type string format title description The formatted song duration (in mm:ss format) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 4:00 examples refName custom_fields name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap extra_metadata name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/files", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getfiles/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getfiles/index.md" } ] }, { "id": "api/operations/addfile/index.md", "kind": "operation", "title": "Upload a new file.", "description": "POST /station/{station_id}/files: takes Api_UploadFile, returns Api_StationMedia.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addfile/index.md", "file": "api/operations/addfile/index.md", "searchText": "operationId addFile summary Upload a new file. description method post path /station/{station_id}/files tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_UploadFile properties path name type string format title description The destination path of the uploaded file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example relative/path/to/file.mp3 examples refName file name type string format title description The base64-encoded contents of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 path 1 file example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMedia allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description The media's identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName unique_id name type string format title description A unique identifier for this specific media item in the station's library. Each entry in the media table has a unique ID, even if it refers to a song that exists elsewhere. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 69b536afc7ebbf16457b8645 examples refName song_id name type string format title description The media file's 32-character unique song identifier hash. This hash is based on track metadata, so the same song uploaded multiple times will have the same `song_id`. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album art. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName path name type string format title description The relative path of the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example test.mp3 examples refName mtime name type integer format title description The UNIX timestamp when the database was last modified. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName uploaded_at name type integer format title description The UNIX timestamp when the item was first imported into the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName art_updated_at name type integer format title description The latest time (UNIX timestamp) when album art was updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName length name type number format float title description The song duration in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 240 examples refName length_text name type string format title description The formatted song duration (in mm:ss format) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 4:00 examples refName custom_fields name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap extra_metadata name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/files", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addfile/index.md" } ] }, { "id": "api/operations/getfile/index.md", "kind": "operation", "title": "Retrieve details for a single file.", "description": "GET /station/{station_id}/file/{id}: returns Api_StationMedia.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getfile/index.md", "file": "api/operations/getfile/index.md", "searchText": "operationId getFile summary Retrieve details for a single file. description method get path /station/{station_id}/file/{id} tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name media_id in path description Media ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMedia allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description The media's identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName unique_id name type string format title description A unique identifier for this specific media item in the station's library. Each entry in the media table has a unique ID, even if it refers to a song that exists elsewhere. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 69b536afc7ebbf16457b8645 examples refName song_id name type string format title description The media file's 32-character unique song identifier hash. This hash is based on track metadata, so the same song uploaded multiple times will have the same `song_id`. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album art. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName path name type string format title description The relative path of the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example test.mp3 examples refName mtime name type integer format title description The UNIX timestamp when the database was last modified. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName uploaded_at name type integer format title description The UNIX timestamp when the item was first imported into the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName art_updated_at name type integer format title description The latest time (UNIX timestamp) when album art was updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName length name type number format float title description The song duration in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 240 examples refName length_text name type string format title description The formatted song duration (in mm:ss format) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 4:00 examples refName custom_fields name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap extra_metadata name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/file/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getfile/index.md" } ] }, { "id": "api/operations/editfile/index.md", "kind": "operation", "title": "Update details of a single file.", "description": "PUT /station/{station_id}/file/{id}: takes Api_StationMedia, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editfile/index.md", "file": "api/operations/editfile/index.md", "searchText": "operationId editFile summary Update details of a single file. description method put path /station/{station_id}/file/{id} tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name media_id in path description Media ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMedia allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description The media's identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName unique_id name type string format title description A unique identifier for this specific media item in the station's library. Each entry in the media table has a unique ID, even if it refers to a song that exists elsewhere. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 69b536afc7ebbf16457b8645 examples refName song_id name type string format title description The media file's 32-character unique song identifier hash. This hash is based on track metadata, so the same song uploaded multiple times will have the same `song_id`. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album art. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName path name type string format title description The relative path of the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example test.mp3 examples refName mtime name type integer format title description The UNIX timestamp when the database was last modified. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName uploaded_at name type integer format title description The UNIX timestamp when the item was first imported into the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName art_updated_at name type integer format title description The latest time (UNIX timestamp) when album art was updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName length name type number format float title description The song duration in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 240 examples refName length_text name type string format title description The formatted song duration (in mm:ss format) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 4:00 examples refName custom_fields name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap extra_metadata name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/file/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editfile/index.md" } ] }, { "id": "api/operations/deletefile/index.md", "kind": "operation", "title": "Delete a single file.", "description": "DELETE /station/{station_id}/file/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletefile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletefile/index.md", "file": "api/operations/deletefile/index.md", "searchText": "operationId deleteFile summary Delete a single file. description method delete path /station/{station_id}/file/{id} tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name media_id in path description Media ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/file/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletefile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletefile/index.md" } ] }, { "id": "api/operations/getquota/index.md", "kind": "operation", "title": "Get the current usage and quota for a given station storage location.", "description": "GET /station/{station_id}/quota: returns Api_StationQuota.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getquota/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getquota/index.md", "file": "api/operations/getquota/index.md", "searchText": "operationId getQuota summary Get the current usage and quota for a given station storage location. description method get path /station/{station_id}/quota tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationQuota properties used name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_percent name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName available name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName available_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName quota name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName quota_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_full name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName num_files name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 used 1 used_bytes 2 used_percent 3 available 4 available_bytes 5 quota 6 quota_bytes 7 is_full 8 num_files example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/quota", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getquota/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getquota/index.md" } ] }, { "id": "api/operations/getquotaoftype/index.md", "kind": "operation", "title": "Get the current usage and quota for a given station storage location.", "description": "GET /station/{station_id}/quota/{type}: returns Api_StationQuota.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getquotaoftype/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getquotaoftype/index.md", "file": "api/operations/getquotaoftype/index.md", "searchText": "operationId getQuotaOfType summary Get the current usage and quota for a given station storage location. description method get path /station/{station_id}/quota/{type} tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name type in path description The storage location type (i.e. station_media, station_recordings, station_podcasts) required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationQuota properties used name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_percent name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName available name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName available_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName quota name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName quota_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_full name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName num_files name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 used 1 used_bytes 2 used_percent 3 available 4 available_bytes 5 quota 6 quota_bytes 7 is_full 8 num_files example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/quota/{type}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getquotaoftype/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getquotaoftype/index.md" } ] }, { "id": "api/operations/getstationhistory/index.md", "kind": "operation", "title": "Return song playback history items for a given station.", "description": "GET /station/{station_id}/history: returns a list of Api_DetailedSongHistory.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationhistory/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationhistory/index.md", "file": "api/operations/getstationhistory/index.md", "searchText": "operationId getStationHistory summary Return song playback history items for a given station. description method get path /station/{station_id}/history tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name start in query description The start date for records, in PHP-supported date/time format. (https://www.php.net/manual/en/datetime.formats.php) required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name end in query description The end date for records, in PHP-supported date/time format. (https://www.php.net/manual/en/datetime.formats.php) required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_DetailedSongHistory allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties listeners_start name type integer format title description Number of listeners when the song playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 94 examples refName listeners_end name type integer format title description Number of listeners when song playback ended. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 105 examples refName delta_total name type integer format title description The sum total change of listeners between the song's start and ending. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 11 examples refName is_visible name type boolean format title description Whether the entry is visible on public playlists. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/history", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationhistory/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationhistory/index.md" } ] }, { "id": "api/operations/gethlsstreams/index.md", "kind": "operation", "title": "List all current HLS streams.", "description": "GET /station/{station_id}/hls_streams: returns a list of StationHlsStream.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/gethlsstreams/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/gethlsstreams/index.md", "file": "api/operations/gethlsstreams/index.md", "searchText": "operationId getHlsStreams summary List all current HLS streams. description method get path /station/{station_id}/hls_streams tags 0 Stations: HLS Streams parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationHlsStream allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac_lofi examples refName format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac examples refName oneOf 0 name type string format title description default enum 0 aac 1 aac_he 2 aac_he_v2 enumNames 0 AacLowComplexity 1 AacHighEfficiencyV1 2 AacHighEfficiencyV2 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HlsStreamProfiles bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/hls_streams", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/gethlsstreams/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/gethlsstreams/index.md" } ] }, { "id": "api/operations/addhlsstream/index.md", "kind": "operation", "title": "Create a new HLS stream.", "description": "POST /station/{station_id}/hls_streams: takes StationHlsStream, returns StationHlsStream.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addhlsstream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addhlsstream/index.md", "file": "api/operations/addhlsstream/index.md", "searchText": "operationId addHlsStream summary Create a new HLS stream. description method post path /station/{station_id}/hls_streams tags 0 Stations: HLS Streams parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationHlsStream allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac_lofi examples refName format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac examples refName oneOf 0 name type string format title description default enum 0 aac 1 aac_he 2 aac_he_v2 enumNames 0 AacLowComplexity 1 AacHighEfficiencyV1 2 AacHighEfficiencyV2 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HlsStreamProfiles bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationHlsStream allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac_lofi examples refName format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac examples refName oneOf 0 name type string format title description default enum enumNames 0 AacLowComplexity 1 AacHighEfficiencyV1 2 AacHighEfficiencyV2 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HlsStreamProfiles bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/hls_streams", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addhlsstream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addhlsstream/index.md" } ] }, { "id": "api/operations/gethlsstream/index.md", "kind": "operation", "title": "Retrieve details for a single HLS stream.", "description": "GET /station/{station_id}/hls_stream/{id}: returns StationHlsStream.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/gethlsstream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/gethlsstream/index.md", "file": "api/operations/gethlsstream/index.md", "searchText": "operationId getHlsStream summary Retrieve details for a single HLS stream. description method get path /station/{station_id}/hls_stream/{id} tags 0 Stations: HLS Streams parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description HLS Stream ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationHlsStream allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac_lofi examples refName format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac examples refName oneOf 0 name type string format title description default enum 0 aac 1 aac_he 2 aac_he_v2 enumNames 0 AacLowComplexity 1 AacHighEfficiencyV1 2 AacHighEfficiencyV2 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HlsStreamProfiles bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/hls_stream/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/gethlsstream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/gethlsstream/index.md" } ] }, { "id": "api/operations/edithlsstream/index.md", "kind": "operation", "title": "Update details of a single HLS stream.", "description": "PUT /station/{station_id}/hls_stream/{id}: takes StationHlsStream, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/edithlsstream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/edithlsstream/index.md", "file": "api/operations/edithlsstream/index.md", "searchText": "operationId editHlsStream summary Update details of a single HLS stream. description method put path /station/{station_id}/hls_stream/{id} tags 0 Stations: HLS Streams parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description HLS Stream ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationHlsStream allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac_lofi examples refName format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac examples refName oneOf 0 name type string format title description default enum 0 aac 1 aac_he 2 aac_he_v2 enumNames 0 AacLowComplexity 1 AacHighEfficiencyV1 2 AacHighEfficiencyV2 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HlsStreamProfiles bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/hls_stream/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/edithlsstream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/edithlsstream/index.md" } ] }, { "id": "api/operations/deletehlsstream/index.md", "kind": "operation", "title": "Delete a single HLS stream.", "description": "DELETE /station/{station_id}/hls_stream/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletehlsstream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletehlsstream/index.md", "file": "api/operations/deletehlsstream/index.md", "searchText": "operationId deleteHlsStream summary Delete a single HLS stream. description method delete path /station/{station_id}/hls_stream/{id} tags 0 Stations: HLS Streams parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description HLS Stream ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/hls_stream/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletehlsstream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletehlsstream/index.md" } ] }, { "id": "api/operations/getstations/index.md", "kind": "operation", "title": "Returns a list of stations.", "description": "GET /stations: returns a list of Api_NowPlaying_Station.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstations/index.md", "file": "api/operations/getstations/index.md", "searchText": "operationId getStations summary Returns a list of stations. description method get path /stations tags 0 Public: Stations parameters requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Station properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName frontend name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName backend name type string format title description Which AutoDJ software (backend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example liquidsoap examples refName timezone name type string format title description The station's IANA time zone default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example America/Chicago examples refName listen_url name type string format title description The full URL to listen to the default mount of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName url name type string format title description The public URL of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName public_player_url name type string format title description The public player URL for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station examples refName playlist_pls_url name type string format title description The playlist download URL in PLS format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.pls examples refName playlist_m3u_url name type string format title description The playlist download URL in M3U format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.m3u examples refName is_public name type boolean format title description If the station is public (i.e. should be shown in listings of all stations) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests_enabled name type boolean format title description If the station has song requests enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remotes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners hls_enabled name type boolean format title description If the station has HLS streaming enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description If the HLS stream should be the default one for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_url name type string format title description The full URL to listen to the HLS stream for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/hls/azuratest_radio/live.m3u8 examples refName hls_listeners name type integer format title description HLS Listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName required 0 id 1 name 2 shortcode 3 description 4 frontend 5 backend 6 timezone 7 listen_url 8 url 9 public_player_url 10 playlist_pls_url 11 playlist_m3u_url 12 is_public 13 requests_enabled 14 mounts 15 remotes 16 hls_enabled 17 hls_is_default 18 hls_url 19 hls_listeners example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /stations", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstations/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstations/index.md" } ] }, { "id": "api/operations/getstation/index.md", "kind": "operation", "title": "Return information about a single station.", "description": "GET /station/{station_id}: returns Api_NowPlaying_Station.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstation/index.md", "file": "api/operations/getstation/index.md", "searchText": "operationId getStation summary Return information about a single station. description method get path /station/{station_id} tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Station properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName frontend name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName backend name type string format title description Which AutoDJ software (backend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example liquidsoap examples refName timezone name type string format title description The station's IANA time zone default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example America/Chicago examples refName listen_url name type string format title description The full URL to listen to the default mount of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName url name type string format title description The public URL of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName public_player_url name type string format title description The public player URL for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station examples refName playlist_pls_url name type string format title description The playlist download URL in PLS format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.pls examples refName playlist_m3u_url name type string format title description The playlist download URL in M3U format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.m3u examples refName is_public name type boolean format title description If the station is public (i.e. should be shown in listings of all stations) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests_enabled name type boolean format title description If the station has song requests enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remotes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners hls_enabled name type boolean format title description If the station has HLS streaming enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description If the HLS stream should be the default one for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_url name type string format title description The full URL to listen to the HLS stream for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/hls/azuratest_radio/live.m3u8 examples refName hls_listeners name type integer format title description HLS Listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName required 0 id 1 name 2 shortcode 3 description 4 frontend 5 backend 6 timezone 7 listen_url 8 url 9 public_player_url 10 playlist_pls_url 11 playlist_m3u_url 12 is_public 13 requests_enabled 14 mounts 15 remotes 16 hls_enabled 17 hls_is_default 18 hls_url 19 hls_listeners example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstation/index.md" } ] }, { "id": "api/operations/exportstationliquidsoapconfig/index.md", "kind": "operation", "title": "Generate an archive of all Liquidsoap configuration on your station, including custom config.", "description": "GET /station/{station_id}/liquidsoap-config/export: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/exportstationliquidsoapconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/exportstationliquidsoapconfig/index.md", "file": "api/operations/exportstationliquidsoapconfig/index.md", "searchText": "operationId exportStationLiquidsoapConfig summary Generate an archive of all Liquidsoap configuration on your station, including custom config. description method get path /station/{station_id}/liquidsoap-config/export tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/liquidsoap-config/export", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/exportstationliquidsoapconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/exportstationliquidsoapconfig/index.md" } ] }, { "id": "api/operations/getstationliquidsoapconfig/index.md", "kind": "operation", "title": "Get the generated and editable sections of the station Liquidsoap configuration.", "description": "GET /station/{station_id}/liquidsoap-config: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationliquidsoapconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationliquidsoapconfig/index.md", "file": "api/operations/getstationliquidsoapconfig/index.md", "searchText": "operationId getStationLiquidsoapConfig summary Get the generated and editable sections of the station Liquidsoap configuration. description method get path /station/{station_id}/liquidsoap-config tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/liquidsoap-config", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationliquidsoapconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationliquidsoapconfig/index.md" } ] }, { "id": "api/operations/putstationliquidsoapconfig/index.md", "kind": "operation", "title": "Save the editable sections of the station Liquidsoap configuration.", "description": "PUT /station/{station_id}/liquidsoap-config: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationliquidsoapconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationliquidsoapconfig/index.md", "file": "api/operations/putstationliquidsoapconfig/index.md", "searchText": "operationId putStationLiquidsoapConfig summary Save the editable sections of the station Liquidsoap configuration. description method put path /station/{station_id}/liquidsoap-config tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/liquidsoap-config", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationliquidsoapconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationliquidsoapconfig/index.md" } ] }, { "id": "api/operations/importstationliquidsoapconfig/index.md", "kind": "operation", "title": "Import a previously exported Liquidsoap configuration archive and replace custom config sections.", "description": "POST /station/{station_id}/liquidsoap-config/import: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/importstationliquidsoapconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/importstationliquidsoapconfig/index.md", "file": "api/operations/importstationliquidsoapconfig/index.md", "searchText": "operationId importStationLiquidsoapConfig summary Import a previously exported Liquidsoap configuration archive and replace custom config sections. description method post path /station/{station_id}/liquidsoap-config/import tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/liquidsoap-config/import", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/importstationliquidsoapconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/importstationliquidsoapconfig/index.md" } ] }, { "id": "api/operations/getstationlisteners/index.md", "kind": "operation", "title": "Return detailed information about current listeners.", "description": "GET /station/{station_id}/listeners: returns a list of Api_Listener.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlisteners/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlisteners/index.md", "file": "api/operations/getstationlisteners/index.md", "searchText": "operationId getStationListeners summary Return detailed information about current listeners. description method get path /station/{station_id}/listeners tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Listener properties ip name type string format title description The listener's IP address default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 127.0.0.1 examples refName user_agent name type string format title description The listener's HTTP User-Agent default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.86 Safari/537.36 examples refName hash name type string format title description A unique identifier for this listener/user agent (used for unique calculations). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mount_is_local name type boolean format title description Whether the user is connected to a local mount point or a remote one. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mount_name name type string format title description The display name of the mount point. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName connected_on name type integer format title description UNIX timestamp that the user first connected. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName connected_until name type integer format title description UNIX timestamp that the user disconnected (or the latest timestamp if they are still connected). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName connected_time name type integer format title description Number of seconds that the user has been connected. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 30 examples refName device name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_ListenerDevice properties client name type string format title description Summary of the listener client. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Firefox 121.0, Windows examples refName is_browser name type boolean format title description If the listener device is likely a browser. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_mobile name type boolean format title description If the listener device is likely a mobile device. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_bot name type boolean format title description If the listener device is likely a crawler. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName browser_family name type string format title description Summary of the listener browser family. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Firefox examples refName os_family name type string format title description Summary of the listener OS family. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Windows examples refName location name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_ListenerLocation properties description name type string format title description A description of the location. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Austin, Texas, US examples refName region name type string format title description The approximate region/state of the listener. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Texas examples refName city name type string format title description The approximate city of the listener. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Austin examples refName country name type string format title description The approximate country of the listener. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example United States examples refName lat name type number format float title description Latitude. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 30.000000 examples refName lon name type number format float title description Longitude. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example -97.000000 examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/listeners", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlisteners/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlisteners/index.md" } ] }, { "id": "api/operations/getstationlogs/index.md", "kind": "operation", "title": "Return a list of available logs for the given station.", "description": "GET /station/{station_id}/logs: returns a list of Api_LogType.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlogs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlogs/index.md", "file": "api/operations/getstationlogs/index.md", "searchText": "operationId getStationLogs summary Return a list of available logs for the given station. description method get path /station/{station_id}/logs tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogType required 0 key 1 name 2 path 3 tail allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName tail name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/logs", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlogs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlogs/index.md" } ] }, { "id": "api/operations/getstationlog/index.md", "kind": "operation", "title": "View a specific log contents for the given station.", "description": "GET /station/{station_id}/log/{key}: returns Api_LogContents.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlog/index.md", "file": "api/operations/getstationlog/index.md", "searchText": "operationId getStationLog summary View a specific log contents for the given station. description method get path /station/{station_id}/log/{key} tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name key in path description Log Key from listing return. required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogContents properties contents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName eof name type boolean format title description Whether the log file has ended at this point or has additional data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName position name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 contents 1 eof 2 position example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/log/{key}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationlog/index.md" } ] }, { "id": "api/operations/getmountintro/index.md", "kind": "operation", "title": "Get the intro track for a mount point.", "description": "GET /station/{station_id}/mount/{id}/intro.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmountintro/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmountintro/index.md", "file": "api/operations/getmountintro/index.md", "searchText": "operationId getMountIntro summary Get the intro track for a mount point. description method get path /station/{station_id}/mount/{id}/intro tags 0 Stations: Mount Points parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Mount Point ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/mount/{id}/intro", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmountintro/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmountintro/index.md" } ] }, { "id": "api/operations/postmountintro/index.md", "kind": "operation", "title": "Update the intro track for a mount point.", "description": "POST /station/{station_id}/mount/{id}/intro: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postmountintro/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postmountintro/index.md", "file": "api/operations/postmountintro/index.md", "searchText": "operationId postMountIntro summary Update the intro track for a mount point. description method post path /station/{station_id}/mount/{id}/intro tags 0 Stations: Mount Points parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Mount Point ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/mount/{id}/intro", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postmountintro/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postmountintro/index.md" } ] }, { "id": "api/operations/deletemountintro/index.md", "kind": "operation", "title": "Removes the intro track for a mount point.", "description": "DELETE /station/{station_id}/mount/{id}/intro: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemountintro/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemountintro/index.md", "file": "api/operations/deletemountintro/index.md", "searchText": "operationId deleteMountIntro summary Removes the intro track for a mount point. description method delete path /station/{station_id}/mount/{id}/intro tags 0 Stations: Mount Points parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Mount Point ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/mount/{id}/intro", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemountintro/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemountintro/index.md" } ] }, { "id": "api/operations/getstationmounts/index.md", "kind": "operation", "title": "List all current mount points.", "description": "GET /station/{station_id}/mounts: returns a list of StationMount.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationmounts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationmounts/index.md", "file": "api/operations/getstationmounts/index.md", "searchText": "operationId getStationMounts summary List all current mount points. description method get path /station/{station_id}/mounts tags 0 Stations: Mount Points parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationMount allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fallback_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /error.mp3 examples refName relay_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://radio.example.com:8000/radio.mp3 examples refName authhash name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listener_duration name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 43200 examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName frontend_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/mounts", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationmounts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationmounts/index.md" } ] }, { "id": "api/operations/addmount/index.md", "kind": "operation", "title": "Create a new mount point.", "description": "POST /station/{station_id}/mounts: takes StationMount, returns StationMount.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addmount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addmount/index.md", "file": "api/operations/addmount/index.md", "searchText": "operationId addMount summary Create a new mount point. description method post path /station/{station_id}/mounts tags 0 Stations: Mount Points parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationMount allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fallback_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /error.mp3 examples refName relay_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://radio.example.com:8000/radio.mp3 examples refName authhash name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listener_duration name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 43200 examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName frontend_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationMount allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fallback_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /error.mp3 examples refName relay_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://radio.example.com:8000/radio.mp3 examples refName authhash name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listener_duration name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 43200 examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName frontend_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/mounts", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addmount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addmount/index.md" } ] }, { "id": "api/operations/getmount/index.md", "kind": "operation", "title": "Retrieve details for a single mount point.", "description": "GET /station/{station_id}/mount/{id}: returns StationMount.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmount/index.md", "file": "api/operations/getmount/index.md", "searchText": "operationId getMount summary Retrieve details for a single mount point. description method get path /station/{station_id}/mount/{id} tags 0 Stations: Mount Points parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Mount Point ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationMount allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fallback_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /error.mp3 examples refName relay_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://radio.example.com:8000/radio.mp3 examples refName authhash name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listener_duration name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 43200 examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName frontend_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/mount/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getmount/index.md" } ] }, { "id": "api/operations/editmount/index.md", "kind": "operation", "title": "Update details of a single mount point.", "description": "PUT /station/{station_id}/mount/{id}: takes StationMount, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editmount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editmount/index.md", "file": "api/operations/editmount/index.md", "searchText": "operationId editMount summary Update details of a single mount point. description method put path /station/{station_id}/mount/{id} tags 0 Stations: Mount Points parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Mount Point ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationMount allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fallback_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /error.mp3 examples refName relay_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://radio.example.com:8000/radio.mp3 examples refName authhash name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listener_duration name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 43200 examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName frontend_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/mount/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editmount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editmount/index.md" } ] }, { "id": "api/operations/deletemount/index.md", "kind": "operation", "title": "Delete a single mount point.", "description": "DELETE /station/{station_id}/mount/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemount/index.md", "file": "api/operations/deletemount/index.md", "searchText": "operationId deleteMount summary Delete a single mount point. description method delete path /station/{station_id}/mount/{id} tags 0 Stations: Mount Points parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Mount Point ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/mount/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletemount/index.md" } ] }, { "id": "api/operations/getstationondemanddownload/index.md", "kind": "operation", "title": "Download an on-demand playlist file by media unique ID.", "description": "GET /station/{station_id}/ondemand/download/{media_id}.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationondemanddownload/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationondemanddownload/index.md", "file": "api/operations/getstationondemanddownload/index.md", "searchText": "operationId getStationOnDemandDownload summary Download an on-demand playlist file by media unique ID. description method get path /station/{station_id}/ondemand/download/{media_id} tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name media_id in path description The media unique ID to download. required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/ondemand/download/{media_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationondemanddownload/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationondemanddownload/index.md" } ] }, { "id": "api/operations/getstationondemand/index.md", "kind": "operation", "title": "List all tracks available on-demand for this station.", "description": "GET /station/{station_id}/ondemand: returns a list of Api_StationOnDemand.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationondemand/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationondemand/index.md", "file": "api/operations/getstationondemand/index.md", "searchText": "operationId getStationOnDemand summary List all tracks available on-demand for this station. description method get path /station/{station_id}/ondemand tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationOnDemand properties track_id name type string format title description Track ID unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName download_url name type string format title description URL to download/play track. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /api/station/1/ondemand/download/1 examples refName media name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName playlist name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/ondemand", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationondemand/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationondemand/index.md" } ] }, { "id": "api/operations/poststationplaylistclone/index.md", "kind": "operation", "title": "Create a copy of the specified playlist.", "description": "POST /station/{station_id}/playlist/{id}/clone: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistclone/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistclone/index.md", "file": "api/operations/poststationplaylistclone/index.md", "searchText": "operationId postStationPlaylistClone summary Create a copy of the specified playlist. description method post path /station/{station_id}/playlist/{id}/clone tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The name of the newly cloned playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName clone name type array format title description Which parts of the original playlist to clone. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 schedule 1 media 2 members enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/playlist/{id}/clone", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistclone/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistclone/index.md" } ] }, { "id": "api/operations/getstationplaylistqueue/index.md", "kind": "operation", "title": "Get the current playback queue for the specified playlist.", "description": "GET /station/{station_id}/playlist/{id}/queue: returns a list of Api_StationPlaylistQueue.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistqueue/index.md", "file": "api/operations/getstationplaylistqueue/index.md", "searchText": "operationId getStationPlaylistQueue summary Get the current playback queue for the specified playlist. description method get path /station/{station_id}/playlist/{id}/queue tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistQueue properties spm_id name type integer format title description ID of the StationPlaylistMedia record associating this track with the playlist default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName media_id name type integer format title description ID of the StationMedia record associating this track with the media default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName song_id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName last_played name type integer format title description The UNIX timestamp when this specific track was last played. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/playlist/{id}/queue", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistqueue/index.md" } ] }, { "id": "api/operations/deleteplaylistqueue/index.md", "kind": "operation", "title": "Reset the internal playback queue of a shuffled, song-based playlist.", "description": "DELETE /station/{station_id}/playlist/{id}/queue: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteplaylistqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteplaylistqueue/index.md", "file": "api/operations/deleteplaylistqueue/index.md", "searchText": "operationId deletePlaylistQueue summary Reset the internal playback queue of a shuffled, song-based playlist. description method delete path /station/{station_id}/playlist/{id}/queue tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/playlist/{id}/queue", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteplaylistqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteplaylistqueue/index.md" } ] }, { "id": "api/operations/deleteemptyplaylist/index.md", "kind": "operation", "title": "Empty the contents of a song-based playlist.", "description": "DELETE /station/{station_id}/playlist/{id}/empty: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteemptyplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteemptyplaylist/index.md", "file": "api/operations/deleteemptyplaylist/index.md", "searchText": "operationId deleteEmptyPlaylist summary Empty the contents of a song-based playlist. description method delete path /station/{station_id}/playlist/{id}/empty tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/playlist/{id}/empty", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteemptyplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteemptyplaylist/index.md" } ] }, { "id": "api/operations/getexportplaylist/index.md", "kind": "operation", "title": "Export a playlist contents in standard media player playlist format.", "description": "GET /station/{station_id}/playlist/{id}/export/{format}.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getexportplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getexportplaylist/index.md", "file": "api/operations/getexportplaylist/index.md", "searchText": "operationId getExportPlaylist summary Export a playlist contents in standard media player playlist format. description method get path /station/{station_id}/playlist/{id}/export/{format} tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name format in path description Export Playlist Format required deprecated style explode allowReserved schema name type string format title description default pls enum 0 pls 1 m3u enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/playlist/{id}/export/{format}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getexportplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getexportplaylist/index.md" } ] }, { "id": "api/operations/getstationplaylistsexportconfig/index.md", "kind": "operation", "title": "Export all of a station's playlists as a JSON configuration dump.", "description": "GET /station/{station_id}/playlists/export-config.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistsexportconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistsexportconfig/index.md", "file": "api/operations/getstationplaylistsexportconfig/index.md", "searchText": "operationId getStationPlaylistsExportConfig summary Export all of a station's playlists as a JSON configuration dump. description method get path /station/{station_id}/playlists/export-config tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/playlists/export-config", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistsexportconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistsexportconfig/index.md" } ] }, { "id": "api/operations/getstationplaylistexportconfig/index.md", "kind": "operation", "title": "Export a single playlist (and any group members) as a JSON configuration dump.", "description": "GET /station/{station_id}/playlist/{id}/export-config.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistexportconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistexportconfig/index.md", "file": "api/operations/getstationplaylistexportconfig/index.md", "searchText": "operationId getStationPlaylistExportConfig summary Export a single playlist (and any group members) as a JSON configuration dump. description method get path /station/{station_id}/playlist/{id}/export-config tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/playlist/{id}/export-config", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistexportconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistexportconfig/index.md" } ] }, { "id": "api/operations/getstationplaylistapplyto/index.md", "kind": "operation", "title": "Get a list of directories that the given playlist can apply to.", "description": "GET /station/{station_id}/playlist/{id}/apply-to: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistapplyto/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistapplyto/index.md", "file": "api/operations/getstationplaylistapplyto/index.md", "searchText": "operationId getStationPlaylistApplyTo summary Get a list of directories that the given playlist can apply to. description method get path /station/{station_id}/playlist/{id}/apply-to tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/playlist/{id}/apply-to", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistapplyto/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistapplyto/index.md" } ] }, { "id": "api/operations/putstationplaylistapplyto/index.md", "kind": "operation", "title": "Apply the specified playlist to the specified directories.", "description": "PUT /station/{station_id}/playlist/{id}/apply-to: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistapplyto/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistapplyto/index.md", "file": "api/operations/putstationplaylistapplyto/index.md", "searchText": "operationId putStationPlaylistApplyTo summary Apply the specified playlist to the specified directories. description method put path /station/{station_id}/playlist/{id}/apply-to tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/playlist/{id}/apply-to", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistapplyto/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistapplyto/index.md" } ] }, { "id": "api/operations/getstationplaylistorder/index.md", "kind": "operation", "title": "Get the current order of sequential tracks in the specified playlist.", "description": "GET /station/{station_id}/playlist/{id}/order: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistorder/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistorder/index.md", "file": "api/operations/getstationplaylistorder/index.md", "searchText": "operationId getStationPlaylistOrder summary Get the current order of sequential tracks in the specified playlist. description method get path /station/{station_id}/playlist/{id}/order tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/playlist/{id}/order", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistorder/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistorder/index.md" } ] }, { "id": "api/operations/putstationplaylistorder/index.md", "kind": "operation", "title": "Set the order of sequential tracks in the specified playlist.", "description": "PUT /station/{station_id}/playlist/{id}/order: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistorder/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistorder/index.md", "file": "api/operations/putstationplaylistorder/index.md", "searchText": "operationId putStationPlaylistOrder summary Set the order of sequential tracks in the specified playlist. description method put path /station/{station_id}/playlist/{id}/order tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/playlist/{id}/order", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistorder/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistorder/index.md" } ] }, { "id": "api/operations/poststationplaylistimport/index.md", "kind": "operation", "title": "Import the contents of an uploaded playlist (PLS/M3U) file into the specified playlist.", "description": "POST /station/{station_id}/playlist/{id}/import: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistimport/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistimport/index.md", "file": "api/operations/poststationplaylistimport/index.md", "searchText": "operationId postStationPlaylistImport summary Import the contents of an uploaded playlist (PLS/M3U) file into the specified playlist. description method post path /station/{station_id}/playlist/{id}/import tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/playlist/{id}/import", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistimport/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistimport/index.md" } ] }, { "id": "api/operations/poststationplaylistsimportconfig/index.md", "kind": "operation", "title": "Import playlists from a JSON configuration dump, creating new playlists on the station.", "description": "POST /station/{station_id}/playlists/import-config: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistsimportconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistsimportconfig/index.md", "file": "api/operations/poststationplaylistsimportconfig/index.md", "searchText": "operationId postStationPlaylistsImportConfig summary Import playlists from a JSON configuration dump, creating new playlists on the station. description method post path /station/{station_id}/playlists/import-config tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties config_file name type string format binary title description The JSON configuration dump to import. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name_prefix name type string format title description Optional prefix prepended to every imported playlist name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/playlists/import-config", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistsimportconfig/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationplaylistsimportconfig/index.md" } ] }, { "id": "api/operations/putstationplaylistmembers/index.md", "kind": "operation", "title": "Set the member playlists of the specified playlist group.", "description": "PUT /station/{station_id}/playlist/{id}/members: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistmembers/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistmembers/index.md", "file": "api/operations/putstationplaylistmembers/index.md", "searchText": "operationId putStationPlaylistMembers summary Set the member playlists of the specified playlist group. description method put path /station/{station_id}/playlist/{id}/members tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/playlist/{id}/members", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistmembers/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationplaylistmembers/index.md" } ] }, { "id": "api/operations/putreshuffleplaylist/index.md", "kind": "operation", "title": "Re-shuffle a playlist whose playback order is \"shuffled\".", "description": "PUT /station/{station_id}/playlist/{id}/reshuffle: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putreshuffleplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putreshuffleplaylist/index.md", "file": "api/operations/putreshuffleplaylist/index.md", "searchText": "operationId putReshufflePlaylist summary Re-shuffle a playlist whose playback order is \"shuffled\". description method put path /station/{station_id}/playlist/{id}/reshuffle tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/playlist/{id}/reshuffle", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putreshuffleplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putreshuffleplaylist/index.md" } ] }, { "id": "api/operations/puttoggleplaylist/index.md", "kind": "operation", "title": "Toggle a playlist between enabled and disabled status.", "description": "PUT /station/{station_id}/playlist/{id}/toggle: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/puttoggleplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/puttoggleplaylist/index.md", "file": "api/operations/puttoggleplaylist/index.md", "searchText": "operationId putTogglePlaylist summary Toggle a playlist between enabled and disabled status. description method put path /station/{station_id}/playlist/{id}/toggle tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/playlist/{id}/toggle", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/puttoggleplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/puttoggleplaylist/index.md" } ] }, { "id": "api/operations/getplaylists/index.md", "kind": "operation", "title": "List all current playlists.", "description": "GET /station/{station_id}/playlists.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplaylists/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplaylists/index.md", "file": "api/operations/getplaylists/index.md", "searchText": "operationId getPlaylists summary List all current playlists. description method get path /station/{station_id}/playlists tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name filter[source] in query description Filter by playlist source. Repeat as filter[source][] to match several values. required deprecated style explode allowReserved schema name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources content example examples 2 name filter[type] in query description Filter by playlist type. Repeat as filter[type][] to match several values. required deprecated style explode allowReserved schema name type string format title description default enum 0 default 1 once_per_x_songs 2 once_per_x_minutes 3 once_per_hour 4 custom enumNames 0 Standard 1 OncePerXSongs 2 OncePerXMinutes 3 OncePerHour 4 Advanced enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistTypes content example examples 3 name filter[order] in query description Filter by playback order. Repeat as filter[order][] to match several values. required deprecated style explode allowReserved schema name type string format title description default enum 0 random 1 shuffle 2 sequential enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPlaylist allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test Playlist examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A playlist containing my favorite songs examples refName type name type string format title description default enum enumNames 0 Standard 1 OncePerXSongs 2 OncePerXMinutes 3 OncePerHour 4 Advanced enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistTypes source name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders remote_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://remote-url.example.com/stream.mp3 examples refName remote_type name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example stream examples refName oneOf 0 name type string format title description default enum 0 stream 1 playlist 2 other enumNames 0 Stream 1 Playlist 2 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistRemoteTypes remote_buffer name type integer format title description The total time (in seconds) that Liquidsoap should buffer remote URL streams. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_jingle name type boolean format title description If yes, do not send jingle metadata to AutoDJ or trigger web hooks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName play_per_songs name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName play_per_minutes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName play_per_hour_minute name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName weight name type integer format title description The relative weight of the playlist. Larger numbers play more often than playlists with lower number weights. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName include_in_requests name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName include_in_on_demand name type boolean format title description Whether this playlist's media is included in 'on demand' download/streaming if enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_options name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example interrupt,loop_once,single_track,merge examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName avoid_duplicates name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName preserve_queue_on_restart name type boolean format title description Don't reset this playlist's queue when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName podcasts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistComputedFields properties short_name name type string format title description A URL-safe version of the playlist name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName num_songs name type integer format title description The number of songs in the playlist, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName total_length name type number format float title description The total length of the playlist in seconds, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3600 examples refName playlist_groups name type array format title description The parent groups that this playlist is a member of. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistParentGroup properties id name type integer format title description The unique identifier of the parent group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description The name of the parent group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example My Group examples refName required 0 id 1 name example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/playlists", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplaylists/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplaylists/index.md" } ] }, { "id": "api/operations/addplaylist/index.md", "kind": "operation", "title": "Create a new playlist.", "description": "POST /station/{station_id}/playlists: takes StationPlaylist.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addplaylist/index.md", "file": "api/operations/addplaylist/index.md", "searchText": "operationId addPlaylist summary Create a new playlist. description method post path /station/{station_id}/playlists tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPlaylist allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test Playlist examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A playlist containing my favorite songs examples refName type name type string format title description default enum 0 default 1 once_per_x_songs 2 once_per_x_minutes 3 once_per_hour 4 custom enumNames 0 Standard 1 OncePerXSongs 2 OncePerXMinutes 3 OncePerHour 4 Advanced enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistTypes source name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum 0 random 1 shuffle 2 sequential enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders remote_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://remote-url.example.com/stream.mp3 examples refName remote_type name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example stream examples refName oneOf 0 name type string format title description default enum 0 stream 1 playlist 2 other enumNames 0 Stream 1 Playlist 2 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistRemoteTypes remote_buffer name type integer format title description The total time (in seconds) that Liquidsoap should buffer remote URL streams. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_jingle name type boolean format title description If yes, do not send jingle metadata to AutoDJ or trigger web hooks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName play_per_songs name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName play_per_minutes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName play_per_hour_minute name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName weight name type integer format title description The relative weight of the playlist. Larger numbers play more often than playlists with lower number weights. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName include_in_requests name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName include_in_on_demand name type boolean format title description Whether this playlist's media is included in 'on demand' download/streaming if enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_options name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example interrupt,loop_once,single_track,merge examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName avoid_duplicates name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName preserve_queue_on_restart name type boolean format title description Don't reset this playlist's queue when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName podcasts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPlaylist allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test Playlist examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A playlist containing my favorite songs examples refName type name type string format title description default enum enumNames 0 Standard 1 OncePerXSongs 2 OncePerXMinutes 3 OncePerHour 4 Advanced enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistTypes source name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders remote_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://remote-url.example.com/stream.mp3 examples refName remote_type name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example stream examples refName oneOf 0 name type string format title description default enum enumNames 0 Stream 1 Playlist 2 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistRemoteTypes remote_buffer name type integer format title description The total time (in seconds) that Liquidsoap should buffer remote URL streams. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_jingle name type boolean format title description If yes, do not send jingle metadata to AutoDJ or trigger web hooks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName play_per_songs name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName play_per_minutes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName play_per_hour_minute name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName weight name type integer format title description The relative weight of the playlist. Larger numbers play more often than playlists with lower number weights. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName include_in_requests name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName include_in_on_demand name type boolean format title description Whether this playlist's media is included in 'on demand' download/streaming if enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_options name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example interrupt,loop_once,single_track,merge examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName avoid_duplicates name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName preserve_queue_on_restart name type boolean format title description Don't reset this playlist's queue when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName podcasts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistComputedFields properties short_name name type string format title description A URL-safe version of the playlist name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName num_songs name type integer format title description The number of songs in the playlist, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName total_length name type number format float title description The total length of the playlist in seconds, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3600 examples refName playlist_groups name type array format title description The parent groups that this playlist is a member of. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistParentGroup properties id name type integer format title description The unique identifier of the parent group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description The name of the parent group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example My Group examples refName required 0 id 1 name example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/playlists", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addplaylist/index.md" } ] }, { "id": "api/operations/getplaylist/index.md", "kind": "operation", "title": "Retrieve details for a single playlist.", "description": "GET /station/{station_id}/playlist/{id}.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplaylist/index.md", "file": "api/operations/getplaylist/index.md", "searchText": "operationId getPlaylist summary Retrieve details for a single playlist. description method get path /station/{station_id}/playlist/{id} tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPlaylist allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test Playlist examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A playlist containing my favorite songs examples refName type name type string format title description default enum 0 default 1 once_per_x_songs 2 once_per_x_minutes 3 once_per_hour 4 custom enumNames 0 Standard 1 OncePerXSongs 2 OncePerXMinutes 3 OncePerHour 4 Advanced enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistTypes source name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum 0 random 1 shuffle 2 sequential enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders remote_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://remote-url.example.com/stream.mp3 examples refName remote_type name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example stream examples refName oneOf 0 name type string format title description default enum 0 stream 1 playlist 2 other enumNames 0 Stream 1 Playlist 2 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistRemoteTypes remote_buffer name type integer format title description The total time (in seconds) that Liquidsoap should buffer remote URL streams. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_jingle name type boolean format title description If yes, do not send jingle metadata to AutoDJ or trigger web hooks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName play_per_songs name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName play_per_minutes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName play_per_hour_minute name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName weight name type integer format title description The relative weight of the playlist. Larger numbers play more often than playlists with lower number weights. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName include_in_requests name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName include_in_on_demand name type boolean format title description Whether this playlist's media is included in 'on demand' download/streaming if enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_options name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example interrupt,loop_once,single_track,merge examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName avoid_duplicates name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName preserve_queue_on_restart name type boolean format title description Don't reset this playlist's queue when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName podcasts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistComputedFields properties short_name name type string format title description A URL-safe version of the playlist name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName num_songs name type integer format title description The number of songs in the playlist, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName total_length name type number format float title description The total length of the playlist in seconds, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3600 examples refName playlist_groups name type array format title description The parent groups that this playlist is a member of. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistParentGroup properties id name type integer format title description The unique identifier of the parent group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description The name of the parent group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example My Group examples refName required 0 id 1 name example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/playlist/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getplaylist/index.md" } ] }, { "id": "api/operations/editplaylist/index.md", "kind": "operation", "title": "Update details of a single playlist.", "description": "PUT /station/{station_id}/playlist/{id}: takes StationPlaylist, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editplaylist/index.md", "file": "api/operations/editplaylist/index.md", "searchText": "operationId editPlaylist summary Update details of a single playlist. description method put path /station/{station_id}/playlist/{id} tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPlaylist allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test Playlist examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A playlist containing my favorite songs examples refName type name type string format title description default enum 0 default 1 once_per_x_songs 2 once_per_x_minutes 3 once_per_hour 4 custom enumNames 0 Standard 1 OncePerXSongs 2 OncePerXMinutes 3 OncePerHour 4 Advanced enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistTypes source name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum 0 random 1 shuffle 2 sequential enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders remote_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://remote-url.example.com/stream.mp3 examples refName remote_type name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example stream examples refName oneOf 0 name type string format title description default enum 0 stream 1 playlist 2 other enumNames 0 Stream 1 Playlist 2 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistRemoteTypes remote_buffer name type integer format title description The total time (in seconds) that Liquidsoap should buffer remote URL streams. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_jingle name type boolean format title description If yes, do not send jingle metadata to AutoDJ or trigger web hooks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName play_per_songs name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName play_per_minutes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName play_per_hour_minute name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName weight name type integer format title description The relative weight of the playlist. Larger numbers play more often than playlists with lower number weights. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName include_in_requests name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName include_in_on_demand name type boolean format title description Whether this playlist's media is included in 'on demand' download/streaming if enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_options name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example interrupt,loop_once,single_track,merge examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName avoid_duplicates name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName preserve_queue_on_restart name type boolean format title description Don't reset this playlist's queue when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName podcasts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/playlist/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editplaylist/index.md" } ] }, { "id": "api/operations/deleteplaylist/index.md", "kind": "operation", "title": "Delete a single playlist.", "description": "DELETE /station/{station_id}/playlist/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteplaylist/index.md", "file": "api/operations/deleteplaylist/index.md", "searchText": "operationId deletePlaylist summary Delete a single playlist. description method delete path /station/{station_id}/playlist/{id} tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Playlist ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/playlist/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteplaylist/index.md" } ] }, { "id": "api/operations/getstationplaylistsschedule/index.md", "kind": "operation", "title": "Return calendar events for the station's playlist schedule.", "description": "Controller used to respond to AJAX requests from the playlist \"Schedule View\".", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistsschedule/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistsschedule/index.md", "file": "api/operations/getstationplaylistsschedule/index.md", "searchText": "operationId getStationPlaylistsSchedule summary Return calendar events for the station's playlist schedule. description Controller used to respond to AJAX requests from the playlist \"Schedule View\". method get path /station/{station_id}/playlists/schedule tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationSchedulePlaylistEvent properties id name type integer format title description The unique identifier of the playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName title name type string format title description The playlist name representing the event title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Playlist examples refName type name type string format title description The type of this schedule event. default enum 0 playlist enumNames enumDescriptions const nullable readOnly writeOnly deprecated example playlist examples refName start name type string format title description The start time of this schedule event, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2020-02-19T03:00:00-06:00 examples refName end name type string format title description The end time of this schedule event, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2020-02-19T05:00:00-06:00 examples refName edit_url name type string format title description The API URL used to edit the underlying playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /api/station/1/playlist/1 examples refName source name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum 0 random 1 shuffle 2 sequential enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders playlist_type name type string format title description default enum 0 default 1 once_per_x_songs 2 once_per_x_minutes 3 once_per_hour 4 custom enumNames 0 Standard 1 OncePerXSongs 2 OncePerXMinutes 3 OncePerHour 4 Advanced enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistTypes play_per_songs name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName play_per_minutes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName play_per_hour_minute name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName weight name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName is_jingle name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName include_in_on_demand name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName avoid_duplicates name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName plays_via_group_schedule name type boolean format title description True if this playlist is a group member and an ancestor group's schedule covers this entire event, so it plays via that group instead of on its own. Partially covered events report false. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName members name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationScheduleGroupMember properties id name type integer format title description The unique identifier of the member playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description The name of the member playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Playlist examples refName source name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders weight name type integer format title description The weighting of this member within the group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName count name type integer format title description The number of songs or member playlists in this member, if applicable. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName consecutive_plays name type integer format title description The number of consecutive plays configured for this member. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName play_full_cycle name type boolean format title description Whether the member plays through its full cycle before advancing. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description Whether the member playlist is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name 2 source 3 order 4 weight 5 count 6 consecutive_plays 7 play_full_cycle 8 is_enabled num_songs name type integer format title description The number of songs in the playlist, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName total_length name type number format float title description The total length of the playlist in seconds, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3600 examples refName remote_url name type string format title description The remote URL, if this is a remote URL playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/stream examples refName remote_type name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 stream 1 playlist 2 other enumNames 0 Stream 1 Playlist 2 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistRemoteTypes required 0 id 1 title 2 type 3 start 4 end 5 edit_url 6 source 7 order 8 playlist_type 9 play_per_songs 10 play_per_minutes 11 play_per_hour_minute 12 weight 13 is_jingle 14 include_in_on_demand 15 avoid_duplicates 16 plays_via_group_schedule 17 members 18 num_songs 19 total_length 20 remote_url 21 remote_type example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/playlists/schedule", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistsschedule/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationplaylistsschedule/index.md" } ] }, { "id": "api/operations/getepisodes/index.md", "kind": "operation", "title": "List all current episodes for a given podcast ID.", "description": "GET /station/{station_id}/podcast/{podcast_id}/episodes: returns a list of Api_PodcastEpisode.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getepisodes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getepisodes/index.md", "file": "api/operations/getepisodes/index.md", "searchText": "operationId getEpisodes summary List all current episodes for a given podcast ID. description method get path /station/{station_id}/podcast/{podcast_id}/episodes tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastEpisode allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName season_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episode_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publish_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/podcast/{podcast_id}/episodes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getepisodes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getepisodes/index.md" } ] }, { "id": "api/operations/addepisode/index.md", "kind": "operation", "title": "Create a new podcast episode.", "description": "POST /station/{station_id}/podcast/{podcast_id}/episodes: takes Api_PodcastEpisode, returns Api_PodcastEpisode.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addepisode/index.md", "file": "api/operations/addepisode/index.md", "searchText": "operationId addEpisode summary Create a new podcast episode. description method post path /station/{station_id}/podcast/{podcast_id}/episodes tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastEpisode allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName season_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episode_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publish_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastEpisode allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName season_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episode_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publish_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/podcast/{podcast_id}/episodes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addepisode/index.md" } ] }, { "id": "api/operations/getepisode/index.md", "kind": "operation", "title": "Retrieve details for a single podcast episode.", "description": "GET /station/{station_id}/podcast/{podcast_id}/episode/{id}: returns Api_PodcastEpisode.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getepisode/index.md", "file": "api/operations/getepisode/index.md", "searchText": "operationId getEpisode summary Retrieve details for a single podcast episode. description method get path /station/{station_id}/podcast/{podcast_id}/episode/{id} tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name id in path description Podcast Episode ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastEpisode allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName season_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episode_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publish_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/podcast/{podcast_id}/episode/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getepisode/index.md" } ] }, { "id": "api/operations/editepisode/index.md", "kind": "operation", "title": "Update details of a single podcast episode.", "description": "PUT /station/{station_id}/podcast/{podcast_id}/episode/{id}: takes Api_PodcastEpisode, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editepisode/index.md", "file": "api/operations/editepisode/index.md", "searchText": "operationId editEpisode summary Update details of a single podcast episode. description method put path /station/{station_id}/podcast/{podcast_id}/episode/{id} tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name id in path description Podcast Episode ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastEpisode allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName season_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episode_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publish_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/podcast/{podcast_id}/episode/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editepisode/index.md" } ] }, { "id": "api/operations/deleteepisode/index.md", "kind": "operation", "title": "Delete a single podcast episode.", "description": "DELETE /station/{station_id}/podcast/{podcast_id}/episode/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteepisode/index.md", "file": "api/operations/deleteepisode/index.md", "searchText": "operationId deleteEpisode summary Delete a single podcast episode. description method delete path /station/{station_id}/podcast/{podcast_id}/episode/{id} tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name id in path description Podcast Episode ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/podcast/{podcast_id}/episode/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleteepisode/index.md" } ] }, { "id": "api/operations/getpodcastart/index.md", "kind": "operation", "title": "Gets the album art for a podcast.", "description": "GET /station/{station_id}/podcast/{podcast_id}/art.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastart/index.md", "file": "api/operations/getpodcastart/index.md", "searchText": "operationId getPodcastArt summary Gets the album art for a podcast. description method get path /station/{station_id}/podcast/{podcast_id}/art tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary image download. content image/* schema name type string format binary title description An image (album art, background, etc) in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 302 summary description A temporary redirect to the correct resource. content headers location name location in header description The current URL of the resource. required deprecated schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content links 2 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 4 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/podcast/{podcast_id}/art", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastart/index.md" } ] }, { "id": "api/operations/postpodcastart/index.md", "kind": "operation", "title": "Sets the album art for a podcast.", "description": "POST /station/{station_id}/podcast/{podcast_id}/art: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastart/index.md", "file": "api/operations/postpodcastart/index.md", "searchText": "operationId postPodcastArt summary Sets the album art for a podcast. description method post path /station/{station_id}/podcast/{podcast_id}/art tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/podcast/{podcast_id}/art", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastart/index.md" } ] }, { "id": "api/operations/deletepodcastart/index.md", "kind": "operation", "title": "Removes the album art for a podcast.", "description": "DELETE /station/{station_id}/podcast/{podcast_id}/art: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastart/index.md", "file": "api/operations/deletepodcastart/index.md", "searchText": "operationId deletePodcastArt summary Removes the album art for a podcast. description method delete path /station/{station_id}/podcast/{podcast_id}/art tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/podcast/{podcast_id}/art", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastart/index.md" } ] }, { "id": "api/operations/poststationpodcastbatch/index.md", "kind": "operation", "title": "Import the contents of an uploaded playlist (PLS/M3U) file into the specified playlist.", "description": "POST /station/{station_id}/podcast/{podcast_id}/batch: returns a list of Api_PodcastBatchResult.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationpodcastbatch/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationpodcastbatch/index.md", "file": "api/operations/poststationpodcastbatch/index.md", "searchText": "operationId postStationPodcastBatch summary Import the contents of an uploaded playlist (PLS/M3U) file into the specified playlist. description method post path /station/{station_id}/podcast/{podcast_id}/batch tags 0 Stations: Playlists parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties do name type string format title description The action to take with the specified rows. default enum 0 list 1 delete 2 edit enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episodes name type array format title description The IDs to perform batch actions on. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastBatchResult required 0 episodes 1 records allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_BatchResult properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errors name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 success 1 errors 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties episodes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 title records name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastEpisode allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName season_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episode_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publish_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/podcast/{podcast_id}/batch", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationpodcastbatch/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationpodcastbatch/index.md" } ] }, { "id": "api/operations/getpodcastepisodeart/index.md", "kind": "operation", "title": "Gets the album art for a podcast episode.", "description": "GET /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastepisodeart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastepisodeart/index.md", "file": "api/operations/getpodcastepisodeart/index.md", "searchText": "operationId getPodcastEpisodeArt summary Gets the album art for a podcast episode. description method get path /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name episode_id in path description Podcast Episode ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary image download. content image/* schema name type string format binary title description An image (album art, background, etc) in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 302 summary description A temporary redirect to the correct resource. content headers location name location in header description The current URL of the resource. required deprecated schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content links 2 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 4 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastepisodeart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastepisodeart/index.md" } ] }, { "id": "api/operations/postpodcastepisodeart/index.md", "kind": "operation", "title": "Sets the album art for a podcast episode.", "description": "POST /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastepisodeart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastepisodeart/index.md", "file": "api/operations/postpodcastepisodeart/index.md", "searchText": "operationId postPodcastEpisodeArt summary Sets the album art for a podcast episode. description method post path /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name episode_id in path description Podcast Episode ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastepisodeart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastepisodeart/index.md" } ] }, { "id": "api/operations/deletepodcastepisodeart/index.md", "kind": "operation", "title": "Removes the album art for a podcast episode.", "description": "DELETE /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastepisodeart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastepisodeart/index.md", "file": "api/operations/deletepodcastepisodeart/index.md", "searchText": "operationId deletePodcastEpisodeArt summary Removes the album art for a podcast episode. description method delete path /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name episode_id in path description Podcast Episode ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/art", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastepisodeart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastepisodeart/index.md" } ] }, { "id": "api/operations/getstationpublicpodcastepisode/index.md", "kind": "operation", "title": "Get information for a public episode of a public podcast.", "description": "GET /station/{station_id}/public/podcast/{podcast_id}/episode/{episode_id}: returns Api_PodcastEpisode.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcastepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcastepisode/index.md", "file": "api/operations/getstationpublicpodcastepisode/index.md", "searchText": "operationId getStationPublicPodcastEpisode summary Get information for a public episode of a public podcast. description method get path /station/{station_id}/public/podcast/{podcast_id}/episode/{episode_id} tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name episode_id in path description Podcast Episode ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastEpisode allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName season_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episode_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publish_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/public/podcast/{podcast_id}/episode/{episode_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcastepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcastepisode/index.md" } ] }, { "id": "api/operations/getstationpublicpodcastepisodes/index.md", "kind": "operation", "title": "List all visible episodes for a given podcast.", "description": "GET /station/{station_id}/public/podcast/{podcast_id}/episodes: returns a list of Api_PodcastEpisode.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcastepisodes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcastepisodes/index.md", "file": "api/operations/getstationpublicpodcastepisodes/index.md", "searchText": "operationId getStationPublicPodcastEpisodes summary List all visible episodes for a given podcast. description method get path /station/{station_id}/public/podcast/{podcast_id}/episodes tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastEpisode allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName season_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episode_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publish_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/public/podcast/{podcast_id}/episodes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcastepisodes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcastepisodes/index.md" } ] }, { "id": "api/operations/getpodcastepisodemedia/index.md", "kind": "operation", "title": "Gets the media for a podcast episode.", "description": "GET /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastepisodemedia/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastepisodemedia/index.md", "file": "api/operations/getpodcastepisodemedia/index.md", "searchText": "operationId getPodcastEpisodeMedia summary Gets the media for a podcast episode. description method get path /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name episode_id in path description Podcast Episode ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastepisodemedia/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcastepisodemedia/index.md" } ] }, { "id": "api/operations/postpodcastepisodemedia/index.md", "kind": "operation", "title": "Sets the media for a podcast episode.", "description": "POST /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastepisodemedia/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastepisodemedia/index.md", "file": "api/operations/postpodcastepisodemedia/index.md", "searchText": "operationId postPodcastEpisodeMedia summary Sets the media for a podcast episode. description method post path /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name episode_id in path description Podcast Episode ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastepisodemedia/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/postpodcastepisodemedia/index.md" } ] }, { "id": "api/operations/deletepodcastepisodemedia/index.md", "kind": "operation", "title": "Removes the media for a podcast episode.", "description": "DELETE /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastepisodemedia/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastepisodemedia/index.md", "file": "api/operations/deletepodcastepisodemedia/index.md", "searchText": "operationId deletePodcastEpisodeMedia summary Removes the media for a podcast episode. description method delete path /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name episode_id in path description Podcast Episode ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/podcast/{podcast_id}/episode/{episode_id}/media", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastepisodemedia/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcastepisodemedia/index.md" } ] }, { "id": "api/operations/getstationpublicpodcast/index.md", "kind": "operation", "title": "Get the public information for a given podcast.", "description": "GET /station/{station_id}/public/podcast/{podcast_id}: returns Api_Podcast.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcast/index.md", "file": "api/operations/getstationpublicpodcast/index.md", "searchText": "operationId getStationPublicPodcast summary Get the public information for a given podcast. description method get path /station/{station_id}/public/podcast/{podcast_id} tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Podcast allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storage_location_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_auto_publish name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PodcastBrandingConfiguration properties public_custom_html name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_op3_prefix name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName author name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName guid name type string format title description The UUIDv5 global unique identifier for this podcast, based on its RSS feed URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episodes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName categories name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastCategory properties category name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName subtitle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/public/podcast/{podcast_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcast/index.md" } ] }, { "id": "api/operations/getstationpublicpodcasts/index.md", "kind": "operation", "title": "List all visible public podcasts.", "description": "GET /station/{station_id}/public/podcasts: returns a list of Api_Podcast.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcasts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcasts/index.md", "file": "api/operations/getstationpublicpodcasts/index.md", "searchText": "operationId getStationPublicPodcasts summary List all visible public podcasts. description method get path /station/{station_id}/public/podcasts tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name podcast_id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Podcast allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storage_location_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_auto_publish name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PodcastBrandingConfiguration properties public_custom_html name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_op3_prefix name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName author name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName guid name type string format title description The UUIDv5 global unique identifier for this podcast, based on its RSS feed URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episodes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName categories name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastCategory properties category name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName subtitle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/public/podcasts", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcasts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpublicpodcasts/index.md" } ] }, { "id": "api/operations/getstationpodcastplaylists/index.md", "kind": "operation", "title": "Get a list of playlists that can be associated with a podcast.", "description": "GET /station/{station_id}/podcasts/playlists: returns Api_Form_SimpleOptions.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpodcastplaylists/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpodcastplaylists/index.md", "file": "api/operations/getstationpodcastplaylists/index.md", "searchText": "operationId getStationPodcastPlaylists summary Get a list of playlists that can be associated with a podcast. description method get path /station/{station_id}/podcasts/playlists tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_SimpleOptions items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_Option properties value name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 value 1 text example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/podcasts/playlists", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpodcastplaylists/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationpodcastplaylists/index.md" } ] }, { "id": "api/operations/getpodcasts/index.md", "kind": "operation", "title": "List all current podcasts.", "description": "GET /station/{station_id}/podcasts: returns a list of Api_Podcast.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcasts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcasts/index.md", "file": "api/operations/getpodcasts/index.md", "searchText": "operationId getPodcasts summary List all current podcasts. description method get path /station/{station_id}/podcasts tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Podcast allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storage_location_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_auto_publish name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PodcastBrandingConfiguration properties public_custom_html name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_op3_prefix name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName author name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName guid name type string format title description The UUIDv5 global unique identifier for this podcast, based on its RSS feed URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episodes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName categories name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastCategory properties category name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName subtitle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/podcasts", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcasts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcasts/index.md" } ] }, { "id": "api/operations/addpodcast/index.md", "kind": "operation", "title": "Create a new podcast.", "description": "POST /station/{station_id}/podcasts: takes Api_Podcast, returns Api_Podcast.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addpodcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addpodcast/index.md", "file": "api/operations/addpodcast/index.md", "searchText": "operationId addPodcast summary Create a new podcast. description method post path /station/{station_id}/podcasts tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Podcast allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storage_location_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_auto_publish name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PodcastBrandingConfiguration properties public_custom_html name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_op3_prefix name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName author name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName guid name type string format title description The UUIDv5 global unique identifier for this podcast, based on its RSS feed URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episodes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName categories name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastCategory properties category name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName subtitle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Podcast allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storage_location_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_auto_publish name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PodcastBrandingConfiguration properties public_custom_html name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_op3_prefix name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName author name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName guid name type string format title description The UUIDv5 global unique identifier for this podcast, based on its RSS feed URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episodes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName categories name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastCategory properties category name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName subtitle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/podcasts", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addpodcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addpodcast/index.md" } ] }, { "id": "api/operations/getpodcast/index.md", "kind": "operation", "title": "Retrieve details for a single podcast.", "description": "GET /station/{station_id}/podcast/{id}: returns Api_Podcast.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcast/index.md", "file": "api/operations/getpodcast/index.md", "searchText": "operationId getPodcast summary Retrieve details for a single podcast. description method get path /station/{station_id}/podcast/{id} tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Podcast allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storage_location_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_auto_publish name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PodcastBrandingConfiguration properties public_custom_html name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_op3_prefix name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName author name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName guid name type string format title description The UUIDv5 global unique identifier for this podcast, based on its RSS feed URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episodes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName categories name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastCategory properties category name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName subtitle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/podcast/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getpodcast/index.md" } ] }, { "id": "api/operations/editpodcast/index.md", "kind": "operation", "title": "Update details of a single podcast.", "description": "PUT /station/{station_id}/podcast/{id}: takes Api_Podcast, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editpodcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editpodcast/index.md", "file": "api/operations/editpodcast/index.md", "searchText": "operationId editPodcast summary Update details of a single podcast. description method put path /station/{station_id}/podcast/{id} tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Podcast allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storage_location_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_auto_publish name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PodcastBrandingConfiguration properties public_custom_html name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_op3_prefix name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName author name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName guid name type string format title description The UUIDv5 global unique identifier for this podcast, based on its RSS feed URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episodes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName categories name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastCategory properties category name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName subtitle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/podcast/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editpodcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editpodcast/index.md" } ] }, { "id": "api/operations/deletepodcast/index.md", "kind": "operation", "title": "Delete a single podcast.", "description": "DELETE /station/{station_id}/podcast/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcast/index.md", "file": "api/operations/deletepodcast/index.md", "searchText": "operationId deletePodcast summary Delete a single podcast. description method delete path /station/{station_id}/podcast/{id} tags 0 Stations: Podcasts parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Podcast ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/podcast/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletepodcast/index.md" } ] }, { "id": "api/operations/getstationprofile/index.md", "kind": "operation", "title": "Retrieve the profile of the given station.", "description": "GET /station/{station_id}/profile: returns Api_StationProfile.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationprofile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationprofile/index.md", "file": "api/operations/getstationprofile/index.md", "searchText": "operationId getStationProfile summary Retrieve the profile of the given station. description method get path /station/{station_id}/profile tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationProfile properties station name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Station properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName frontend name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName backend name type string format title description Which AutoDJ software (backend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example liquidsoap examples refName timezone name type string format title description The station's IANA time zone default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example America/Chicago examples refName listen_url name type string format title description The full URL to listen to the default mount of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName url name type string format title description The public URL of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName public_player_url name type string format title description The public player URL for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station examples refName playlist_pls_url name type string format title description The playlist download URL in PLS format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.pls examples refName playlist_m3u_url name type string format title description The playlist download URL in M3U format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.m3u examples refName is_public name type boolean format title description If the station is public (i.e. should be shown in listings of all stations) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests_enabled name type boolean format title description If the station has song requests enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remotes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners hls_enabled name type boolean format title description If the station has HLS streaming enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description If the HLS stream should be the default one for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_url name type string format title description The full URL to listen to the HLS stream for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/hls/azuratest_radio/live.m3u8 examples refName hls_listeners name type integer format title description HLS Listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName required 0 id 1 name 2 shortcode 3 description 4 frontend 5 backend 6 timezone 7 listen_url 8 url 9 public_player_url 10 playlist_pls_url 11 playlist_m3u_url 12 is_public 13 requests_enabled 14 mounts 15 remotes 16 hls_enabled 17 hls_is_default 18 hls_url 19 hls_listeners services name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationServiceStatus properties backendRunning name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontendRunning name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 backendRunning 1 frontendRunning schedule name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationSchedule properties id name type integer format title description Unique identifier for this schedule entry. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName type name type string format title description The type of this schedule entry. default enum 0 playlist 1 streamer enumNames enumDescriptions const nullable readOnly writeOnly deprecated example playlist examples refName name name type string format title description Either the playlist or streamer's display name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Schedule Entry examples refName title name type string format title description The name of the event. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Schedule Entry examples refName description name type string format title description The full name of the type and name combined. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Playlist: Example Schedule Entry examples refName start_timestamp name type integer format title description The start time of the schedule entry, in UNIX format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName start name type string format title description The start time of the schedule entry, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 020-02-19T03:00:00-06:00 examples refName end_timestamp name type integer format title description The end time of the schedule entry, in UNIX format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName end name type string format title description The start time of the schedule entry, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 020-02-19T05:00:00-06:00 examples refName is_now name type boolean format title description Whether the event is currently ongoing. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 station 1 services 2 schedule example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/profile", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationprofile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationprofile/index.md" } ] }, { "id": "api/operations/getstationprofileedit/index.md", "kind": "operation", "title": "Get the editable profile for the current station.", "description": "This controller handles the specific \"Edit Profile\" function on a station's profile, which has different permissions and possible actions than the Admin Station Edit function.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationprofileedit/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationprofileedit/index.md", "file": "api/operations/getstationprofileedit/index.md", "searchText": "operationId getStationProfileEdit summary Get the editable profile for the current station. description This controller handles the specific \"Edit Profile\" function on a station's profile, which has different permissions\nand possible actions than the Admin Station Edit function. method get path /station/{station_id}/profile/edit tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/profile/edit", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationprofileedit/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationprofileedit/index.md" } ] }, { "id": "api/operations/putstationprofileedit/index.md", "kind": "operation", "title": "Save the station profile for the current station.", "description": "PUT /station/{station_id}/profile/edit: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationprofileedit/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationprofileedit/index.md", "file": "api/operations/putstationprofileedit/index.md", "searchText": "operationId putStationProfileEdit summary Save the station profile for the current station. description method put path /station/{station_id}/profile/edit tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/profile/edit", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationprofileedit/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationprofileedit/index.md" } ] }, { "id": "api/operations/getqueue/index.md", "kind": "operation", "title": "Return information about the upcoming song playback queue.", "description": "GET /station/{station_id}/queue: returns a list of Api_StationQueueDetailed.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getqueue/index.md", "file": "api/operations/getqueue/index.md", "searchText": "operationId getQueue summary Return information about the upcoming song playback queue. description method get path /station/{station_id}/queue tags 0 Stations: Queue parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationQueueDetailed allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties sent_to_autodj name type boolean format title description Indicates whether the song has been sent to the AutoDJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_played name type boolean format title description Indicates whether the song has already been marked as played. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_custom_uri name type string format title description Custom AutoDJ playback URI, if it exists. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName log name type array format title description Log entries on how the specific queue item was picked by the AutoDJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/queue", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getqueue/index.md" } ] }, { "id": "api/operations/getqueueitem/index.md", "kind": "operation", "title": "Retrieve details of a single queued item.", "description": "GET /station/{station_id}/queue/{id}: returns Api_StationQueueDetailed.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getqueueitem/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getqueueitem/index.md", "file": "api/operations/getqueueitem/index.md", "searchText": "operationId getQueueItem summary Retrieve details of a single queued item. description method get path /station/{station_id}/queue/{id} tags 0 Stations: Queue parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Queue Item ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationQueueDetailed allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties sent_to_autodj name type boolean format title description Indicates whether the song has been sent to the AutoDJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_played name type boolean format title description Indicates whether the song has already been marked as played. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_custom_uri name type string format title description Custom AutoDJ playback URI, if it exists. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName log name type array format title description Log entries on how the specific queue item was picked by the AutoDJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/queue/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getqueueitem/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getqueueitem/index.md" } ] }, { "id": "api/operations/deletequeueitem/index.md", "kind": "operation", "title": "Delete a single queued item.", "description": "DELETE /station/{station_id}/queue/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletequeueitem/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletequeueitem/index.md", "file": "api/operations/deletequeueitem/index.md", "searchText": "operationId deleteQueueItem summary Delete a single queued item. description method delete path /station/{station_id}/queue/{id} tags 0 Stations: Queue parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Queue Item ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/queue/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletequeueitem/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletequeueitem/index.md" } ] }, { "id": "api/operations/getrelays/index.md", "kind": "operation", "title": "List all current remote relays.", "description": "GET /station/{station_id}/remotes.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrelays/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrelays/index.md", "file": "api/operations/getrelays/index.md", "searchText": "operationId getRelays summary List all current remote relays. description method get path /station/{station_id}/remotes tags 0 Stations: Remote Relays parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationRemote allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 shoutcast1 1 shoutcast2 2 icecast 3 azurarelay enumNames 0 Shoutcast1 1 Shoutcast2 2 Icecast 3 AzuraRelay enumDescriptions const nullable readOnly writeOnly deprecated example examples refName RemoteAdapters is_editable name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-url.example.com examples refName mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /stream.mp3 examples refName admin_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName source_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 8000 examples refName source_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example / examples refName source_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example source examples refName source_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/remotes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrelays/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrelays/index.md" } ] }, { "id": "api/operations/addrelay/index.md", "kind": "operation", "title": "Create a new remote relay.", "description": "POST /station/{station_id}/remotes: takes StationRemote.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addrelay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addrelay/index.md", "file": "api/operations/addrelay/index.md", "searchText": "operationId addRelay summary Create a new remote relay. description method post path /station/{station_id}/remotes tags 0 Stations: Remote Relays parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationRemote allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 shoutcast1 1 shoutcast2 2 icecast 3 azurarelay enumNames 0 Shoutcast1 1 Shoutcast2 2 Icecast 3 AzuraRelay enumDescriptions const nullable readOnly writeOnly deprecated example examples refName RemoteAdapters is_editable name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-url.example.com examples refName mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /stream.mp3 examples refName admin_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName source_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 8000 examples refName source_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example / examples refName source_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example source examples refName source_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationRemote allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum enumNames 0 Shoutcast1 1 Shoutcast2 2 Icecast 3 AzuraRelay enumDescriptions const nullable readOnly writeOnly deprecated example examples refName RemoteAdapters is_editable name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-url.example.com examples refName mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /stream.mp3 examples refName admin_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName source_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 8000 examples refName source_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example / examples refName source_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example source examples refName source_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/remotes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addrelay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addrelay/index.md" } ] }, { "id": "api/operations/getrelay/index.md", "kind": "operation", "title": "Retrieve details for a single remote relay.", "description": "GET /station/{station_id}/remote/{id}.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrelay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrelay/index.md", "file": "api/operations/getrelay/index.md", "searchText": "operationId getRelay summary Retrieve details for a single remote relay. description method get path /station/{station_id}/remote/{id} tags 0 Stations: Remote Relays parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Remote Relay ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationRemote allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 shoutcast1 1 shoutcast2 2 icecast 3 azurarelay enumNames 0 Shoutcast1 1 Shoutcast2 2 Icecast 3 AzuraRelay enumDescriptions const nullable readOnly writeOnly deprecated example examples refName RemoteAdapters is_editable name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-url.example.com examples refName mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /stream.mp3 examples refName admin_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName source_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 8000 examples refName source_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example / examples refName source_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example source examples refName source_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/remote/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrelay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrelay/index.md" } ] }, { "id": "api/operations/editrelay/index.md", "kind": "operation", "title": "Update details of a single remote relay.", "description": "PUT /station/{station_id}/remote/{id}: takes StationRemote, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editrelay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editrelay/index.md", "file": "api/operations/editrelay/index.md", "searchText": "operationId editRelay summary Update details of a single remote relay. description method put path /station/{station_id}/remote/{id} tags 0 Stations: Remote Relays parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Remote Relay ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationRemote allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 shoutcast1 1 shoutcast2 2 icecast 3 azurarelay enumNames 0 Shoutcast1 1 Shoutcast2 2 Icecast 3 AzuraRelay enumDescriptions const nullable readOnly writeOnly deprecated example examples refName RemoteAdapters is_editable name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-url.example.com examples refName mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /stream.mp3 examples refName admin_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName source_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 8000 examples refName source_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example / examples refName source_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example source examples refName source_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/remote/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editrelay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editrelay/index.md" } ] }, { "id": "api/operations/deleterelay/index.md", "kind": "operation", "title": "Delete a single remote relay.", "description": "DELETE /station/{station_id}/remote/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleterelay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleterelay/index.md", "file": "api/operations/deleterelay/index.md", "searchText": "operationId deleteRelay summary Delete a single remote relay. description method delete path /station/{station_id}/remote/{id} tags 0 Stations: Remote Relays parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Remote Relay ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/remote/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleterelay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deleterelay/index.md" } ] }, { "id": "api/operations/getstationreportbestandworst/index.md", "kind": "operation", "title": "Get the \"Best and Worst Performing Songs\" report for a station.", "description": "GET /station/{station_id}/reports/overview/best-and-worst: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbestandworst/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbestandworst/index.md", "file": "api/operations/getstationreportbestandworst/index.md", "searchText": "operationId getStationReportBestAndWorst summary Get the \"Best and Worst Performing Songs\" report for a station. description method get path /station/{station_id}/reports/overview/best-and-worst tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/reports/overview/best-and-worst", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbestandworst/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbestandworst/index.md" } ] }, { "id": "api/operations/getstationreportbybrowser/index.md", "kind": "operation", "title": "Get the \"Listeners by Browser\" report for a station.", "description": "GET /station/{station_id}/reports/overview/by-browser: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbybrowser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbybrowser/index.md", "file": "api/operations/getstationreportbybrowser/index.md", "searchText": "operationId getStationReportByBrowser summary Get the \"Listeners by Browser\" report for a station. description method get path /station/{station_id}/reports/overview/by-browser tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/reports/overview/by-browser", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbybrowser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbybrowser/index.md" } ] }, { "id": "api/operations/getstationreportbyclient/index.md", "kind": "operation", "title": "Get the \"Listeners by Client\" report for a station.", "description": "GET /station/{station_id}/reports/overview/by-client: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbyclient/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbyclient/index.md", "file": "api/operations/getstationreportbyclient/index.md", "searchText": "operationId getStationReportByClient summary Get the \"Listeners by Client\" report for a station. description method get path /station/{station_id}/reports/overview/by-client tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/reports/overview/by-client", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbyclient/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbyclient/index.md" } ] }, { "id": "api/operations/getstationreportbycountry/index.md", "kind": "operation", "title": "Get the \"Listeners by Country\" report for a station.", "description": "GET /station/{station_id}/reports/overview/by-country: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbycountry/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbycountry/index.md", "file": "api/operations/getstationreportbycountry/index.md", "searchText": "operationId getStationReportByCountry summary Get the \"Listeners by Country\" report for a station. description method get path /station/{station_id}/reports/overview/by-country tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/reports/overview/by-country", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbycountry/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbycountry/index.md" } ] }, { "id": "api/operations/getstationreportbylisteningtime/index.md", "kind": "operation", "title": "Get the \"Listeners by Listening Time\" report for a station.", "description": "GET /station/{station_id}/reports/overview/by-listening-time: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbylisteningtime/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbylisteningtime/index.md", "file": "api/operations/getstationreportbylisteningtime/index.md", "searchText": "operationId getStationReportByListeningTime summary Get the \"Listeners by Listening Time\" report for a station. description method get path /station/{station_id}/reports/overview/by-listening-time tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/reports/overview/by-listening-time", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbylisteningtime/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbylisteningtime/index.md" } ] }, { "id": "api/operations/getstationreportbystream/index.md", "kind": "operation", "title": "Get the \"Listeners by Stream\" report for a station.", "description": "GET /station/{station_id}/reports/overview/by-stream: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbystream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbystream/index.md", "file": "api/operations/getstationreportbystream/index.md", "searchText": "operationId getStationReportByStream summary Get the \"Listeners by Stream\" report for a station. description method get path /station/{station_id}/reports/overview/by-stream tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/reports/overview/by-stream", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbystream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportbystream/index.md" } ] }, { "id": "api/operations/getstationreportcharts/index.md", "kind": "operation", "title": "Get chart data for the station reports.", "description": "GET /station/{station_id}/reports/overview/charts: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportcharts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportcharts/index.md", "file": "api/operations/getstationreportcharts/index.md", "searchText": "operationId getStationReportCharts summary Get chart data for the station reports. description method get path /station/{station_id}/reports/overview/charts tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/reports/overview/charts", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportcharts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationreportcharts/index.md" } ] }, { "id": "api/operations/getstationrequestsreport/index.md", "kind": "operation", "title": "List station requests.", "description": "GET /station/{station_id}/reports/requests: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationrequestsreport/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationrequestsreport/index.md", "file": "api/operations/getstationrequestsreport/index.md", "searchText": "operationId getStationRequestsReport summary List station requests. description method get path /station/{station_id}/reports/requests tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/reports/requests", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationrequestsreport/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationrequestsreport/index.md" } ] }, { "id": "api/operations/poststationrequestsclear/index.md", "kind": "operation", "title": "Clear all unplayed station requests.", "description": "POST /station/{station_id}/reports/requests/clear: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationrequestsclear/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationrequestsclear/index.md", "file": "api/operations/poststationrequestsclear/index.md", "searchText": "operationId postStationRequestsClear summary Clear all unplayed station requests. description method post path /station/{station_id}/reports/requests/clear tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/reports/requests/clear", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationrequestsclear/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationrequestsclear/index.md" } ] }, { "id": "api/operations/deletestationrequest/index.md", "kind": "operation", "title": "Delete an individual station request.", "description": "DELETE /station/{station_id}/reports/requests/{request_id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationrequest/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationrequest/index.md", "file": "api/operations/deletestationrequest/index.md", "searchText": "operationId deleteStationRequest summary Delete an individual station request. description method delete path /station/{station_id}/reports/requests/{request_id} tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name request_id in path description Request ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/reports/requests/{request_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationrequest/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestationrequest/index.md" } ] }, { "id": "api/operations/getstationsoundexchangereport/index.md", "kind": "operation", "title": "Generate a SoundExchange royalty report.", "description": "Produce a report in SoundExchange (the US webcaster licensing agency) format.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationsoundexchangereport/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationsoundexchangereport/index.md", "file": "api/operations/getstationsoundexchangereport/index.md", "searchText": "operationId getStationSoundExchangeReport summary Generate a SoundExchange royalty report. description Produce a report in SoundExchange (the US webcaster licensing agency) format. method get path /station/{station_id}/reports/soundexchange tags 0 Stations: Reports parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name start_date in query description required deprecated style explode allowReserved schema name type string format date title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name end_date in query description required deprecated style explode allowReserved schema name type string format date title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content text/plain schema name type string format binary title description A CSV report for the given time range. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/reports/soundexchange", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationsoundexchangereport/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationsoundexchangereport/index.md" } ] }, { "id": "api/operations/getrequestablesongs/index.md", "kind": "operation", "title": "Return a list of requestable songs.", "description": "GET /station/{station_id}/requests: returns a list of Api_StationRequest.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrequestablesongs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrequestablesongs/index.md", "file": "api/operations/getrequestablesongs/index.md", "searchText": "operationId getRequestableSongs summary Return a list of requestable songs. description method get path /station/{station_id}/requests tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationRequest properties request_id name type string format title description Requestable ID unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName request_url name type string format title description URL to directly submit request default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /api/station/1/request/1 examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/requests", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrequestablesongs/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getrequestablesongs/index.md" } ] }, { "id": "api/operations/submitsongrequest/index.md", "kind": "operation", "title": "Submit a song request.", "description": "POST /station/{station_id}/request/{request_id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/submitsongrequest/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/submitsongrequest/index.md", "file": "api/operations/submitsongrequest/index.md", "searchText": "operationId submitSongRequest summary Submit a song request. description method post path /station/{station_id}/request/{request_id} tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name request_id in path description The requestable song ID required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/request/{request_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/submitsongrequest/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/submitsongrequest/index.md" } ] }, { "id": "api/operations/getschedule/index.md", "kind": "operation", "title": "Return upcoming and currently ongoing schedule entries.", "description": "GET /station/{station_id}/schedule: returns a list of Api_StationSchedule.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getschedule/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getschedule/index.md", "file": "api/operations/getschedule/index.md", "searchText": "operationId getSchedule summary Return upcoming and currently ongoing schedule entries. description method get path /station/{station_id}/schedule tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name now in query description The date/time to compare schedule items to. Defaults to the current date and time. required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name rows in query description The number of upcoming/ongoing schedule entries to return. Defaults to 5. required deprecated style explode allowReserved schema name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationSchedule properties id name type integer format title description Unique identifier for this schedule entry. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName type name type string format title description The type of this schedule entry. default enum 0 playlist 1 streamer enumNames enumDescriptions const nullable readOnly writeOnly deprecated example playlist examples refName name name type string format title description Either the playlist or streamer's display name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Schedule Entry examples refName title name type string format title description The name of the event. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Schedule Entry examples refName description name type string format title description The full name of the type and name combined. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Playlist: Example Schedule Entry examples refName start_timestamp name type integer format title description The start time of the schedule entry, in UNIX format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName start name type string format title description The start time of the schedule entry, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 020-02-19T03:00:00-06:00 examples refName end_timestamp name type integer format title description The end time of the schedule entry, in UNIX format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName end name type string format title description The start time of the schedule entry, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 020-02-19T05:00:00-06:00 examples refName is_now name type boolean format title description Whether the event is currently ongoing. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/schedule", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getschedule/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getschedule/index.md" } ] }, { "id": "api/operations/getservicestatus/index.md", "kind": "operation", "title": "Retrieve the current status of all serivces associated with the radio broadcast.", "description": "GET /station/{station_id}/status: returns Api_StationServiceStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getservicestatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getservicestatus/index.md", "file": "api/operations/getservicestatus/index.md", "searchText": "operationId getServiceStatus summary Retrieve the current status of all serivces associated with the radio broadcast. description method get path /station/{station_id}/status tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationServiceStatus properties backendRunning name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontendRunning name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 backendRunning 1 frontendRunning example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/status", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getservicestatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getservicestatus/index.md" } ] }, { "id": "api/operations/restartservices/index.md", "kind": "operation", "title": "Restart all services associated with the radio broadcast.", "description": "POST /station/{station_id}/restart: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/restartservices/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/restartservices/index.md", "file": "api/operations/restartservices/index.md", "searchText": "operationId restartServices summary Restart all services associated with the radio broadcast. description method post path /station/{station_id}/restart tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/restart", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/restartservices/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/restartservices/index.md" } ] }, { "id": "api/operations/dofrontendserviceaction/index.md", "kind": "operation", "title": "Perform service control actions on the radio frontend (Icecast, Shoutcast, etc.)", "description": "POST /station/{station_id}/frontend/{action}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/dofrontendserviceaction/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/dofrontendserviceaction/index.md", "file": "api/operations/dofrontendserviceaction/index.md", "searchText": "operationId doFrontendServiceAction summary Perform service control actions on the radio frontend (Icecast, Shoutcast, etc.) description method post path /station/{station_id}/frontend/{action} tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name action in path description The action to perform. required deprecated style explode allowReserved schema name type string format title description default restart enum 0 start 1 stop 2 reload 3 restart enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/frontend/{action}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/dofrontendserviceaction/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/dofrontendserviceaction/index.md" } ] }, { "id": "api/operations/dobackendserviceaction/index.md", "kind": "operation", "title": "Perform service control actions on the radio backend (Liquidsoap)", "description": "POST /station/{station_id}/backend/{action}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/dobackendserviceaction/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/dobackendserviceaction/index.md", "file": "api/operations/dobackendserviceaction/index.md", "searchText": "operationId doBackendServiceAction summary Perform service control actions on the radio backend (Liquidsoap) description method post path /station/{station_id}/backend/{action} tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name action in path description The action to perform. required deprecated style explode allowReserved schema name type string format title description default restart enum 0 skip 1 disconnect 2 start 3 stop 4 reload 5 restart enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/backend/{action}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/dobackendserviceaction/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/dobackendserviceaction/index.md" } ] }, { "id": "api/operations/getsftpusers/index.md", "kind": "operation", "title": "List all current SFTP users.", "description": "GET /station/{station_id}/sftp-users: returns a list of SftpUser.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsftpusers/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsftpusers/index.md", "file": "api/operations/getsftpusers/index.md", "searchText": "operationId getSftpUsers summary List all current SFTP users. description method get path /station/{station_id}/sftp-users tags 0 Stations: SFTP Users parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName SftpUser allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicKeys name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/sftp-users", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsftpusers/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsftpusers/index.md" } ] }, { "id": "api/operations/addsftpuser/index.md", "kind": "operation", "title": "Create a new SFTP user.", "description": "POST /station/{station_id}/sftp-users: takes SftpUser, returns SftpUser.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addsftpuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addsftpuser/index.md", "file": "api/operations/addsftpuser/index.md", "searchText": "operationId addSftpUser summary Create a new SFTP user. description method post path /station/{station_id}/sftp-users tags 0 Stations: SFTP Users parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName SftpUser allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicKeys name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName SftpUser allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicKeys name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/sftp-users", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addsftpuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addsftpuser/index.md" } ] }, { "id": "api/operations/getsftpuser/index.md", "kind": "operation", "title": "Retrieve details for a single SFTP user.", "description": "GET /station/{station_id}/sftp-user/{id}: returns SftpUser.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsftpuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsftpuser/index.md", "file": "api/operations/getsftpuser/index.md", "searchText": "operationId getSftpUser summary Retrieve details for a single SFTP user. description method get path /station/{station_id}/sftp-user/{id} tags 0 Stations: SFTP Users parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description SFTP User ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName SftpUser allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicKeys name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/sftp-user/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsftpuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getsftpuser/index.md" } ] }, { "id": "api/operations/editsftpuser/index.md", "kind": "operation", "title": "Update details of a single SFTP user.", "description": "PUT /station/{station_id}/sftp-user/{id}: takes SftpUser, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editsftpuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editsftpuser/index.md", "file": "api/operations/editsftpuser/index.md", "searchText": "operationId editSftpUser summary Update details of a single SFTP user. description method put path /station/{station_id}/sftp-user/{id} tags 0 Stations: SFTP Users parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description SFTP User ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName SftpUser allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicKeys name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/sftp-user/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editsftpuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editsftpuser/index.md" } ] }, { "id": "api/operations/deletesftpuser/index.md", "kind": "operation", "title": "Delete a single SFTP user.", "description": "DELETE /station/{station_id}/sftp-user/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletesftpuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletesftpuser/index.md", "file": "api/operations/deletesftpuser/index.md", "searchText": "operationId deleteSftpUser summary Delete a single SFTP user. description method delete path /station/{station_id}/sftp-user/{id} tags 0 Stations: SFTP Users parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description SFTP User ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/sftp-user/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletesftpuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletesftpuser/index.md" } ] }, { "id": "api/operations/getstereotoolconfiguration/index.md", "kind": "operation", "title": "Get the Stereo Tool configuration file for a station.", "description": "GET /station/{station_id}/stereo-tool-configuration: returns Api_UploadedRecordStatus.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstereotoolconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstereotoolconfiguration/index.md", "file": "api/operations/getstereotoolconfiguration/index.md", "searchText": "operationId getStereoToolConfiguration summary Get the Stereo Tool configuration file for a station. description method get path /station/{station_id}/stereo-tool-configuration tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_UploadedRecordStatus properties hasRecord name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 hasRecord 1 url example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/stereo-tool-configuration", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstereotoolconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstereotoolconfiguration/index.md" } ] }, { "id": "api/operations/poststereotoolconfiguration/index.md", "kind": "operation", "title": "Update the Stereo Tool configuration file for a station.", "description": "POST /station/{station_id}/stereo-tool-configuration: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststereotoolconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststereotoolconfiguration/index.md", "file": "api/operations/poststereotoolconfiguration/index.md", "searchText": "operationId postStereoToolConfiguration summary Update the Stereo Tool configuration file for a station. description method post path /station/{station_id}/stereo-tool-configuration tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/stereo-tool-configuration", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststereotoolconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststereotoolconfiguration/index.md" } ] }, { "id": "api/operations/deletestereotoolconfiguration/index.md", "kind": "operation", "title": "Removes the Stereo Tool configuration file for a station.", "description": "DELETE /station/{station_id}/stereo-tool-configuration: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestereotoolconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestereotoolconfiguration/index.md", "file": "api/operations/deletestereotoolconfiguration/index.md", "searchText": "operationId deleteStereoToolConfiguration summary Removes the Stereo Tool configuration file for a station. description method delete path /station/{station_id}/stereo-tool-configuration tags 0 Stations: Broadcasting parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/stereo-tool-configuration", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestereotoolconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestereotoolconfiguration/index.md" } ] }, { "id": "api/operations/getstreamerart/index.md", "kind": "operation", "title": "Gets the default album art for a streamer.", "description": "GET /station/{station_id}/streamer/{id}/art.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamerart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamerart/index.md", "file": "api/operations/getstreamerart/index.md", "searchText": "operationId getStreamerArt summary Gets the default album art for a streamer. description method get path /station/{station_id}/streamer/{id}/art tags 0 Public: Stations parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Streamer ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary image download. content image/* schema name type string format binary title description An image (album art, background, etc) in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 302 summary description A temporary redirect to the correct resource. content headers location name location in header description The current URL of the resource. required deprecated schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content links 2 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 4 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/streamer/{id}/art", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamerart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamerart/index.md" } ] }, { "id": "api/operations/poststreamerart/index.md", "kind": "operation", "title": "Sets the default album art for a streamer.", "description": "POST /station/{station_id}/streamer/{id}/art: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststreamerart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststreamerart/index.md", "file": "api/operations/poststreamerart/index.md", "searchText": "operationId postStreamerArt summary Sets the default album art for a streamer. description method post path /station/{station_id}/streamer/{id}/art tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Streamer ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content multipart/form-data schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties file name type string format binary title description The body of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/streamer/{id}/art", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststreamerart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststreamerart/index.md" } ] }, { "id": "api/operations/deletestreamerart/index.md", "kind": "operation", "title": "Removes the default album art for a streamer.", "description": "DELETE /station/{station_id}/streamer/{id}/art: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestreamerart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestreamerart/index.md", "file": "api/operations/deletestreamerart/index.md", "searchText": "operationId deleteStreamerArt summary Removes the default album art for a streamer. description method delete path /station/{station_id}/streamer/{id}/art tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Streamer ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/streamer/{id}/art", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestreamerart/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestreamerart/index.md" } ] }, { "id": "api/operations/poststationstreamerbroadcastsbatch/index.md", "kind": "operation", "title": "Perform batch actions on the specified broadcasts.", "description": "POST /station/{station_id}/streamer/{id}/broadcasts/batch: returns Api_GenericBatchResult.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationstreamerbroadcastsbatch/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationstreamerbroadcastsbatch/index.md", "file": "api/operations/poststationstreamerbroadcastsbatch/index.md", "searchText": "operationId postStationStreamerBroadcastsBatch summary Perform batch actions on the specified broadcasts. description method post path /station/{station_id}/streamer/{id}/broadcasts/batch tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Streamer ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties do name type string format title description The action to take with the specified rows. default enum 0 delete enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName rows name type array format title description The IDs to perform batch actions on. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_GenericBatchResult required 0 records allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_BatchResult properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errors name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 success 1 errors 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties records name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 title example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/streamer/{id}/broadcasts/batch", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationstreamerbroadcastsbatch/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationstreamerbroadcastsbatch/index.md" } ] }, { "id": "api/operations/getstationallbroadcasts/index.md", "kind": "operation", "title": "List all broadcasts associated with the station.", "description": "GET /station/{station_id}/streamers/broadcasts: returns a list of Api_StationStreamerBroadcast.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationallbroadcasts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationallbroadcasts/index.md", "file": "api/operations/getstationallbroadcasts/index.md", "searchText": "operationId getStationAllBroadcasts summary List all broadcasts associated with the station. description method get path /station/{station_id}/streamers/broadcasts tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamerBroadcast required 0 id 1 timestampStart 2 timestampEnd 3 streamer 4 recording allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timestampStart name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timestampEnd name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamer properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 streamer_username 2 display_name recording name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamerBroadcastRecording properties path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName downloadUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 path 1 size 2 downloadUrl example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/streamers/broadcasts", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationallbroadcasts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationallbroadcasts/index.md" } ] }, { "id": "api/operations/getstationstreamerbroadcasts/index.md", "kind": "operation", "title": "List all broadcasts associated with the specified streamer.", "description": "GET /station/{station_id}/streamer/{id}/broadcasts: returns a list of Api_StationStreamerBroadcast.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerbroadcasts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerbroadcasts/index.md", "file": "api/operations/getstationstreamerbroadcasts/index.md", "searchText": "operationId getStationStreamerBroadcasts summary List all broadcasts associated with the specified streamer. description method get path /station/{station_id}/streamer/{id}/broadcasts tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Streamer ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamerBroadcast required 0 id 1 timestampStart 2 timestampEnd 3 streamer 4 recording allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timestampStart name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timestampEnd name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamer properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 streamer_username 2 display_name recording name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamerBroadcastRecording properties path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName downloadUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 path 1 size 2 downloadUrl example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/streamer/{id}/broadcasts", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerbroadcasts/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerbroadcasts/index.md" } ] }, { "id": "api/operations/getstationstreamerdownloadbroadcast/index.md", "kind": "operation", "title": "Download a single broadcast from a streamer.", "description": "GET /station/{station_id}/streamer/{id}/broadcast/{broadcast_id}/download.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerdownloadbroadcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerdownloadbroadcast/index.md", "file": "api/operations/getstationstreamerdownloadbroadcast/index.md", "searchText": "operationId getStationStreamerDownloadBroadcast summary Download a single broadcast from a streamer. description method get path /station/{station_id}/streamer/{id}/broadcast/{broadcast_id}/download tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Streamer ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name broadcast_id in path description Broadcast ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description A successful response with a binary file download. content application/octet-stream schema name type string format binary title description A media (music, podcast, etc) download in binary format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/streamer/{id}/broadcast/{broadcast_id}/download", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerdownloadbroadcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerdownloadbroadcast/index.md" } ] }, { "id": "api/operations/getstationstreamerdeletebroadcast/index.md", "kind": "operation", "title": "Remove a single broadcast from a streamer.", "description": "DELETE /station/{station_id}/streamer/{id}/broadcast/{broadcast_id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerdeletebroadcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerdeletebroadcast/index.md", "file": "api/operations/getstationstreamerdeletebroadcast/index.md", "searchText": "operationId getStationStreamerDeleteBroadcast summary Remove a single broadcast from a streamer. description method delete path /station/{station_id}/streamer/{id}/broadcast/{broadcast_id} tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Streamer ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name broadcast_id in path description Broadcast ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/streamer/{id}/broadcast/{broadcast_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerdeletebroadcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamerdeletebroadcast/index.md" } ] }, { "id": "api/operations/getstreamers/index.md", "kind": "operation", "title": "List all current Streamer/DJ accounts for the specified station.", "description": "GET /station/{station_id}/streamers: returns a list of StationStreamer.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamers/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamers/index.md", "file": "api/operations/getstreamers/index.md", "searchText": "operationId getStreamers summary List all current Streamer/DJ accounts for the specified station. description method get path /station/{station_id}/streamers tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description Station streamers (DJ accounts) allowed to broadcast to a station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationStreamer allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties streamer_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example dj_test examples refName streamer_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName comments name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example This is a test DJ account. examples refName is_active name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enforce_schedule name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reactivate_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/streamers", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamers/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamers/index.md" } ] }, { "id": "api/operations/addstreamer/index.md", "kind": "operation", "title": "Create a new Streamer/DJ account.", "description": "POST /station/{station_id}/streamers: takes StationStreamer, returns StationStreamer.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addstreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addstreamer/index.md", "file": "api/operations/addstreamer/index.md", "searchText": "operationId addStreamer summary Create a new Streamer/DJ account. description method post path /station/{station_id}/streamers tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description Station streamers (DJ accounts) allowed to broadcast to a station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationStreamer allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties streamer_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example dj_test examples refName streamer_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName comments name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example This is a test DJ account. examples refName is_active name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enforce_schedule name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reactivate_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description Station streamers (DJ accounts) allowed to broadcast to a station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationStreamer allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties streamer_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example dj_test examples refName streamer_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName comments name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example This is a test DJ account. examples refName is_active name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enforce_schedule name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reactivate_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/streamers", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addstreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addstreamer/index.md" } ] }, { "id": "api/operations/getstreamer/index.md", "kind": "operation", "title": "Retrieve details for a single Streamer/DJ account.", "description": "GET /station/{station_id}/streamer/{id}: returns StationStreamer.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamer/index.md", "file": "api/operations/getstreamer/index.md", "searchText": "operationId getStreamer summary Retrieve details for a single Streamer/DJ account. description method get path /station/{station_id}/streamer/{id} tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Streamer ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description Station streamers (DJ accounts) allowed to broadcast to a station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationStreamer allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties streamer_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example dj_test examples refName streamer_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName comments name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example This is a test DJ account. examples refName is_active name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enforce_schedule name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reactivate_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/streamer/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstreamer/index.md" } ] }, { "id": "api/operations/editstreamer/index.md", "kind": "operation", "title": "Update details of a single Streamer/DJ account.", "description": "PUT /station/{station_id}/streamer/{id}: takes StationStreamer, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editstreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editstreamer/index.md", "file": "api/operations/editstreamer/index.md", "searchText": "operationId editStreamer summary Update details of a single Streamer/DJ account. description method put path /station/{station_id}/streamer/{id} tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Streamer ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description Station streamers (DJ accounts) allowed to broadcast to a station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationStreamer allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties streamer_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example dj_test examples refName streamer_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName comments name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example This is a test DJ account. examples refName is_active name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enforce_schedule name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reactivate_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/streamer/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editstreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editstreamer/index.md" } ] }, { "id": "api/operations/deletestreamer/index.md", "kind": "operation", "title": "Delete a single Streamer/DJ account.", "description": "DELETE /station/{station_id}/streamer/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestreamer/index.md", "file": "api/operations/deletestreamer/index.md", "searchText": "operationId deleteStreamer summary Delete a single Streamer/DJ account. description method delete path /station/{station_id}/streamer/{id} tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description StationStreamer ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/streamer/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletestreamer/index.md" } ] }, { "id": "api/operations/getstationstreamersschedule/index.md", "kind": "operation", "title": "Return calendar events for the station's streamer/DJ schedule.", "description": "GET /station/{station_id}/streamers/schedule: returns a list of Api_StationScheduleStreamerEvent.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamersschedule/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamersschedule/index.md", "file": "api/operations/getstationstreamersschedule/index.md", "searchText": "operationId getStationStreamersSchedule summary Return calendar events for the station's streamer/DJ schedule. description method get path /station/{station_id}/streamers/schedule tags 0 Stations: Streamers/DJs parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationScheduleStreamerEvent properties id name type integer format title description The unique identifier of the streamer. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName title name type string format title description The streamer display name representing the event title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Streamer examples refName type name type string format title description The type of this schedule event. default enum 0 streamer enumNames enumDescriptions const nullable readOnly writeOnly deprecated example streamer examples refName start name type string format title description The start time of this schedule event, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2020-02-19T03:00:00-06:00 examples refName end name type string format title description The end time of this schedule event, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2020-02-19T05:00:00-06:00 examples refName edit_url name type string format title description The API URL used to edit the underlying streamer. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /api/station/1/streamer/1 examples refName streamer_username name type string format title description The streamer login username. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example example_dj examples refName comments name type string format title description Comments about the streamer. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Live every weekday evening. examples refName has_custom_art name type boolean format title description Whether the streamer has custom artwork. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description The URL of the streamer artwork, if custom artwork is present. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /api/station/1/streamer/1/art/1.jpg examples refName required 0 id 1 title 2 type 3 start 4 end 5 edit_url 6 streamer_username 7 comments 8 has_custom_art 9 art example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/streamers/schedule", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamersschedule/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationstreamersschedule/index.md" } ] }, { "id": "api/operations/poststationnowplayingupdate/index.md", "kind": "operation", "title": "Manually update the Now Playing metadata for the station.", "description": "POST /station/{station_id}/nowplaying/update: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationnowplayingupdate/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationnowplayingupdate/index.md", "file": "api/operations/poststationnowplayingupdate/index.md", "searchText": "operationId postStationNowPlayingUpdate summary Manually update the Now Playing metadata for the station. description method post path /station/{station_id}/nowplaying/update tags 0 Stations: General parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/nowplaying/update", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationnowplayingupdate/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationnowplayingupdate/index.md" } ] }, { "id": "api/operations/getstationmediawaveform/index.md", "kind": "operation", "title": "Get waveform data for a media ID (for the Visual Cue Editor).", "description": "GET /station/{station_id}/waveform/{media_id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationmediawaveform/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationmediawaveform/index.md", "file": "api/operations/getstationmediawaveform/index.md", "searchText": "operationId getStationMediaWaveform summary Get waveform data for a media ID (for the Visual Cue Editor). description method get path /station/{station_id}/waveform/{media_id} tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Media ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/waveform/{media_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationmediawaveform/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getstationmediawaveform/index.md" } ] }, { "id": "api/operations/poststationmediawaveform/index.md", "kind": "operation", "title": "Save cached waveform data for a media ID (for the Visual Cue Editor).", "description": "POST /station/{station_id}/waveform/{media_id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationmediawaveform/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationmediawaveform/index.md", "file": "api/operations/poststationmediawaveform/index.md", "searchText": "operationId postStationMediaWaveform summary Save cached waveform data for a media ID (for the Visual Cue Editor). description method post path /station/{station_id}/waveform/{media_id} tags 0 Stations: Media parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Media ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/waveform/{media_id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationmediawaveform/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/poststationmediawaveform/index.md" } ] }, { "id": "api/operations/putstationwebhooktest/index.md", "kind": "operation", "title": "Send a test dispatch of a webhook with the current Now Playing data for the station.", "description": "PUT /station/{station_id}/webhook/{id}/test: returns Api_TaskWithLog.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationwebhooktest/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationwebhooktest/index.md", "file": "api/operations/putstationwebhooktest/index.md", "searchText": "operationId putStationWebhookTest summary Send a test dispatch of a webhook with the current Now Playing data for the station. description method put path /station/{station_id}/webhook/{id}/test tags 0 Stations: Web Hooks parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Web Hook ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_TaskWithLog properties logUrl name type string format uri title description The URL to view logs of the ongoing background task. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 logUrl example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/webhook/{id}/test", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationwebhooktest/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationwebhooktest/index.md" } ] }, { "id": "api/operations/getwebhooktestlog/index.md", "kind": "operation", "title": "View a specific webhook test dispatch log contents.", "description": "GET /station/{station_id}/webhooks/{id}/test-log/{path}: returns Api_LogContents.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhooktestlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhooktestlog/index.md", "file": "api/operations/getwebhooktestlog/index.md", "searchText": "operationId getWebhookTestLog summary View a specific webhook test dispatch log contents. description method get path /station/{station_id}/webhooks/{id}/test-log/{path} tags 0 Stations: Web Hooks parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Web Hook ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 2 name path in path description Log path as returned by the Test action. required deprecated style explode allowReserved schema name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogContents properties contents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName eof name type boolean format title description Whether the log file has ended at this point or has additional data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName position name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 contents 1 eof 2 position example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/webhooks/{id}/test-log/{path}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhooktestlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhooktestlog/index.md" } ] }, { "id": "api/operations/putstationwebhooktoggle/index.md", "kind": "operation", "title": "Toggle the enabled/disabled status of a webhook.", "description": "PUT /station/{station_id}/webhook/{id}/toggle: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationwebhooktoggle/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationwebhooktoggle/index.md", "file": "api/operations/putstationwebhooktoggle/index.md", "searchText": "operationId putStationWebhookToggle summary Toggle the enabled/disabled status of a webhook. description method put path /station/{station_id}/webhook/{id}/toggle tags 0 Stations: Web Hooks parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Web Hook ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/webhook/{id}/toggle", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationwebhooktoggle/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/putstationwebhooktoggle/index.md" } ] }, { "id": "api/operations/getwebhooks/index.md", "kind": "operation", "title": "List all current web hooks.", "description": "GET /station/{station_id}/webhooks: returns a list of StationWebhook.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhooks/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhooks/index.md", "file": "api/operations/getwebhooks/index.md", "searchText": "operationId getWebhooks summary List all current web hooks. description method get path /station/{station_id}/webhooks tags 0 Stations: Web Hooks parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationWebhook allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The nickname of the webhook connector. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Twitter Post examples refName type name type string format title description default enum 0 generic 1 email 2 tunein 3 radiode 4 radioreg 5 getmeradio 6 discord 7 telegram 8 groupme 9 mastodon 10 bluesky 11 google_analytics_v4 12 matomo_analytics 13 twitter 14 google_analytics enumNames 0 Generic 1 Email 2 TuneIn 3 RadioDe 4 RadioReg 5 GetMeRadio 6 Discord 7 Telegram 8 GroupMe 9 Mastodon 10 Bluesky 11 GoogleAnalyticsV4 12 MatomoAnalytics 13 Twitter 14 GoogleAnalyticsV3 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName WebhookTypes is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName triggers name type array format title description List of events that should trigger the webhook notification. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName config name type array format title description Detailed webhook configuration (if applicable) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName metadata name type array format title description Internal details used by the webhook to preserve state. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/webhooks", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhooks/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhooks/index.md" } ] }, { "id": "api/operations/addwebhook/index.md", "kind": "operation", "title": "Create a new web hook.", "description": "POST /station/{station_id}/webhooks: takes StationWebhook, returns StationWebhook.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addwebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addwebhook/index.md", "file": "api/operations/addwebhook/index.md", "searchText": "operationId addWebhook summary Create a new web hook. description method post path /station/{station_id}/webhooks tags 0 Stations: Web Hooks parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationWebhook allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The nickname of the webhook connector. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Twitter Post examples refName type name type string format title description default enum 0 generic 1 email 2 tunein 3 radiode 4 radioreg 5 getmeradio 6 discord 7 telegram 8 groupme 9 mastodon 10 bluesky 11 google_analytics_v4 12 matomo_analytics 13 twitter 14 google_analytics enumNames 0 Generic 1 Email 2 TuneIn 3 RadioDe 4 RadioReg 5 GetMeRadio 6 Discord 7 Telegram 8 GroupMe 9 Mastodon 10 Bluesky 11 GoogleAnalyticsV4 12 MatomoAnalytics 13 Twitter 14 GoogleAnalyticsV3 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName WebhookTypes is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName triggers name type array format title description List of events that should trigger the webhook notification. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName config name type array format title description Detailed webhook configuration (if applicable) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName metadata name type array format title description Internal details used by the webhook to preserve state. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationWebhook allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The nickname of the webhook connector. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Twitter Post examples refName type name type string format title description default enum enumNames 0 Generic 1 Email 2 TuneIn 3 RadioDe 4 RadioReg 5 GetMeRadio 6 Discord 7 Telegram 8 GroupMe 9 Mastodon 10 Bluesky 11 GoogleAnalyticsV4 12 MatomoAnalytics 13 Twitter 14 GoogleAnalyticsV3 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName WebhookTypes is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName triggers name type array format title description List of events that should trigger the webhook notification. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName config name type array format title description Detailed webhook configuration (if applicable) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName metadata name type array format title description Internal details used by the webhook to preserve state. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/webhooks", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/addwebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/addwebhook/index.md" } ] }, { "id": "api/operations/getwebhook/index.md", "kind": "operation", "title": "Retrieve details for a single web hook.", "description": "GET /station/{station_id}/webhook/{id}: returns StationWebhook.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhook/index.md", "file": "api/operations/getwebhook/index.md", "searchText": "operationId getWebhook summary Retrieve details for a single web hook. description method get path /station/{station_id}/webhook/{id} tags 0 Stations: Web Hooks parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Web Hook ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationWebhook allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The nickname of the webhook connector. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Twitter Post examples refName type name type string format title description default enum 0 generic 1 email 2 tunein 3 radiode 4 radioreg 5 getmeradio 6 discord 7 telegram 8 groupme 9 mastodon 10 bluesky 11 google_analytics_v4 12 matomo_analytics 13 twitter 14 google_analytics enumNames 0 Generic 1 Email 2 TuneIn 3 RadioDe 4 RadioReg 5 GetMeRadio 6 Discord 7 Telegram 8 GroupMe 9 Mastodon 10 Bluesky 11 GoogleAnalyticsV4 12 MatomoAnalytics 13 Twitter 14 GoogleAnalyticsV3 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName WebhookTypes is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName triggers name type array format title description List of events that should trigger the webhook notification. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName config name type array format title description Detailed webhook configuration (if applicable) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName metadata name type array format title description Internal details used by the webhook to preserve state. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "GET /station/{station_id}/webhook/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/getwebhook/index.md" } ] }, { "id": "api/operations/editwebhook/index.md", "kind": "operation", "title": "Update details of a single web hook.", "description": "PUT /station/{station_id}/webhook/{id}: takes StationWebhook, returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editwebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editwebhook/index.md", "file": "api/operations/editwebhook/index.md", "searchText": "operationId editWebhook summary Update details of a single web hook. description method put path /station/{station_id}/webhook/{id} tags 0 Stations: Web Hooks parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Web Hook ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody description required content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationWebhook allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The nickname of the webhook connector. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Twitter Post examples refName type name type string format title description default enum 0 generic 1 email 2 tunein 3 radiode 4 radioreg 5 getmeradio 6 discord 7 telegram 8 groupme 9 mastodon 10 bluesky 11 google_analytics_v4 12 matomo_analytics 13 twitter 14 google_analytics enumNames 0 Generic 1 Email 2 TuneIn 3 RadioDe 4 RadioReg 5 GetMeRadio 6 Discord 7 Telegram 8 GroupMe 9 Mastodon 10 Bluesky 11 GoogleAnalyticsV4 12 MatomoAnalytics 13 Twitter 14 GoogleAnalyticsV3 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName WebhookTypes is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName triggers name type array format title description List of events that should trigger the webhook notification. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName config name type array format title description Detailed webhook configuration (if applicable) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName metadata name type array format title description Internal details used by the webhook to preserve state. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "PUT /station/{station_id}/webhook/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/editwebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/editwebhook/index.md" } ] }, { "id": "api/operations/deletewebhook/index.md", "kind": "operation", "title": "Delete a single web hook.", "description": "DELETE /station/{station_id}/webhook/{id}: returns Api_Status.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletewebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletewebhook/index.md", "file": "api/operations/deletewebhook/index.md", "searchText": "operationId deleteWebhook summary Delete a single web hook. description method delete path /station/{station_id}/webhook/{id} tags 0 Stations: Web Hooks parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Web Hook ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "DELETE /station/{station_id}/webhook/{id}", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletewebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/deletewebhook/index.md" } ] }, { "id": "api/operations/clonewebhook/index.md", "kind": "operation", "title": "Duplicate a single web hook.", "description": "POST /station/{station_id}/webhook/{id}/clone: returns StationWebhook.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/clonewebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/clonewebhook/index.md", "file": "api/operations/clonewebhook/index.md", "searchText": "operationId cloneWebhook summary Duplicate a single web hook. description method post path /station/{station_id}/webhook/{id}/clone tags 0 Stations: Web Hooks parameters 0 name station_id in path description required deprecated style explode allowReserved schema name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format string title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples 1 name id in path description Web Hook ID required deprecated style explode allowReserved schema name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName content example examples requestBody responses 0 statusCode 200 summary description Success content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationWebhook allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The nickname of the webhook connector. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Twitter Post examples refName type name type string format title description default enum 0 generic 1 email 2 tunein 3 radiode 4 radioreg 5 getmeradio 6 discord 7 telegram 8 groupme 9 mastodon 10 bluesky 11 google_analytics_v4 12 matomo_analytics 13 twitter 14 google_analytics enumNames 0 Generic 1 Email 2 TuneIn 3 RadioDe 4 RadioReg 5 GetMeRadio 6 Discord 7 Telegram 8 GroupMe 9 Mastodon 10 Bluesky 11 GoogleAnalyticsV4 12 MatomoAnalytics 13 Twitter 14 GoogleAnalyticsV3 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName WebhookTypes is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName triggers name type array format title description List of events that should trigger the webhook notification. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName config name type array format title description Detailed webhook configuration (if applicable) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName metadata name type array format title description Internal details used by the webhook to preserve state. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName example examples encoding prefixEncoding itemEncoding headers links 1 statusCode 403 summary description Access denied. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 2 statusCode 404 summary description Record not found. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links 3 statusCode 500 summary description A generic exception has occurred. content application/json schema name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success example examples encoding prefixEncoding itemEncoding headers links security 0 ApiKey deprecated servers externalDocs callbacks hidden codeSamples ", "documentId": "POST /station/{station_id}/webhook/{id}/clone", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/operations/clonewebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/operations/clonewebhook/index.md" } ] }, { "id": "api/models/api-account-changepassword/index.md", "kind": "schema", "title": "Api_Account_ChangePassword", "description": "Fields: current_password and new_password.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-changepassword/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-changepassword/index.md", "file": "api/models/api-account-changepassword/index.md", "searchText": "name Api_Account_ChangePassword type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Account_ChangePassword properties current_password name type string format title description The current account password. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName new_password name type string format title description The new account password. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 current_password 1 new_password", "documentId": "schema:Api_Account_ChangePassword", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-changepassword/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-changepassword/index.md" } ] }, { "id": "api/models/api-account-newapikey/index.md", "kind": "schema", "title": "Api_Account_NewApiKey", "description": "Field: key.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-newapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-newapikey/index.md", "file": "api/models/api-account-newapikey/index.md", "searchText": "name Api_Account_NewApiKey type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Account_NewApiKey properties key name type string format title description The newly generated API key. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 key", "documentId": "schema:Api_Account_NewApiKey", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-newapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-newapikey/index.md" } ] }, { "id": "api/models/api-account-twofactorstatus/index.md", "kind": "schema", "title": "Api_Account_TwoFactorStatus", "description": "Field: two_factor_enabled.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-twofactorstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-twofactorstatus/index.md", "file": "api/models/api-account-twofactorstatus/index.md", "searchText": "name Api_Account_TwoFactorStatus type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Account_TwoFactorStatus properties two_factor_enabled name type boolean format title description The current two-factor status for this account. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 two_factor_enabled", "documentId": "schema:Api_Account_TwoFactorStatus", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-twofactorstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-account-twofactorstatus/index.md" } ] }, { "id": "api/models/api-admin-auditlogchangeset/index.md", "kind": "schema", "title": "Api_Admin_AuditLogChangeset", "description": "Fields: field, from and to.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-auditlogchangeset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-auditlogchangeset/index.md", "file": "api/models/api-admin-auditlogchangeset/index.md", "searchText": "name Api_Admin_AuditLogChangeset type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_AuditLogChangeset properties field name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName from name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName to name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 field 1 from 2 to", "documentId": "schema:Api_Admin_AuditLogChangeset", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-auditlogchangeset/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-auditlogchangeset/index.md" } ] }, { "id": "api/models/api-admin-backup/index.md", "kind": "schema", "title": "Api_Admin_Backup", "description": "Api_Admin_Backup", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-backup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-backup/index.md", "file": "api/models/api-admin-backup/index.md", "searchText": "name Api_Admin_Backup type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Backup required 0 path 1 basename 2 pathEncoded 3 timestamp 4 size 5 storageLocationId allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName basename name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName pathEncoded name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timestamp name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storageLocationId name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_Admin_Backup", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-backup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-backup/index.md" } ] }, { "id": "api/models/api-admin-debug-queue/index.md", "kind": "schema", "title": "Api_Admin_Debug_Queue", "description": "Fields: name, count and url.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-queue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-queue/index.md", "file": "api/models/api-admin-debug-queue/index.md", "searchText": "name Api_Admin_Debug_Queue type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_Queue properties name name type string format title description default enum 0 high_priority 1 normal_priority 2 low_priority 3 search_index 4 media 5 podcast_media enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 name 1 count 2 url", "documentId": "schema:Api_Admin_Debug_Queue", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-queue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-queue/index.md" } ] }, { "id": "api/models/api-admin-debug-station/index.md", "kind": "schema", "title": "Api_Admin_Debug_Station", "description": "Fields: id, name, clearQueueUrl, getNextSongUrl and getNowPlayingUrl.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-station/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-station/index.md", "file": "api/models/api-admin-debug-station/index.md", "searchText": "name Api_Admin_Debug_Station type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_Station properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName clearQueueUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName getNextSongUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName getNowPlayingUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name 2 clearQueueUrl 3 getNextSongUrl 4 getNowPlayingUrl", "documentId": "schema:Api_Admin_Debug_Station", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-station/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-station/index.md" } ] }, { "id": "api/models/api-admin-debug-logentry/index.md", "kind": "schema", "title": "Api_Admin_Debug_LogEntry", "description": "Fields: datetime, channel, level, message, context, extra and 1 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-logentry/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-logentry/index.md", "file": "api/models/api-admin-debug-logentry/index.md", "searchText": "name Api_Admin_Debug_LogEntry type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogEntry properties datetime name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName channel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName level name type integer format title description default enum 0 100 1 200 2 250 3 300 4 400 5 500 6 550 7 600 enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName context name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName extra name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName formatted name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 datetime 1 channel 2 level 3 message 4 context 5 extra 6 formatted", "documentId": "schema:Api_Admin_Debug_LogEntry", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-logentry/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-logentry/index.md" } ] }, { "id": "api/models/api-admin-debug-logresult/index.md", "kind": "schema", "title": "Api_Admin_Debug_LogResult", "description": "Field: logs.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-logresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-logresult/index.md", "file": "api/models/api-admin-debug-logresult/index.md", "searchText": "name Api_Admin_Debug_LogResult type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogResult properties logs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_LogEntry properties datetime name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName channel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName level name type integer format title description default enum 0 100 1 200 2 250 3 300 4 400 5 500 6 550 7 600 enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName context name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName extra name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName formatted name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 datetime 1 channel 2 level 3 message 4 context 5 extra 6 formatted required 0 logs", "documentId": "schema:Api_Admin_Debug_LogResult", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-logresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-logresult/index.md" } ] }, { "id": "api/models/api-admin-debug-synctask/index.md", "kind": "schema", "title": "Api_Admin_Debug_SyncTask", "description": "Fields: task, pattern, time, nextRun and url.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-synctask/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-synctask/index.md", "file": "api/models/api-admin-debug-synctask/index.md", "searchText": "name Api_Admin_Debug_SyncTask type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Debug_SyncTask properties task name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName pattern name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName time name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName nextRun name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 task 1 pattern 2 time 3 nextRun 4 url", "documentId": "schema:Api_Admin_Debug_SyncTask", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-synctask/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-debug-synctask/index.md" } ] }, { "id": "api/models/api-admin-geolitestatus/index.md", "kind": "schema", "title": "Api_Admin_GeoLiteStatus", "description": "Fields: version and key.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-geolitestatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-geolitestatus/index.md", "file": "api/models/api-admin-geolitestatus/index.md", "searchText": "name Api_Admin_GeoLiteStatus type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_GeoLiteStatus properties version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 version 1 key", "documentId": "schema:Api_Admin_GeoLiteStatus", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-geolitestatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-geolitestatus/index.md" } ] }, { "id": "api/models/api-admin-loglist/index.md", "kind": "schema", "title": "Api_Admin_LogList", "description": "Fields: globalLogs and stationLogs.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-loglist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-loglist/index.md", "file": "api/models/api-admin-loglist/index.md", "searchText": "name Api_Admin_LogList type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_LogList properties globalLogs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogType required 0 key 1 name 2 path 3 tail allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName tail name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stationLogs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_StationLogList properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName logs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogType required 0 key 1 name 2 path 3 tail allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName tail name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name 2 logs required 0 globalLogs 1 stationLogs", "documentId": "schema:Api_Admin_LogList", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-loglist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-loglist/index.md" } ] }, { "id": "api/models/api-admin-newapikey/index.md", "kind": "schema", "title": "Api_Admin_NewApiKey", "description": "Fields: user and comment.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newapikey/index.md", "file": "api/models/api-admin-newapikey/index.md", "searchText": "name Api_Admin_NewApiKey type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_NewApiKey properties user name type format title description User ID or e-mail address. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Admin-generated API key examples refName required 0 user", "documentId": "schema:Api_Admin_NewApiKey", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newapikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newapikey/index.md" } ] }, { "id": "api/models/api-admin-newlogintoken/index.md", "kind": "schema", "title": "Api_Admin_NewLoginToken", "description": "Fields: user, type, comment and expires_minutes.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newlogintoken/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newlogintoken/index.md", "file": "api/models/api-admin-newlogintoken/index.md", "searchText": "name Api_Admin_NewLoginToken type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_NewLoginToken properties user name type format title description User ID or e-mail address. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 reset_password 1 login enumNames 0 ResetPassword 1 Login enumDescriptions const nullable readOnly writeOnly deprecated example examples refName LoginTokenTypes comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example SSO Login examples refName expires_minutes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 user", "documentId": "schema:Api_Admin_NewLoginToken", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newlogintoken/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newlogintoken/index.md" } ] }, { "id": "api/models/api-admin-newlogintokenresponse/index.md", "kind": "schema", "title": "Api_Admin_NewLoginTokenResponse", "description": "Fields: success, message, formatted_message, record and links.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newlogintokenresponse/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newlogintokenresponse/index.md", "file": "api/models/api-admin-newlogintokenresponse/index.md", "searchText": "name Api_Admin_NewLoginTokenResponse type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_NewLoginTokenResponse properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName record name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName UserLoginToken allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 reset_password 1 login enumNames 0 ResetPassword 1 Login enumDescriptions const nullable readOnly writeOnly deprecated example examples refName LoginTokenTypes comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example SSO Login examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1640998800 examples refName expires_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1640998800 examples refName links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 success 1 message 2 formatted_message 3 record 4 links", "documentId": "schema:Api_Admin_NewLoginTokenResponse", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newlogintokenresponse/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-newlogintokenresponse/index.md" } ] }, { "id": "api/models/api-admin-permission/index.md", "kind": "schema", "title": "Api_Admin_Permission", "description": "Fields: id and name.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-permission/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-permission/index.md", "file": "api/models/api-admin-permission/index.md", "searchText": "name Api_Admin_Permission type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Permission properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name", "documentId": "schema:Api_Admin_Permission", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-permission/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-permission/index.md" } ] }, { "id": "api/models/api-admin-permissions/index.md", "kind": "schema", "title": "Api_Admin_Permissions", "description": "Fields: global and station.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-permissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-permissions/index.md", "file": "api/models/api-admin-permissions/index.md", "searchText": "name Api_Admin_Permissions type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Permissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Permission properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Permission properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name required 0 global 1 station", "documentId": "schema:Api_Admin_Permissions", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-permissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-permissions/index.md" } ] }, { "id": "api/models/api-admin-relay/index.md", "kind": "schema", "title": "Api_Admin_Relay", "description": "Fields: id, name, shortcode, description, url, genre and 5 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-relay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-relay/index.md", "file": "api/models/api-admin-relay/index.md", "searchText": "name Api_Admin_Relay type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Relay properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName url name type string format title description Station homepage URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://www.azuracast.com/ examples refName genre name type string format title description The genre of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Variety examples refName type name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName port name type integer format title description The port used by this station to serve its broadcasts. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 8000 examples refName relay_pw name type string format title description The relay password for the frontend (if applicable). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example p4ssw0rd examples refName admin_pw name type string format title description The administrator password for the frontend (if applicable). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example p4ssw0rd examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_Admin_Relay", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-relay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-relay/index.md" } ] }, { "id": "api/models/api-admin-role/index.md", "kind": "schema", "title": "Api_Admin_Role", "description": "Api_Admin_Role", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-role/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-role/index.md", "file": "api/models/api-admin-role/index.md", "searchText": "name Api_Admin_Role type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Role required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Super Administrator examples refName permissions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RolePermissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view administration 2 view system logs 3 administer settings 4 administer api keys 5 administer stations 6 administer custom fields 7 administer backups 8 administer storage locations enumNames 0 All 1 View 2 Logs 3 Settings 4 ApiKeys 5 Stations 6 CustomFields 7 Backups 8 StorageLocations enumDescriptions const nullable readOnly writeOnly deprecated example examples refName GlobalPermissions station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RoleStationPermission properties id name type integer format title description The station ID. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view station management 2 view station reports 3 view station logs 4 manage station profile 5 manage station broadcasting 6 manage station streamers 7 manage station mounts 8 manage station remotes 9 manage station media 10 delete station media 11 manage station automation 12 manage station web hooks 13 manage station podcasts enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions required 0 id 1 permissions required 0 global 1 station is_super_admin name type boolean format title description Whether this role is the protected \"Super Administrator\" role. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_Admin_Role", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-role/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-role/index.md" } ] }, { "id": "api/models/api-admin-rolepermissions/index.md", "kind": "schema", "title": "Api_Admin_RolePermissions", "description": "Fields: global and station.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rolepermissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rolepermissions/index.md", "file": "api/models/api-admin-rolepermissions/index.md", "searchText": "name Api_Admin_RolePermissions type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RolePermissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view administration 2 view system logs 3 administer settings 4 administer api keys 5 administer stations 6 administer custom fields 7 administer backups 8 administer storage locations enumNames 0 All 1 View 2 Logs 3 Settings 4 ApiKeys 5 Stations 6 CustomFields 7 Backups 8 StorageLocations enumDescriptions const nullable readOnly writeOnly deprecated example examples refName GlobalPermissions station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RoleStationPermission properties id name type integer format title description The station ID. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view station management 2 view station reports 3 view station logs 4 manage station profile 5 manage station broadcasting 6 manage station streamers 7 manage station mounts 8 manage station remotes 9 manage station media 10 delete station media 11 manage station automation 12 manage station web hooks 13 manage station podcasts enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions required 0 id 1 permissions required 0 global 1 station", "documentId": "schema:Api_Admin_RolePermissions", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rolepermissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rolepermissions/index.md" } ] }, { "id": "api/models/api-admin-rolestationpermission/index.md", "kind": "schema", "title": "Api_Admin_RoleStationPermission", "description": "Fields: id and permissions.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rolestationpermission/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rolestationpermission/index.md", "file": "api/models/api-admin-rolestationpermission/index.md", "searchText": "name Api_Admin_RoleStationPermission type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RoleStationPermission properties id name type integer format title description The station ID. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view station management 2 view station reports 3 view station logs 4 manage station profile 5 manage station broadcasting 6 manage station streamers 7 manage station mounts 8 manage station remotes 9 manage station media 10 delete station media 11 manage station automation 12 manage station web hooks 13 manage station podcasts enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions required 0 id 1 permissions", "documentId": "schema:Api_Admin_RoleStationPermission", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rolestationpermission/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rolestationpermission/index.md" } ] }, { "id": "api/models/api-admin-rsasstatus/index.md", "kind": "schema", "title": "Api_Admin_RsasStatus", "description": "Fields: version and hasLicense.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rsasstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rsasstatus/index.md", "file": "api/models/api-admin-rsasstatus/index.md", "searchText": "name Api_Admin_RsasStatus type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RsasStatus properties version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hasLicense name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 version 1 hasLicense", "documentId": "schema:Api_Admin_RsasStatus", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rsasstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-rsasstatus/index.md" } ] }, { "id": "api/models/api-admin-serverstats-cpustats/index.md", "kind": "schema", "title": "Api_Admin_ServerStats_CpuStats", "description": "Fields: total, cores and load.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-cpustats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-cpustats/index.md", "file": "api/models/api-admin-serverstats-cpustats/index.md", "searchText": "name Api_Admin_ServerStats_CpuStats type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_CpuStats properties total name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_CpuStatsSection properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName usage name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName idle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName io_wait name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName steal name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 name 1 usage 2 idle 3 io_wait 4 steal cores name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_CpuStatsSection properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName usage name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName idle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName io_wait name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName steal name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 name 1 usage 2 idle 3 io_wait 4 steal load name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total 1 cores 2 load", "documentId": "schema:Api_Admin_ServerStats_CpuStats", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-cpustats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-cpustats/index.md" } ] }, { "id": "api/models/api-admin-serverstats-cpustatssection/index.md", "kind": "schema", "title": "Api_Admin_ServerStats_CpuStatsSection", "description": "Fields: name, usage, idle, io_wait and steal.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-cpustatssection/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-cpustatssection/index.md", "file": "api/models/api-admin-serverstats-cpustatssection/index.md", "searchText": "name Api_Admin_ServerStats_CpuStatsSection type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_CpuStatsSection properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName usage name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName idle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName io_wait name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName steal name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 name 1 usage 2 idle 3 io_wait 4 steal", "documentId": "schema:Api_Admin_ServerStats_CpuStatsSection", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-cpustatssection/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-cpustatssection/index.md" } ] }, { "id": "api/models/api-admin-serverstats-memorystats/index.md", "kind": "schema", "title": "Api_Admin_ServerStats_MemoryStats", "description": "Fields: total_bytes, total_readable, free_bytes, free_readable, buffers_bytes, buffers_readable and 8 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-memorystats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-memorystats/index.md", "file": "api/models/api-admin-serverstats-memorystats/index.md", "searchText": "name Api_Admin_ServerStats_MemoryStats type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_MemoryStats properties total_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName total_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName buffers_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName buffers_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName cached_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName cached_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sReclaimable_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sReclaimable_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName shmem_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName shmem_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total_bytes 1 total_readable 2 free_bytes 3 free_readable 4 buffers_bytes 5 buffers_readable 6 cached_bytes 7 cached_readable 8 sReclaimable_bytes 9 sReclaimable_readable 10 shmem_bytes 11 shmem_readable 12 used_bytes 13 used_readable", "documentId": "schema:Api_Admin_ServerStats_MemoryStats", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-memorystats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-memorystats/index.md" } ] }, { "id": "api/models/api-admin-serverstats-networkinterfacereceived/index.md", "kind": "schema", "title": "Api_Admin_ServerStats_NetworkInterfaceReceived", "description": "Fields: speed_bytes, speed_readable, packets, errs, drop, fifo and 3 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacereceived/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacereceived/index.md", "file": "api/models/api-admin-serverstats-networkinterfacereceived/index.md", "searchText": "name Api_Admin_ServerStats_NetworkInterfaceReceived type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceReceived properties speed_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName speed_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName packets name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errs name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName drop name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fifo name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frame name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName compressed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName multicast name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 speed_bytes 1 speed_readable 2 packets 3 errs 4 drop 5 fifo 6 frame 7 compressed 8 multicast", "documentId": "schema:Api_Admin_ServerStats_NetworkInterfaceReceived", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacereceived/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacereceived/index.md" } ] }, { "id": "api/models/api-admin-serverstats-networkinterfacestats/index.md", "kind": "schema", "title": "Api_Admin_ServerStats_NetworkInterfaceStats", "description": "Fields: interface_name, received and transmitted.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacestats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacestats/index.md", "file": "api/models/api-admin-serverstats-networkinterfacestats/index.md", "searchText": "name Api_Admin_ServerStats_NetworkInterfaceStats type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceStats properties interface_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName received name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceReceived properties speed_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName speed_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName packets name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errs name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName drop name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fifo name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frame name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName compressed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName multicast name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 speed_bytes 1 speed_readable 2 packets 3 errs 4 drop 5 fifo 6 frame 7 compressed 8 multicast transmitted name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceTransmitted properties speed_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName speed_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName packets name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errs name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName drop name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fifo name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frame name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName carrier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName compressed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 speed_bytes 1 speed_readable 2 packets 3 errs 4 drop 5 fifo 6 frame 7 carrier 8 compressed required 0 interface_name 1 received 2 transmitted", "documentId": "schema:Api_Admin_ServerStats_NetworkInterfaceStats", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacestats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacestats/index.md" } ] }, { "id": "api/models/api-admin-serverstats-networkinterfacetransmitted/index.md", "kind": "schema", "title": "Api_Admin_ServerStats_NetworkInterfaceTransmitted", "description": "Fields: speed_bytes, speed_readable, packets, errs, drop, fifo and 3 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacetransmitted/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacetransmitted/index.md", "file": "api/models/api-admin-serverstats-networkinterfacetransmitted/index.md", "searchText": "name Api_Admin_ServerStats_NetworkInterfaceTransmitted type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceTransmitted properties speed_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName speed_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName packets name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errs name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName drop name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fifo name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frame name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName carrier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName compressed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 speed_bytes 1 speed_readable 2 packets 3 errs 4 drop 5 fifo 6 frame 7 carrier 8 compressed", "documentId": "schema:Api_Admin_ServerStats_NetworkInterfaceTransmitted", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacetransmitted/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-networkinterfacetransmitted/index.md" } ] }, { "id": "api/models/api-admin-serverstats/index.md", "kind": "schema", "title": "Api_Admin_ServerStats", "description": "Fields: cpu, memory, swap, disk and network.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats/index.md", "file": "api/models/api-admin-serverstats/index.md", "searchText": "name Api_Admin_ServerStats type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats properties cpu name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_CpuStats properties total name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_CpuStatsSection properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName usage name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName idle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName io_wait name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName steal name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 name 1 usage 2 idle 3 io_wait 4 steal cores name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_CpuStatsSection properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName usage name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName idle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName io_wait name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName steal name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 name 1 usage 2 idle 3 io_wait 4 steal load name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total 1 cores 2 load memory name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_MemoryStats properties total_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName total_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName buffers_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName buffers_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName cached_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName cached_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sReclaimable_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sReclaimable_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName shmem_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName shmem_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total_bytes 1 total_readable 2 free_bytes 3 free_readable 4 buffers_bytes 5 buffers_readable 6 cached_bytes 7 cached_readable 8 sReclaimable_bytes 9 sReclaimable_readable 10 shmem_bytes 11 shmem_readable 12 used_bytes 13 used_readable swap name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_StorageStats properties total_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName total_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total_bytes 1 total_readable 2 free_bytes 3 free_readable 4 used_bytes 5 used_readable disk name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_StorageStats properties total_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName total_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total_bytes 1 total_readable 2 free_bytes 3 free_readable 4 used_bytes 5 used_readable network name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceStats properties interface_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName received name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceReceived properties speed_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName speed_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName packets name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errs name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName drop name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fifo name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frame name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName compressed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName multicast name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 speed_bytes 1 speed_readable 2 packets 3 errs 4 drop 5 fifo 6 frame 7 compressed 8 multicast transmitted name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_NetworkInterfaceTransmitted properties speed_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName speed_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName packets name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errs name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName drop name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fifo name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frame name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName carrier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName compressed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 speed_bytes 1 speed_readable 2 packets 3 errs 4 drop 5 fifo 6 frame 7 carrier 8 compressed required 0 interface_name 1 received 2 transmitted required 0 cpu 1 memory 2 swap 3 disk 4 network", "documentId": "schema:Api_Admin_ServerStats", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats/index.md" } ] }, { "id": "api/models/api-admin-serverstats-storagestats/index.md", "kind": "schema", "title": "Api_Admin_ServerStats_StorageStats", "description": "Fields: total_bytes, total_readable, free_bytes, free_readable, used_bytes and used_readable.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-storagestats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-storagestats/index.md", "file": "api/models/api-admin-serverstats-storagestats/index.md", "searchText": "name Api_Admin_ServerStats_StorageStats type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServerStats_StorageStats properties total_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName total_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName free_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_readable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 total_bytes 1 total_readable 2 free_bytes 3 free_readable 4 used_bytes 5 used_readable", "documentId": "schema:Api_Admin_ServerStats_StorageStats", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-storagestats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-serverstats-storagestats/index.md" } ] }, { "id": "api/models/api-admin-servicedata/index.md", "kind": "schema", "title": "Api_Admin_ServiceData", "description": "Api_Admin_ServiceData", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-servicedata/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-servicedata/index.md", "file": "api/models/api-admin-servicedata/index.md", "searchText": "name Api_Admin_ServiceData type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ServiceData required 0 name 1 description 2 running allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName running name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_Admin_ServiceData", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-servicedata/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-servicedata/index.md" } ] }, { "id": "api/models/api-admin-shoutcaststatus/index.md", "kind": "schema", "title": "Api_Admin_ShoutcastStatus", "description": "Field: version.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-shoutcaststatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-shoutcaststatus/index.md", "file": "api/models/api-admin-shoutcaststatus/index.md", "searchText": "name Api_Admin_ShoutcastStatus type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_ShoutcastStatus properties version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 version", "documentId": "schema:Api_Admin_ShoutcastStatus", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-shoutcaststatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-shoutcaststatus/index.md" } ] }, { "id": "api/models/api-admin-stationloglist/index.md", "kind": "schema", "title": "Api_Admin_StationLogList", "description": "Fields: id, name and logs.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-stationloglist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-stationloglist/index.md", "file": "api/models/api-admin-stationloglist/index.md", "searchText": "name Api_Admin_StationLogList type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_StationLogList properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName logs name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogType required 0 key 1 name 2 path 3 tail allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName tail name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name 2 logs", "documentId": "schema:Api_Admin_StationLogList", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-stationloglist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-stationloglist/index.md" } ] }, { "id": "api/models/api-admin-stereotoolstatus/index.md", "kind": "schema", "title": "Api_Admin_StereoToolStatus", "description": "Field: version.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-stereotoolstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-stereotoolstatus/index.md", "file": "api/models/api-admin-stereotoolstatus/index.md", "searchText": "name Api_Admin_StereoToolStatus type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_StereoToolStatus properties version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 version", "documentId": "schema:Api_Admin_StereoToolStatus", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-stereotoolstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-stereotoolstatus/index.md" } ] }, { "id": "api/models/api-admin-storagelocation/index.md", "kind": "schema", "title": "Api_Admin_StorageLocation", "description": "Api_Admin_StorageLocation", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-storagelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-storagelocation/index.md", "file": "api/models/api-admin-storagelocation/index.md", "searchText": "name Api_Admin_StorageLocation type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_StorageLocation allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties storageUsedPercent name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 75 examples refName isFull name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName uri name type string format title description The URI associated with the storage location. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/www examples refName stations name type array format title description The stations using this storage location, if any. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName ", "documentId": "schema:Api_Admin_StorageLocation", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-storagelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-storagelocation/index.md" } ] }, { "id": "api/models/api-admin-updatedetails/index.md", "kind": "schema", "title": "Api_Admin_UpdateDetails", "description": "Fields: current_release, latest_release, needs_rolling_update, needs_release_update, rolling_updates_available and can_switch_to_stable.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-updatedetails/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-updatedetails/index.md", "file": "api/models/api-admin-updatedetails/index.md", "searchText": "name Api_Admin_UpdateDetails type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_UpdateDetails properties current_release name type string format title description The stable-equivalent branch your installation currently appears to be on. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.3 examples refName latest_release name type string format title description The current latest stable release of the software. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.4 examples refName needs_rolling_update name type boolean format title description If you are on the Rolling Release, whether your installation needs to be updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName needs_release_update name type boolean format title description Whether a newer stable release is available than the version you are currently using. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName rolling_updates_available name type integer format title description If you are on the Rolling Release, the number of updates released since your version. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName can_switch_to_stable name type boolean format title description Whether you can seamlessly move from the Rolling Release channel to Stable without issues. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_Admin_UpdateDetails", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-updatedetails/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-updatedetails/index.md" } ] }, { "id": "api/models/api-admin-userwithdetails/index.md", "kind": "schema", "title": "Api_Admin_UserWithDetails", "description": "Api_Admin_UserWithDetails", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-userwithdetails/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-userwithdetails/index.md", "file": "api/models/api-admin-userwithdetails/index.md", "searchText": "name Api_Admin_UserWithDetails type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_UserWithDetails required 0 is_me allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties is_me name type boolean format title description Whether this user record represents the currently logged-in user. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_Admin_UserWithDetails", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-userwithdetails/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-userwithdetails/index.md" } ] }, { "id": "api/models/api-admin-vue-backupprops/index.md", "kind": "schema", "title": "Api_Admin_Vue_BackupProps", "description": "Fields: isDocker and storageLocations.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-backupprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-backupprops/index.md", "file": "api/models/api-admin-vue-backupprops/index.md", "searchText": "name Api_Admin_Vue_BackupProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties isDocker name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storageLocations name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 isDocker 1 storageLocations", "documentId": "schema:Api_Admin_Vue_BackupProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-backupprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-backupprops/index.md" } ] }, { "id": "api/models/api-admin-vue-customfieldprops/index.md", "kind": "schema", "title": "Api_Admin_Vue_CustomFieldProps", "description": "Field: autoAssignTypes.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-customfieldprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-customfieldprops/index.md", "file": "api/models/api-admin-vue-customfieldprops/index.md", "searchText": "name Api_Admin_Vue_CustomFieldProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties autoAssignTypes name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 autoAssignTypes", "documentId": "schema:Api_Admin_Vue_CustomFieldProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-customfieldprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-customfieldprops/index.md" } ] }, { "id": "api/models/api-admin-vue-permissionsprops/index.md", "kind": "schema", "title": "Api_Admin_Vue_PermissionsProps", "description": "Fields: stations, globalPermissions and stationPermissions.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-permissionsprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-permissionsprops/index.md", "file": "api/models/api-admin-vue-permissionsprops/index.md", "searchText": "name Api_Admin_Vue_PermissionsProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties stations name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName globalPermissions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stationPermissions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 stations 1 globalPermissions 2 stationPermissions", "documentId": "schema:Api_Admin_Vue_PermissionsProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-permissionsprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-permissionsprops/index.md" } ] }, { "id": "api/models/api-admin-vue-settingsprops/index.md", "kind": "schema", "title": "Api_Admin_Vue_SettingsProps", "description": "Field: releaseChannel.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-settingsprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-settingsprops/index.md", "file": "api/models/api-admin-vue-settingsprops/index.md", "searchText": "name Api_Admin_Vue_SettingsProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties releaseChannel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 releaseChannel", "documentId": "schema:Api_Admin_Vue_SettingsProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-settingsprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-settingsprops/index.md" } ] }, { "id": "api/models/api-admin-vue-stationsformprops/index.md", "kind": "schema", "title": "Api_Admin_Vue_StationsFormProps", "description": "Fields: timezones, countries, isRsasInstalled, isShoutcastInstalled and isStereoToolInstalled.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-stationsformprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-stationsformprops/index.md", "file": "api/models/api-admin-vue-stationsformprops/index.md", "searchText": "name Api_Admin_Vue_StationsFormProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Vue_StationsFormProps properties timezones name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName countries name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName isRsasInstalled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName isShoutcastInstalled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName isStereoToolInstalled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 timezones 1 countries 2 isRsasInstalled 3 isShoutcastInstalled 4 isStereoToolInstalled", "documentId": "schema:Api_Admin_Vue_StationsFormProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-stationsformprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-stationsformprops/index.md" } ] }, { "id": "api/models/api-admin-vue-stationsprops/index.md", "kind": "schema", "title": "Api_Admin_Vue_StationsProps", "description": "Fields: formProps, frontendTypes and backendTypes.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-stationsprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-stationsprops/index.md", "file": "api/models/api-admin-vue-stationsprops/index.md", "searchText": "name Api_Admin_Vue_StationsProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties formProps name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_Vue_StationsFormProps properties timezones name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName countries name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName isRsasInstalled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName isShoutcastInstalled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName isStereoToolInstalled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 timezones 1 countries 2 isRsasInstalled 3 isShoutcastInstalled 4 isStereoToolInstalled frontendTypes name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backendTypes name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 formProps 1 frontendTypes 2 backendTypes", "documentId": "schema:Api_Admin_Vue_StationsProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-stationsprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-stationsprops/index.md" } ] }, { "id": "api/models/api-admin-vue-updateprops/index.md", "kind": "schema", "title": "Api_Admin_Vue_UpdateProps", "description": "Fields: releaseChannel, enableWebUpdates and initialUpdateInfo.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-updateprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-updateprops/index.md", "file": "api/models/api-admin-vue-updateprops/index.md", "searchText": "name Api_Admin_Vue_UpdateProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties releaseChannel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enableWebUpdates name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName initialUpdateInfo name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_UpdateDetails properties current_release name type string format title description The stable-equivalent branch your installation currently appears to be on. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.3 examples refName latest_release name type string format title description The current latest stable release of the software. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.4 examples refName needs_rolling_update name type boolean format title description If you are on the Rolling Release, whether your installation needs to be updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName needs_release_update name type boolean format title description Whether a newer stable release is available than the version you are currently using. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName rolling_updates_available name type integer format title description If you are on the Rolling Release, the number of updates released since your version. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName can_switch_to_stable name type boolean format title description Whether you can seamlessly move from the Rolling Release channel to Stable without issues. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 releaseChannel 1 enableWebUpdates 2 initialUpdateInfo", "documentId": "schema:Api_Admin_Vue_UpdateProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-updateprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-updateprops/index.md" } ] }, { "id": "api/models/api-admin-vue-usersprops/index.md", "kind": "schema", "title": "Api_Admin_Vue_UsersProps", "description": "Field: roles.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-usersprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-usersprops/index.md", "file": "api/models/api-admin-vue-usersprops/index.md", "searchText": "name Api_Admin_Vue_UsersProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties roles name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 roles", "documentId": "schema:Api_Admin_Vue_UsersProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-usersprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-admin-vue-usersprops/index.md" } ] }, { "id": "api/models/api-batchresult/index.md", "kind": "schema", "title": "Api_BatchResult", "description": "Fields: success and errors.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-batchresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-batchresult/index.md", "file": "api/models/api-batchresult/index.md", "searchText": "name Api_BatchResult type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_BatchResult properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errors name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 success 1 errors", "documentId": "schema:Api_BatchResult", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-batchresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-batchresult/index.md" } ] }, { "id": "api/models/api-detailedsonghistory/index.md", "kind": "schema", "title": "Api_DetailedSongHistory", "description": "Api_DetailedSongHistory", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-detailedsonghistory/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-detailedsonghistory/index.md", "file": "api/models/api-detailedsonghistory/index.md", "searchText": "name Api_DetailedSongHistory type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_DetailedSongHistory allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties listeners_start name type integer format title description Number of listeners when the song playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 94 examples refName listeners_end name type integer format title description Number of listeners when song playback ended. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 105 examples refName delta_total name type integer format title description The sum total change of listeners between the song's start and ending. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 11 examples refName is_visible name type boolean format title description Whether the entry is visible on public playlists. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_DetailedSongHistory", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-detailedsonghistory/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-detailedsonghistory/index.md" } ] }, { "id": "api/models/api-error/index.md", "kind": "schema", "title": "Api_Error", "description": "Fields: code, type, message, formatted_message, extra_data and success.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-error/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-error/index.md", "file": "api/models/api-error/index.md", "searchText": "name Api_Error type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Error properties code name type integer format title description The numeric code of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 500 examples refName type name type string format title description The programmatic class of error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example NotLoggedInException examples refName message name type string format title description The text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description. examples refName formatted_message name type string format title description The HTML-formatted text description of the error. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Error description.
Detailed error text. examples refName extra_data name type array format title description Stack traces and other supplemental data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName success name type boolean format title description Used for API calls that expect an \\Entity\\Api\\Status type response. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 code 1 type 2 message 3 formatted_message 4 extra_data 5 success", "documentId": "schema:Api_Error", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-error/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-error/index.md" } ] }, { "id": "api/models/api-filelist/index.md", "kind": "schema", "title": "Api_FileList", "description": "Api_FileList", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-filelist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-filelist/index.md", "file": "api/models/api-filelist/index.md", "searchText": "name Api_FileList type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_FileList allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 directory 1 media 2 cover_art 3 unprocessable_file 4 other enumNames 0 Directory 1 Media 2 CoverArt 3 UnprocessableFile 4 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FileTypes timestamp name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMedia allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description The media's identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName unique_id name type string format title description A unique identifier for this specific media item in the station's library. Each entry in the media table has a unique ID, even if it refers to a song that exists elsewhere. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 69b536afc7ebbf16457b8645 examples refName song_id name type string format title description The media file's 32-character unique song identifier hash. This hash is based on track metadata, so the same song uploaded multiple times will have the same `song_id`. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album art. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName path name type string format title description The relative path of the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example test.mp3 examples refName mtime name type integer format title description The UNIX timestamp when the database was last modified. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName uploaded_at name type integer format title description The UNIX timestamp when the item was first imported into the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName art_updated_at name type integer format title description The latest time (UNIX timestamp) when album art was updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName length name type number format float title description The song duration in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 240 examples refName length_text name type string format title description The formatted song duration (in mm:ss format) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 4:00 examples refName custom_fields name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap extra_metadata name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dir name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_FileListDir properties playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_FileList", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-filelist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-filelist/index.md" } ] }, { "id": "api/models/api-filelistdir/index.md", "kind": "schema", "title": "Api_FileListDir", "description": "Field: playlists.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-filelistdir/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-filelistdir/index.md", "file": "api/models/api-filelistdir/index.md", "searchText": "name Api_FileListDir type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_FileListDir properties playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_FileListDir", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-filelistdir/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-filelistdir/index.md" } ] }, { "id": "api/models/api-form-option/index.md", "kind": "schema", "title": "Api_Form_Option", "description": "Fields: value, text and description.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-option/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-option/index.md", "file": "api/models/api-form-option/index.md", "searchText": "name Api_Form_Option type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_Option properties value name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 value 1 text", "documentId": "schema:Api_Form_Option", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-option/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-option/index.md" } ] }, { "id": "api/models/api-form-optiongroup/index.md", "kind": "schema", "title": "Api_Form_OptionGroup", "description": "Fields: options and label.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-optiongroup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-optiongroup/index.md", "file": "api/models/api-form-optiongroup/index.md", "searchText": "name Api_Form_OptionGroup type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_OptionGroup properties options name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_Option properties value name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 value 1 text label name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 options 1 label", "documentId": "schema:Api_Form_OptionGroup", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-optiongroup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-optiongroup/index.md" } ] }, { "id": "api/models/api-genericform/index.md", "kind": "schema", "title": "Api_GenericForm", "description": "Api_GenericForm", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-genericform/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-genericform/index.md", "file": "api/models/api-genericform/index.md", "searchText": "name Api_GenericForm type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_GenericForm", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-genericform/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-genericform/index.md" } ] }, { "id": "api/models/api-form-nestedoptions/index.md", "kind": "schema", "title": "Api_Form_NestedOptions", "description": "Api_Form_NestedOptions", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-nestedoptions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-nestedoptions/index.md", "file": "api/models/api-form-nestedoptions/index.md", "searchText": "name Api_Form_NestedOptions type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_NestedOptions items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_Option properties value name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 value 1 text 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_OptionGroup properties options name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_Option properties value name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 value 1 text label name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 options 1 label", "documentId": "schema:Api_Form_NestedOptions", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-nestedoptions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-nestedoptions/index.md" } ] }, { "id": "api/models/api-form-simpleoptions/index.md", "kind": "schema", "title": "Api_Form_SimpleOptions", "description": "A list of Api_Form_Option.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-simpleoptions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-simpleoptions/index.md", "file": "api/models/api-form-simpleoptions/index.md", "searchText": "name Api_Form_SimpleOptions type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_SimpleOptions items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_Option properties value name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 value 1 text", "documentId": "schema:Api_Form_SimpleOptions", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-simpleoptions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-form-simpleoptions/index.md" } ] }, { "id": "api/models/api-genericbatchresult/index.md", "kind": "schema", "title": "Api_GenericBatchResult", "description": "Api_GenericBatchResult", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-genericbatchresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-genericbatchresult/index.md", "file": "api/models/api-genericbatchresult/index.md", "searchText": "name Api_GenericBatchResult type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_GenericBatchResult required 0 records allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_BatchResult properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errors name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 success 1 errors 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties records name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 title", "documentId": "schema:Api_GenericBatchResult", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-genericbatchresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-genericbatchresult/index.md" } ] }, { "id": "api/models/hashmap/index.md", "kind": "schema", "title": "HashMap", "description": "A hash-map array represented as an object.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hashmap/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hashmap/index.md", "file": "api/models/hashmap/index.md", "searchText": "name HashMap type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap", "documentId": "schema:HashMap", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hashmap/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hashmap/index.md" } ] }, { "id": "api/models/api-listener/index.md", "kind": "schema", "title": "Api_Listener", "description": "Fields: ip, user_agent, hash, mount_is_local, mount_name, connected_on and 4 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listener/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listener/index.md", "file": "api/models/api-listener/index.md", "searchText": "name Api_Listener type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Listener properties ip name type string format title description The listener's IP address default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 127.0.0.1 examples refName user_agent name type string format title description The listener's HTTP User-Agent default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/59.0.3071.86 Safari/537.36 examples refName hash name type string format title description A unique identifier for this listener/user agent (used for unique calculations). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mount_is_local name type boolean format title description Whether the user is connected to a local mount point or a remote one. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mount_name name type string format title description The display name of the mount point. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName connected_on name type integer format title description UNIX timestamp that the user first connected. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName connected_until name type integer format title description UNIX timestamp that the user disconnected (or the latest timestamp if they are still connected). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName connected_time name type integer format title description Number of seconds that the user has been connected. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 30 examples refName device name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_ListenerDevice properties client name type string format title description Summary of the listener client. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Firefox 121.0, Windows examples refName is_browser name type boolean format title description If the listener device is likely a browser. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_mobile name type boolean format title description If the listener device is likely a mobile device. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_bot name type boolean format title description If the listener device is likely a crawler. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName browser_family name type string format title description Summary of the listener browser family. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Firefox examples refName os_family name type string format title description Summary of the listener OS family. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Windows examples refName location name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_ListenerLocation properties description name type string format title description A description of the location. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Austin, Texas, US examples refName region name type string format title description The approximate region/state of the listener. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Texas examples refName city name type string format title description The approximate city of the listener. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Austin examples refName country name type string format title description The approximate country of the listener. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example United States examples refName lat name type number format float title description Latitude. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 30.000000 examples refName lon name type number format float title description Longitude. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example -97.000000 examples refName ", "documentId": "schema:Api_Listener", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listener/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listener/index.md" } ] }, { "id": "api/models/api-logcontents/index.md", "kind": "schema", "title": "Api_LogContents", "description": "Fields: contents, eof and position.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-logcontents/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-logcontents/index.md", "file": "api/models/api-logcontents/index.md", "searchText": "name Api_LogContents type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogContents properties contents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName eof name type boolean format title description Whether the log file has ended at this point or has additional data. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName position name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 contents 1 eof 2 position", "documentId": "schema:Api_LogContents", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-logcontents/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-logcontents/index.md" } ] }, { "id": "api/models/api-logtype/index.md", "kind": "schema", "title": "Api_LogType", "description": "Api_LogType", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-logtype/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-logtype/index.md", "file": "api/models/api-logtype/index.md", "searchText": "name Api_LogType type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_LogType required 0 key 1 name 2 path 3 tail allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName tail name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_LogType", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-logtype/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-logtype/index.md" } ] }, { "id": "api/models/api-mediabatchresult/index.md", "kind": "schema", "title": "Api_MediaBatchResult", "description": "Api_MediaBatchResult", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-mediabatchresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-mediabatchresult/index.md", "file": "api/models/api-mediabatchresult/index.md", "searchText": "name Api_MediaBatchResult type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 files 1 directories 2 responseRecord allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_BatchResult properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errors name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 success 1 errors 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties files name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName directories name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName responseRecord name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_MediaBatchResult", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-mediabatchresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-mediabatchresult/index.md" } ] }, { "id": "api/models/api-notification/index.md", "kind": "schema", "title": "Api_Notification", "description": "Fields: id, title, body, type, actionLabel and actionUrl.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-notification/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-notification/index.md", "file": "api/models/api-notification/index.md", "searchText": "name Api_Notification type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Notification properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName body name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 success 1 warning 2 danger 3 info enumNames 0 Success 1 Warning 2 Error 3 Info enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FlashLevels actionLabel name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName actionUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 title 2 body 3 type 4 actionLabel 5 actionUrl", "documentId": "schema:Api_Notification", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-notification/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-notification/index.md" } ] }, { "id": "api/models/api-nowplaying-currentsong/index.md", "kind": "schema", "title": "Api_NowPlaying_CurrentSong", "description": "Api_NowPlaying_CurrentSong", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-currentsong/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-currentsong/index.md", "file": "api/models/api-nowplaying-currentsong/index.md", "searchText": "name Api_NowPlaying_CurrentSong type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_CurrentSong required 0 elapsed 1 remaining allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties elapsed name type integer format title description Elapsed time of the song's playback since it started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName remaining name type integer format title description Remaining time in the song, in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 155 examples refName ", "documentId": "schema:Api_NowPlaying_CurrentSong", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-currentsong/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-currentsong/index.md" } ] }, { "id": "api/models/api-nowplaying-listeners/index.md", "kind": "schema", "title": "Api_NowPlaying_Listeners", "description": "Fields: total, unique and current.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-listeners/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-listeners/index.md", "file": "api/models/api-nowplaying-listeners/index.md", "searchText": "name Api_NowPlaying_Listeners type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current", "documentId": "schema:Api_NowPlaying_Listeners", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-listeners/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-listeners/index.md" } ] }, { "id": "api/models/api-nowplaying-live/index.md", "kind": "schema", "title": "Api_NowPlaying_Live", "description": "Fields: is_live, streamer_name, broadcast_start and art.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-live/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-live/index.md", "file": "api/models/api-nowplaying-live/index.md", "searchText": "name Api_NowPlaying_Live type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Live properties is_live name type boolean format title description Whether the stream is known to currently have a live DJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_name name type string format title description The current active streamer/DJ, if one is available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example DJ Jazzy Jeff examples refName broadcast_start name type integer format title description The start timestamp of the current broadcast, if one is available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1591548318 examples refName art name type string format title description URL to the streamer artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName required 0 is_live 1 streamer_name 2 broadcast_start 3 art", "documentId": "schema:Api_NowPlaying_Live", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-live/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-live/index.md" } ] }, { "id": "api/models/api-nowplaying/index.md", "kind": "schema", "title": "Api_NowPlaying", "description": "Fields: station, listeners, live, now_playing, playing_next, song_history and 2 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying/index.md", "file": "api/models/api-nowplaying/index.md", "searchText": "name Api_NowPlaying type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying properties station name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Station properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName frontend name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName backend name type string format title description Which AutoDJ software (backend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example liquidsoap examples refName timezone name type string format title description The station's IANA time zone default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example America/Chicago examples refName listen_url name type string format title description The full URL to listen to the default mount of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName url name type string format title description The public URL of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName public_player_url name type string format title description The public player URL for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station examples refName playlist_pls_url name type string format title description The playlist download URL in PLS format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.pls examples refName playlist_m3u_url name type string format title description The playlist download URL in M3U format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.m3u examples refName is_public name type boolean format title description If the station is public (i.e. should be shown in listings of all stations) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests_enabled name type boolean format title description If the station has song requests enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remotes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners hls_enabled name type boolean format title description If the station has HLS streaming enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description If the HLS stream should be the default one for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_url name type string format title description The full URL to listen to the HLS stream for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/hls/azuratest_radio/live.m3u8 examples refName hls_listeners name type integer format title description HLS Listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName required 0 id 1 name 2 shortcode 3 description 4 frontend 5 backend 6 timezone 7 listen_url 8 url 9 public_player_url 10 playlist_pls_url 11 playlist_m3u_url 12 is_public 13 requests_enabled 14 mounts 15 remotes 16 hls_enabled 17 hls_is_default 18 hls_url 19 hls_listeners listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current live name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Live properties is_live name type boolean format title description Whether the stream is known to currently have a live DJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_name name type string format title description The current active streamer/DJ, if one is available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example DJ Jazzy Jeff examples refName broadcast_start name type integer format title description The start timestamp of the current broadcast, if one is available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1591548318 examples refName art name type string format title description URL to the streamer artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName required 0 is_live 1 streamer_name 2 broadcast_start 3 art now_playing name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_CurrentSong required 0 elapsed 1 remaining allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties elapsed name type integer format title description Elapsed time of the song's playback since it started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName remaining name type integer format title description Remaining time in the song, in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 155 examples refName playing_next name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationQueue properties cued_at name type integer format title description UNIX timestamp when the AutoDJ is expected to queue the song for playback. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName played_at name type integer format title description UNIX timestamp when playback is expected to start. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type number format float title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 cued_at 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 is_request 7 song song_history name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song is_online name type boolean format title description Whether the stream is currently online. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName cache name type string format title description Debugging information about where the now playing data comes from. default enum 0 hit 1 database 2 station enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 station 1 listeners 2 live 3 now_playing 4 playing_next 5 song_history 6 is_online 7 cache", "documentId": "schema:Api_NowPlaying", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying/index.md" } ] }, { "id": "api/models/api-nowplaying-songhistory/index.md", "kind": "schema", "title": "Api_NowPlaying_SongHistory", "description": "Fields: sh_id, played_at, duration, playlist, playlist_chain, playlist_source and 3 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-songhistory/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-songhistory/index.md", "file": "api/models/api-nowplaying-songhistory/index.md", "searchText": "name Api_NowPlaying_SongHistory type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_SongHistory properties sh_id name type integer format title description Song history unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName played_at name type integer format title description UNIX timestamp when playback started. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type integer format title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources streamer name type string format title description Indicates the current streamer that was connected, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 sh_id 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 streamer 7 is_request 8 song", "documentId": "schema:Api_NowPlaying_SongHistory", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-songhistory/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-songhistory/index.md" } ] }, { "id": "api/models/api-nowplaying-station/index.md", "kind": "schema", "title": "Api_NowPlaying_Station", "description": "Fields: id, name, shortcode, description, frontend, backend and 14 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-station/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-station/index.md", "file": "api/models/api-nowplaying-station/index.md", "searchText": "name Api_NowPlaying_Station type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Station properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName frontend name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName backend name type string format title description Which AutoDJ software (backend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example liquidsoap examples refName timezone name type string format title description The station's IANA time zone default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example America/Chicago examples refName listen_url name type string format title description The full URL to listen to the default mount of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName url name type string format title description The public URL of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName public_player_url name type string format title description The public player URL for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station examples refName playlist_pls_url name type string format title description The playlist download URL in PLS format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.pls examples refName playlist_m3u_url name type string format title description The playlist download URL in M3U format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.m3u examples refName is_public name type boolean format title description If the station is public (i.e. should be shown in listings of all stations) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests_enabled name type boolean format title description If the station has song requests enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remotes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners hls_enabled name type boolean format title description If the station has HLS streaming enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description If the HLS stream should be the default one for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_url name type string format title description The full URL to listen to the HLS stream for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/hls/azuratest_radio/live.m3u8 examples refName hls_listeners name type integer format title description HLS Listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName required 0 id 1 name 2 shortcode 3 description 4 frontend 5 backend 6 timezone 7 listen_url 8 url 9 public_player_url 10 playlist_pls_url 11 playlist_m3u_url 12 is_public 13 requests_enabled 14 mounts 15 remotes 16 hls_enabled 17 hls_is_default 18 hls_url 19 hls_listeners", "documentId": "schema:Api_NowPlaying_Station", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-station/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-station/index.md" } ] }, { "id": "api/models/api-nowplaying-stationmount/index.md", "kind": "schema", "title": "Api_NowPlaying_StationMount", "description": "Api_NowPlaying_StationMount", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationmount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationmount/index.md", "file": "api/models/api-nowplaying-stationmount/index.md", "searchText": "name Api_NowPlaying_StationMount type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_NowPlaying_StationMount", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationmount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationmount/index.md" } ] }, { "id": "api/models/api-nowplaying-stationqueue/index.md", "kind": "schema", "title": "Api_NowPlaying_StationQueue", "description": "Fields: cued_at, played_at, duration, playlist, playlist_chain, playlist_source and 2 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationqueue/index.md", "file": "api/models/api-nowplaying-stationqueue/index.md", "searchText": "name Api_NowPlaying_StationQueue type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationQueue properties cued_at name type integer format title description UNIX timestamp when the AutoDJ is expected to queue the song for playback. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName played_at name type integer format title description UNIX timestamp when playback is expected to start. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName duration name type number format float title description Duration of the song in seconds default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180 examples refName playlist name type string format title description Indicates the playlist that the song was played from, if available, or empty string if not. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Top 100 examples refName playlist_chain name type array format title description Names of the playlist group chain the song was picked through if played from a group default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 Main Rotation 1 Rock 2 Rock Hits examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_source name type format title description The source of the playlist that the song was played from, if available. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources is_request name type boolean format title description Indicates whether the song is a listener request. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName required 0 cued_at 1 played_at 2 duration 3 playlist 4 playlist_chain 5 playlist_source 6 is_request 7 song", "documentId": "schema:Api_NowPlaying_StationQueue", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationqueue/index.md" } ] }, { "id": "api/models/api-nowplaying-stationremote/index.md", "kind": "schema", "title": "Api_NowPlaying_StationRemote", "description": "Fields: id, name, url, bitrate, format and listeners.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationremote/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationremote/index.md", "file": "api/models/api-nowplaying-stationremote/index.md", "searchText": "name Api_NowPlaying_StationRemote type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners", "documentId": "schema:Api_NowPlaying_StationRemote", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationremote/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-stationremote/index.md" } ] }, { "id": "api/models/api-nowplaying-vue-props/index.md", "kind": "schema", "title": "Api_NowPlaying_Vue_Props", "description": "Fields: stationShortName, useStatic and useSse.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-vue-props/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-vue-props/index.md", "file": "api/models/api-nowplaying-vue-props/index.md", "searchText": "name Api_NowPlaying_Vue_Props type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Vue_Props properties stationShortName name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName useStatic name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName useSse name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 stationShortName 1 useStatic 2 useSse", "documentId": "schema:Api_NowPlaying_Vue_Props", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-vue-props/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-nowplaying-vue-props/index.md" } ] }, { "id": "api/models/api-playlistconfigurationimportresult/index.md", "kind": "schema", "title": "Api_PlaylistConfigurationImportResult", "description": "Api_PlaylistConfigurationImportResult", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-playlistconfigurationimportresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-playlistconfigurationimportresult/index.md", "file": "api/models/api-playlistconfigurationimportresult/index.md", "searchText": "name Api_PlaylistConfigurationImportResult type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties playlists_created name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName media_relinked name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName media_generated name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2 examples refName members_created name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName warnings name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_PlaylistConfigurationImportResult", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-playlistconfigurationimportresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-playlistconfigurationimportresult/index.md" } ] }, { "id": "api/models/api-podcast/index.md", "kind": "schema", "title": "Api_Podcast", "description": "Api_Podcast", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcast/index.md", "file": "api/models/api-podcast/index.md", "searchText": "name Api_Podcast type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Podcast allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storage_location_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_auto_publish name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PodcastBrandingConfiguration properties public_custom_html name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_op3_prefix name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName language_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName author name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName guid name type string format title description The UUIDv5 global unique identifier for this podcast, based on its RSS feed URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episodes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName categories name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastCategory properties category name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName subtitle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_Podcast", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcast/index.md" } ] }, { "id": "api/models/api-podcastbatchresult/index.md", "kind": "schema", "title": "Api_PodcastBatchResult", "description": "Api_PodcastBatchResult", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastbatchresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastbatchresult/index.md", "file": "api/models/api-podcastbatchresult/index.md", "searchText": "name Api_PodcastBatchResult type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastBatchResult required 0 episodes 1 records allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_BatchResult properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName errors name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 success 1 errors 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties episodes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 title records name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastEpisode allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName season_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episode_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publish_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_PodcastBatchResult", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastbatchresult/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastbatchresult/index.md" } ] }, { "id": "api/models/api-podcastcategory/index.md", "kind": "schema", "title": "Api_PodcastCategory", "description": "Fields: category, text, title and subtitle.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastcategory/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastcategory/index.md", "file": "api/models/api-podcastcategory/index.md", "searchText": "name Api_PodcastCategory type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastCategory properties category name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName subtitle name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_PodcastCategory", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastcategory/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastcategory/index.md" } ] }, { "id": "api/models/api-podcastepisode/index.md", "kind": "schema", "title": "Api_PodcastEpisode", "description": "Api_PodcastEpisode", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastepisode/index.md", "file": "api/models/api-podcastepisode/index.md", "searchText": "name Api_PodcastEpisode type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastEpisode allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName link name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description_short name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName explicit name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName season_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName episode_number name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publish_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_published name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName has_media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlist_media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName media name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName has_custom_art name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art_updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_PodcastEpisode", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastepisode/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastepisode/index.md" } ] }, { "id": "api/models/api-podcastmedia/index.md", "kind": "schema", "title": "Api_PodcastMedia", "description": "Fields: id, original_name, length, length_text, path and size.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastmedia/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastmedia/index.md", "file": "api/models/api-podcastmedia/index.md", "searchText": "name Api_PodcastMedia type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_PodcastMedia properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName original_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName length_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description The file size (in bytes). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 19693056 examples refName ", "documentId": "schema:Api_PodcastMedia", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastmedia/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-podcastmedia/index.md" } ] }, { "id": "api/models/api-resolvableurl/index.md", "kind": "schema", "title": "Api_ResolvableUrl", "description": "Api_ResolvableUrl", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-resolvableurl/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-resolvableurl/index.md", "file": "api/models/api-resolvableurl/index.md", "searchText": "name Api_ResolvableUrl type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_ResolvableUrl", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-resolvableurl/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-resolvableurl/index.md" } ] }, { "id": "api/models/api-song/index.md", "kind": "schema", "title": "Api_Song", "description": "Api_Song", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-song/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-song/index.md", "file": "api/models/api-song/index.md", "searchText": "name Api_Song type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName ", "documentId": "schema:Api_Song", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-song/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-song/index.md" } ] }, { "id": "api/models/api-stationmedia/index.md", "kind": "schema", "title": "Api_StationMedia", "description": "Api_StationMedia", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationmedia/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationmedia/index.md", "file": "api/models/api-stationmedia/index.md", "searchText": "name Api_StationMedia type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMedia allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 2 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description The media's identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName unique_id name type string format title description A unique identifier for this specific media item in the station's library. Each entry in the media table has a unique ID, even if it refers to a song that exists elsewhere. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 69b536afc7ebbf16457b8645 examples refName song_id name type string format title description The media file's 32-character unique song identifier hash. This hash is based on track metadata, so the same song uploaded multiple times will have the same `song_id`. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album art. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName path name type string format title description The relative path of the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example test.mp3 examples refName mtime name type integer format title description The UNIX timestamp when the database was last modified. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName uploaded_at name type integer format title description The UNIX timestamp when the item was first imported into the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName art_updated_at name type integer format title description The latest time (UNIX timestamp) when album art was updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName length name type number format float title description The song duration in seconds. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 240 examples refName length_text name type string format title description The formatted song duration (in mm:ss format) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 4:00 examples refName custom_fields name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap extra_metadata name type object format title description A hash-map array represented as an object. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HashMap playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_StationMedia", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationmedia/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationmedia/index.md" } ] }, { "id": "api/models/api-stationmediaplaylist/index.md", "kind": "schema", "title": "Api_StationMediaPlaylist", "description": "Fields: id, name, short_name, folder and count.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationmediaplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationmediaplaylist/index.md", "file": "api/models/api-stationmediaplaylist/index.md", "searchText": "name Api_StationMediaPlaylist type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationMediaPlaylist properties id name type integer format title description The playlist identifier. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName folder name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName count name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_StationMediaPlaylist", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationmediaplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationmediaplaylist/index.md" } ] }, { "id": "api/models/api-stationondemand/index.md", "kind": "schema", "title": "Api_StationOnDemand", "description": "Fields: track_id, download_url, media and playlist.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationondemand/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationondemand/index.md", "file": "api/models/api-stationondemand/index.md", "searchText": "name Api_StationOnDemand type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationOnDemand properties track_id name type string format title description Track ID unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName download_url name type string format title description URL to download/play track. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /api/station/1/ondemand/download/1 examples refName media name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName playlist name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_StationOnDemand", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationondemand/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationondemand/index.md" } ] }, { "id": "api/models/api-stationplaylistcomputedfields/index.md", "kind": "schema", "title": "Api_StationPlaylistComputedFields", "description": "Fields: short_name, num_songs, total_length and playlist_groups.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistcomputedfields/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistcomputedfields/index.md", "file": "api/models/api-stationplaylistcomputedfields/index.md", "searchText": "name Api_StationPlaylistComputedFields type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistComputedFields properties short_name name type string format title description A URL-safe version of the playlist name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName num_songs name type integer format title description The number of songs in the playlist, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName total_length name type number format float title description The total length of the playlist in seconds, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3600 examples refName playlist_groups name type array format title description The parent groups that this playlist is a member of. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistParentGroup properties id name type integer format title description The unique identifier of the parent group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description The name of the parent group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example My Group examples refName required 0 id 1 name", "documentId": "schema:Api_StationPlaylistComputedFields", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistcomputedfields/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistcomputedfields/index.md" } ] }, { "id": "api/models/api-stationplaylistparentgroup/index.md", "kind": "schema", "title": "Api_StationPlaylistParentGroup", "description": "Fields: id and name.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistparentgroup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistparentgroup/index.md", "file": "api/models/api-stationplaylistparentgroup/index.md", "searchText": "name Api_StationPlaylistParentGroup type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistParentGroup properties id name type integer format title description The unique identifier of the parent group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description The name of the parent group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example My Group examples refName required 0 id 1 name", "documentId": "schema:Api_StationPlaylistParentGroup", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistparentgroup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistparentgroup/index.md" } ] }, { "id": "api/models/api-stationplaylistqueue/index.md", "kind": "schema", "title": "Api_StationPlaylistQueue", "description": "Fields: spm_id, media_id, song_id, artist, title and last_played.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistqueue/index.md", "file": "api/models/api-stationplaylistqueue/index.md", "searchText": "name Api_StationPlaylistQueue type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationPlaylistQueue properties spm_id name type integer format title description ID of the StationPlaylistMedia record associating this track with the playlist default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName media_id name type integer format title description ID of the StationMedia record associating this track with the media default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName song_id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName last_played name type integer format title description The UNIX timestamp when this specific track was last played. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_StationPlaylistQueue", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistqueue/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationplaylistqueue/index.md" } ] }, { "id": "api/models/api-stationprofile/index.md", "kind": "schema", "title": "Api_StationProfile", "description": "Fields: station, services and schedule.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationprofile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationprofile/index.md", "file": "api/models/api-stationprofile/index.md", "searchText": "name Api_StationProfile type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationProfile properties station name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Station properties id name type integer format title description Station ID default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Station name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName shortcode name type string format title description Station \"short code\", used for URL and folder paths default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName description name type string format title description Station description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example An AzuraCast station! examples refName frontend name type string format title description Which broadcasting software (frontend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example shoutcast2 examples refName backend name type string format title description Which AutoDJ software (backend) the station uses default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example liquidsoap examples refName timezone name type string format title description The station's IANA time zone default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example America/Chicago examples refName listen_url name type string format title description The full URL to listen to the default mount of the station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName url name type string format title description The public URL of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName public_player_url name type string format title description The public player URL for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station examples refName playlist_pls_url name type string format title description The playlist download URL in PLS format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.pls examples refName playlist_m3u_url name type string format title description The playlist download URL in M3U format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/public/example_station/playlist.m3u examples refName is_public name type boolean format title description If the station is public (i.e. should be shown in listings of all stations) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests_enabled name type boolean format title description If the station has song requests enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mounts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationMount required 0 path 1 is_default allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties path name type string format title description The relative path that corresponds to this mount point default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName is_default name type boolean format title description If the mount is the default mount for the parent station default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remotes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_StationRemote properties id name type integer format title description Mount/Remote ID number. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description Mount point name/URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName url name type string format title description Full listening URL specific to this mount default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example http://localhost:8000/radio.mp3 examples refName bitrate name type integer format title description Bitrate (kbps) of the broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName format name type string format title description Audio encoding format of broadcasted audio (if known) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName listeners name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Listeners properties total name type integer format title description Total non-unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName unique name type integer format title description Total unique current listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName current name type integer format title description Total non-unique current listeners (Legacy field, may be retired in the future.) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName required 0 total 1 unique 2 current required 0 id 1 name 2 url 3 bitrate 4 format 5 listeners hls_enabled name type boolean format title description If the station has HLS streaming enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description If the HLS stream should be the default one for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_url name type string format title description The full URL to listen to the HLS stream for the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/hls/azuratest_radio/live.m3u8 examples refName hls_listeners name type integer format title description HLS Listeners default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName required 0 id 1 name 2 shortcode 3 description 4 frontend 5 backend 6 timezone 7 listen_url 8 url 9 public_player_url 10 playlist_pls_url 11 playlist_m3u_url 12 is_public 13 requests_enabled 14 mounts 15 remotes 16 hls_enabled 17 hls_is_default 18 hls_url 19 hls_listeners services name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationServiceStatus properties backendRunning name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontendRunning name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 backendRunning 1 frontendRunning schedule name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationSchedule properties id name type integer format title description Unique identifier for this schedule entry. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName type name type string format title description The type of this schedule entry. default enum 0 playlist 1 streamer enumNames enumDescriptions const nullable readOnly writeOnly deprecated example playlist examples refName name name type string format title description Either the playlist or streamer's display name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Schedule Entry examples refName title name type string format title description The name of the event. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Schedule Entry examples refName description name type string format title description The full name of the type and name combined. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Playlist: Example Schedule Entry examples refName start_timestamp name type integer format title description The start time of the schedule entry, in UNIX format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName start name type string format title description The start time of the schedule entry, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 020-02-19T03:00:00-06:00 examples refName end_timestamp name type integer format title description The end time of the schedule entry, in UNIX format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName end name type string format title description The start time of the schedule entry, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 020-02-19T05:00:00-06:00 examples refName is_now name type boolean format title description Whether the event is currently ongoing. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 station 1 services 2 schedule", "documentId": "schema:Api_StationProfile", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationprofile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationprofile/index.md" } ] }, { "id": "api/models/api-stationqueuedetailed/index.md", "kind": "schema", "title": "Api_StationQueueDetailed", "description": "Api_StationQueueDetailed", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationqueuedetailed/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationqueuedetailed/index.md", "file": "api/models/api-stationqueuedetailed/index.md", "searchText": "name Api_StationQueueDetailed type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationQueueDetailed allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties sent_to_autodj name type boolean format title description Indicates whether the song has been sent to the AutoDJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_played name type boolean format title description Indicates whether the song has already been marked as played. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_custom_uri name type string format title description Custom AutoDJ playback URI, if it exists. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName log name type array format title description Log entries on how the specific queue item was picked by the AutoDJ. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type any format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_StationQueueDetailed", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationqueuedetailed/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationqueuedetailed/index.md" } ] }, { "id": "api/models/api-stationquota/index.md", "kind": "schema", "title": "Api_StationQuota", "description": "Fields: used, used_bytes, used_percent, available, available_bytes, quota and 3 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationquota/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationquota/index.md", "file": "api/models/api-stationquota/index.md", "searchText": "name Api_StationQuota type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationQuota properties used name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName used_percent name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName available name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName available_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName quota name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName quota_bytes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_full name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName num_files name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 used 1 used_bytes 2 used_percent 3 available 4 available_bytes 5 quota 6 quota_bytes 7 is_full 8 num_files", "documentId": "schema:Api_StationQuota", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationquota/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationquota/index.md" } ] }, { "id": "api/models/api-stationrequest/index.md", "kind": "schema", "title": "Api_StationRequest", "description": "Fields: request_id, request_url and song.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationrequest/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationrequest/index.md", "file": "api/models/api-stationrequest/index.md", "searchText": "name Api_StationRequest type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationRequest properties request_id name type string format title description Requestable ID unique identifier default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName request_url name type string format title description URL to directly submit request default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /api/station/1/request/1 examples refName song name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Song allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description The song's 32-character unique identifier hash default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 9f33bbc912c19603e51be8e0987d076b examples refName art name type string format title description URL to the album artwork (if available). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://picsum.photos/1200/1200 examples refName custom_fields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example custom_field_value examples refName ", "documentId": "schema:Api_StationRequest", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationrequest/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationrequest/index.md" } ] }, { "id": "api/models/api-stationschedule/index.md", "kind": "schema", "title": "Api_StationSchedule", "description": "Fields: id, type, name, title, description, start_timestamp and 4 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedule/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedule/index.md", "file": "api/models/api-stationschedule/index.md", "searchText": "name Api_StationSchedule type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationSchedule properties id name type integer format title description Unique identifier for this schedule entry. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName type name type string format title description The type of this schedule entry. default enum 0 playlist 1 streamer enumNames enumDescriptions const nullable readOnly writeOnly deprecated example playlist examples refName name name type string format title description Either the playlist or streamer's display name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Schedule Entry examples refName title name type string format title description The name of the event. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Schedule Entry examples refName description name type string format title description The full name of the type and name combined. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Playlist: Example Schedule Entry examples refName start_timestamp name type integer format title description The start time of the schedule entry, in UNIX format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName start name type string format title description The start time of the schedule entry, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 020-02-19T03:00:00-06:00 examples refName end_timestamp name type integer format title description The end time of the schedule entry, in UNIX format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName end name type string format title description The start time of the schedule entry, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 020-02-19T05:00:00-06:00 examples refName is_now name type boolean format title description Whether the event is currently ongoing. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_StationSchedule", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedule/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedule/index.md" } ] }, { "id": "api/models/api-stationschedulegroupmember/index.md", "kind": "schema", "title": "Api_StationScheduleGroupMember", "description": "Fields: id, name, source, order, weight, count and 3 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedulegroupmember/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedulegroupmember/index.md", "file": "api/models/api-stationschedulegroupmember/index.md", "searchText": "name Api_StationScheduleGroupMember type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationScheduleGroupMember properties id name type integer format title description The unique identifier of the member playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description The name of the member playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Playlist examples refName source name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum 0 random 1 shuffle 2 sequential enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders weight name type integer format title description The weighting of this member within the group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName count name type integer format title description The number of songs or member playlists in this member, if applicable. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName consecutive_plays name type integer format title description The number of consecutive plays configured for this member. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName play_full_cycle name type boolean format title description Whether the member plays through its full cycle before advancing. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description Whether the member playlist is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name 2 source 3 order 4 weight 5 count 6 consecutive_plays 7 play_full_cycle 8 is_enabled", "documentId": "schema:Api_StationScheduleGroupMember", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedulegroupmember/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedulegroupmember/index.md" } ] }, { "id": "api/models/api-stationscheduleplaylistevent/index.md", "kind": "schema", "title": "Api_StationSchedulePlaylistEvent", "description": "Fields: id, title, type, start, end, edit_url and 16 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationscheduleplaylistevent/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationscheduleplaylistevent/index.md", "file": "api/models/api-stationscheduleplaylistevent/index.md", "searchText": "name Api_StationSchedulePlaylistEvent type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationSchedulePlaylistEvent properties id name type integer format title description The unique identifier of the playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName title name type string format title description The playlist name representing the event title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Playlist examples refName type name type string format title description The type of this schedule event. default enum 0 playlist enumNames enumDescriptions const nullable readOnly writeOnly deprecated example playlist examples refName start name type string format title description The start time of this schedule event, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2020-02-19T03:00:00-06:00 examples refName end name type string format title description The end time of this schedule event, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2020-02-19T05:00:00-06:00 examples refName edit_url name type string format title description The API URL used to edit the underlying playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /api/station/1/playlist/1 examples refName source name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum 0 random 1 shuffle 2 sequential enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders playlist_type name type string format title description default enum 0 default 1 once_per_x_songs 2 once_per_x_minutes 3 once_per_hour 4 custom enumNames 0 Standard 1 OncePerXSongs 2 OncePerXMinutes 3 OncePerHour 4 Advanced enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistTypes play_per_songs name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName play_per_minutes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName play_per_hour_minute name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName weight name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName is_jingle name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName include_in_on_demand name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName avoid_duplicates name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName plays_via_group_schedule name type boolean format title description True if this playlist is a group member and an ancestor group's schedule covers this entire event, so it plays via that group instead of on its own. Partially covered events report false. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName members name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationScheduleGroupMember properties id name type integer format title description The unique identifier of the member playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName name name type string format title description The name of the member playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Playlist examples refName source name type string format title description default enum enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders weight name type integer format title description The weighting of this member within the group. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName count name type integer format title description The number of songs or member playlists in this member, if applicable. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName consecutive_plays name type integer format title description The number of consecutive plays configured for this member. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName play_full_cycle name type boolean format title description Whether the member plays through its full cycle before advancing. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_enabled name type boolean format title description Whether the member playlist is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name 2 source 3 order 4 weight 5 count 6 consecutive_plays 7 play_full_cycle 8 is_enabled num_songs name type integer format title description The number of songs in the playlist, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 25 examples refName total_length name type number format float title description The total length of the playlist in seconds, if it is a song-based playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3600 examples refName remote_url name type string format title description The remote URL, if this is a remote URL playlist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/stream examples refName remote_type name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 stream 1 playlist 2 other enumNames 0 Stream 1 Playlist 2 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistRemoteTypes required 0 id 1 title 2 type 3 start 4 end 5 edit_url 6 source 7 order 8 playlist_type 9 play_per_songs 10 play_per_minutes 11 play_per_hour_minute 12 weight 13 is_jingle 14 include_in_on_demand 15 avoid_duplicates 16 plays_via_group_schedule 17 members 18 num_songs 19 total_length 20 remote_url 21 remote_type", "documentId": "schema:Api_StationSchedulePlaylistEvent", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationscheduleplaylistevent/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationscheduleplaylistevent/index.md" } ] }, { "id": "api/models/api-stationschedulestreamerevent/index.md", "kind": "schema", "title": "Api_StationScheduleStreamerEvent", "description": "Fields: id, title, type, start, end, edit_url and 4 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedulestreamerevent/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedulestreamerevent/index.md", "file": "api/models/api-stationschedulestreamerevent/index.md", "searchText": "name Api_StationScheduleStreamerEvent type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationScheduleStreamerEvent properties id name type integer format title description The unique identifier of the streamer. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName title name type string format title description The streamer display name representing the event title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Example Streamer examples refName type name type string format title description The type of this schedule event. default enum 0 streamer enumNames enumDescriptions const nullable readOnly writeOnly deprecated example streamer examples refName start name type string format title description The start time of this schedule event, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2020-02-19T03:00:00-06:00 examples refName end name type string format title description The end time of this schedule event, in ISO 8601 format. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2020-02-19T05:00:00-06:00 examples refName edit_url name type string format title description The API URL used to edit the underlying streamer. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /api/station/1/streamer/1 examples refName streamer_username name type string format title description The streamer login username. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example example_dj examples refName comments name type string format title description Comments about the streamer. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Live every weekday evening. examples refName has_custom_art name type boolean format title description Whether the streamer has custom artwork. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName art name type string format title description The URL of the streamer artwork, if custom artwork is present. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /api/station/1/streamer/1/art/1.jpg examples refName required 0 id 1 title 2 type 3 start 4 end 5 edit_url 6 streamer_username 7 comments 8 has_custom_art 9 art", "documentId": "schema:Api_StationScheduleStreamerEvent", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedulestreamerevent/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationschedulestreamerevent/index.md" } ] }, { "id": "api/models/api-stationservicestatus/index.md", "kind": "schema", "title": "Api_StationServiceStatus", "description": "Fields: backendRunning and frontendRunning.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationservicestatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationservicestatus/index.md", "file": "api/models/api-stationservicestatus/index.md", "searchText": "name Api_StationServiceStatus type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationServiceStatus properties backendRunning name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontendRunning name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 backendRunning 1 frontendRunning", "documentId": "schema:Api_StationServiceStatus", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationservicestatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationservicestatus/index.md" } ] }, { "id": "api/models/api-stationstreamer/index.md", "kind": "schema", "title": "Api_StationStreamer", "description": "Fields: id, streamer_username and display_name.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamer/index.md", "file": "api/models/api-stationstreamer/index.md", "searchText": "name Api_StationStreamer type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamer properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 streamer_username 2 display_name", "documentId": "schema:Api_StationStreamer", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamer/index.md" } ] }, { "id": "api/models/api-stationstreamerbroadcast/index.md", "kind": "schema", "title": "Api_StationStreamerBroadcast", "description": "Api_StationStreamerBroadcast", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamerbroadcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamerbroadcast/index.md", "file": "api/models/api-stationstreamerbroadcast/index.md", "searchText": "name Api_StationStreamerBroadcast type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamerBroadcast required 0 id 1 timestampStart 2 timestampEnd 3 streamer 4 recording allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timestampStart name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timestampEnd name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamer properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 streamer_username 2 display_name recording name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamerBroadcastRecording properties path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName downloadUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 path 1 size 2 downloadUrl", "documentId": "schema:Api_StationStreamerBroadcast", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamerbroadcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamerbroadcast/index.md" } ] }, { "id": "api/models/api-stationstreamerbroadcastrecording/index.md", "kind": "schema", "title": "Api_StationStreamerBroadcastRecording", "description": "Fields: path, size and downloadUrl.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamerbroadcastrecording/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamerbroadcastrecording/index.md", "file": "api/models/api-stationstreamerbroadcastrecording/index.md", "searchText": "name Api_StationStreamerBroadcastRecording type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_StationStreamerBroadcastRecording properties path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName size name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName downloadUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 path 1 size 2 downloadUrl", "documentId": "schema:Api_StationStreamerBroadcastRecording", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamerbroadcastrecording/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stationstreamerbroadcastrecording/index.md" } ] }, { "id": "api/models/api-stations-vue-filesprops/index.md", "kind": "schema", "title": "Api_Stations_Vue_FilesProps", "description": "Fields: initialPlaylists, customFields, validMimeTypes and supportsImmediateQueue.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-filesprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-filesprops/index.md", "file": "api/models/api-stations-vue-filesprops/index.md", "searchText": "name Api_Stations_Vue_FilesProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties initialPlaylists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format int64 title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name customFields name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName CustomField required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description The programmatic name for the field. Can be auto-generated from the full name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName auto_assign name type string format title description An ID3v2 field to automatically assign to this value, if it exists in the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName validMimeTypes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName supportsImmediateQueue name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 initialPlaylists 1 customFields 2 validMimeTypes 3 supportsImmediateQueue", "documentId": "schema:Api_Stations_Vue_FilesProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-filesprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-filesprops/index.md" } ] }, { "id": "api/models/api-stations-vue-podcastsprops/index.md", "kind": "schema", "title": "Api_Stations_Vue_PodcastsProps", "description": "Fields: languageOptions and categoriesOptions.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-podcastsprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-podcastsprops/index.md", "file": "api/models/api-stations-vue-podcastsprops/index.md", "searchText": "name Api_Stations_Vue_PodcastsProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties languageOptions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName categoriesOptions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_NestedOptions items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName anyOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_Option properties value name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 value 1 text 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_OptionGroup properties options name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Form_Option properties value name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 value 1 text label name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 options 1 label required 0 languageOptions 1 categoriesOptions", "documentId": "schema:Api_Stations_Vue_PodcastsProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-podcastsprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-podcastsprops/index.md" } ] }, { "id": "api/models/api-stations-vue-profileprops/index.md", "kind": "schema", "title": "Api_Stations_Vue_ProfileProps", "description": "Fields: nowPlayingProps, publicPageEmbedUrl, publicOnDemandEmbedUrl, publicRequestEmbedUrl, publicHistoryEmbedUrl, publicScheduleEmbedUrl and 6 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-profileprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-profileprops/index.md", "file": "api/models/api-stations-vue-profileprops/index.md", "searchText": "name Api_Stations_Vue_ProfileProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties nowPlayingProps name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_NowPlaying_Vue_Props properties stationShortName name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName useStatic name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName useSse name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 stationShortName 1 useStatic 2 useSse publicPageEmbedUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicOnDemandEmbedUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicRequestEmbedUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicHistoryEmbedUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicScheduleEmbedUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicPodcastsEmbedUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontendAdminUri name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontendAdminPassword name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontendSourcePassword name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontendRelayPassword name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontendPort name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 nowPlayingProps 1 publicPageEmbedUrl 2 publicOnDemandEmbedUrl 3 publicRequestEmbedUrl 4 publicHistoryEmbedUrl 5 publicScheduleEmbedUrl 6 publicPodcastsEmbedUrl 7 frontendAdminUri 8 frontendAdminPassword 9 frontendSourcePassword 10 frontendRelayPassword 11 frontendPort", "documentId": "schema:Api_Stations_Vue_ProfileProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-profileprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-profileprops/index.md" } ] }, { "id": "api/models/api-stations-vue-sftpusersprops/index.md", "kind": "schema", "title": "Api_Stations_Vue_SftpUsersProps", "description": "Fields: connectionUrl, connectionIp and connectionPort.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-sftpusersprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-sftpusersprops/index.md", "file": "api/models/api-stations-vue-sftpusersprops/index.md", "searchText": "name Api_Stations_Vue_SftpUsersProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties connectionUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName connectionIp name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName connectionPort name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 connectionUrl 1 connectionIp 2 connectionPort", "documentId": "schema:Api_Stations_Vue_SftpUsersProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-sftpusersprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-sftpusersprops/index.md" } ] }, { "id": "api/models/api-stations-vue-streamersprops/index.md", "kind": "schema", "title": "Api_Stations_Vue_StreamersProps", "description": "Fields: recordStreams, connectionServerUrl, connectionStreamPort, connectionIp and connectionDjMountPoint.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-streamersprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-streamersprops/index.md", "file": "api/models/api-stations-vue-streamersprops/index.md", "searchText": "name Api_Stations_Vue_StreamersProps type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties recordStreams name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName connectionServerUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName connectionStreamPort name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName connectionIp name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName connectionDjMountPoint name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 recordStreams 1 connectionServerUrl 2 connectionStreamPort 3 connectionIp 4 connectionDjMountPoint", "documentId": "schema:Api_Stations_Vue_StreamersProps", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-streamersprops/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-stations-vue-streamersprops/index.md" } ] }, { "id": "api/models/api-status/index.md", "kind": "schema", "title": "Api_Status", "description": "Fields: success, message and formatted_message.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-status/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-status/index.md", "file": "api/models/api-status/index.md", "searchText": "name Api_Status type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Status properties success name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName formatted_message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Changes saved successfully. examples refName required 0 success 1 message 2 formatted_message", "documentId": "schema:Api_Status", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-status/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-status/index.md" } ] }, { "id": "api/models/api-systemstatus/index.md", "kind": "schema", "title": "Api_SystemStatus", "description": "Fields: online and timestamp.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-systemstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-systemstatus/index.md", "file": "api/models/api-systemstatus/index.md", "searchText": "name Api_SystemStatus type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_SystemStatus properties online name type boolean format title description Whether the service is online or not (should always be true) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timestamp name type integer format title description The current UNIX timestamp default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName required 0 online 1 timestamp", "documentId": "schema:Api_SystemStatus", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-systemstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-systemstatus/index.md" } ] }, { "id": "api/models/api-taskwithlog/index.md", "kind": "schema", "title": "Api_TaskWithLog", "description": "Field: logUrl.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-taskwithlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-taskwithlog/index.md", "file": "api/models/api-taskwithlog/index.md", "searchText": "name Api_TaskWithLog type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_TaskWithLog properties logUrl name type string format uri title description The URL to view logs of the ongoing background task. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 logUrl", "documentId": "schema:Api_TaskWithLog", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-taskwithlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-taskwithlog/index.md" } ] }, { "id": "api/models/api-time/index.md", "kind": "schema", "title": "Api_Time", "description": "Fields: timestamp, utc_datetime, utc_date, utc_time and utc_json.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-time/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-time/index.md", "file": "api/models/api-time/index.md", "searchText": "name Api_Time type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Time properties timestamp name type integer format title description The current UNIX timestamp default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1497652397 examples refName utc_datetime name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2017-06-16 10:33:17 examples refName utc_date name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example June 16, 2017 examples refName utc_time name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10:33pm examples refName utc_json name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2012-12-25T16:30:00.000000Z examples refName required 0 timestamp 1 utc_datetime 2 utc_date 3 utc_time 4 utc_json", "documentId": "schema:Api_Time", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-time/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-time/index.md" } ] }, { "id": "api/models/api-toastnotification/index.md", "kind": "schema", "title": "Api_ToastNotification", "description": "Fields: message, title and variant.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-toastnotification/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-toastnotification/index.md", "file": "api/models/api-toastnotification/index.md", "searchText": "name Api_ToastNotification type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_ToastNotification properties message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName variant name type string format title description default enum 0 success 1 warning 2 danger 3 info enumNames 0 Success 1 Warning 2 Error 3 Info enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FlashLevels required 0 message 1 title 2 variant", "documentId": "schema:Api_ToastNotification", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-toastnotification/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-toastnotification/index.md" } ] }, { "id": "api/models/haslinks/index.md", "kind": "schema", "title": "HasLinks", "description": "Field: links.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/haslinks/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/haslinks/index.md", "file": "api/models/haslinks/index.md", "searchText": "name HasLinks type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasLinks properties links name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:HasLinks", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/haslinks/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/haslinks/index.md" } ] }, { "id": "api/models/api-hassongfields/index.md", "kind": "schema", "title": "Api_HasSongFields", "description": "Fields: text, artist, title, album, genre, isrc and 1 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-hassongfields/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-hassongfields/index.md", "file": "api/models/api-hassongfields/index.md", "searchText": "name Api_HasSongFields type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_HasSongFields properties text name type string format title description The song title, usually \"Artist - Title\" default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter - Aluko River examples refName artist name type string format title description The song artist. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Chet Porter examples refName title name type string format title description The song title. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Aluko River examples refName album name type string format title description The song album. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Moving Castle examples refName genre name type string format title description The song genre. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Rock examples refName isrc name type string format title description The International Standard Recording Code (ISRC) of the file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example US28E1600021 examples refName lyrics name type string format title description Lyrics to the song. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Api_HasSongFields", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-hassongfields/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-hassongfields/index.md" } ] }, { "id": "api/models/api-uploadfile/index.md", "kind": "schema", "title": "Api_UploadFile", "description": "Fields: path and file.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-uploadfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-uploadfile/index.md", "file": "api/models/api-uploadfile/index.md", "searchText": "name Api_UploadFile type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_UploadFile properties path name type string format title description The destination path of the uploaded file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example relative/path/to/file.mp3 examples refName file name type string format title description The base64-encoded contents of the file to upload. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 path 1 file", "documentId": "schema:Api_UploadFile", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-uploadfile/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-uploadfile/index.md" } ] }, { "id": "api/models/api-uploadedrecordstatus/index.md", "kind": "schema", "title": "Api_UploadedRecordStatus", "description": "Fields: hasRecord and url.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-uploadedrecordstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-uploadedrecordstatus/index.md", "file": "api/models/api-uploadedrecordstatus/index.md", "searchText": "name Api_UploadedRecordStatus type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_UploadedRecordStatus properties hasRecord name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 hasRecord 1 url", "documentId": "schema:Api_UploadedRecordStatus", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-uploadedrecordstatus/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-uploadedrecordstatus/index.md" } ] }, { "id": "api/models/vue-appglobals/index.md", "kind": "schema", "title": "Vue_AppGlobals", "description": "Fields: locale, localeShort, localeWithDashes, timeConfig, apiCsrf, dashboardProps and 3 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-appglobals/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-appglobals/index.md", "file": "api/models/vue-appglobals/index.md", "searchText": "name Vue_AppGlobals type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName localeShort name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName localeWithDashes name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timeConfig name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName apiCsrf name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dashboardProps name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Vue_DashboardGlobals properties instanceName name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName homeUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName logoutUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName isDocker name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName platform name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName showCharts name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName showAlbumArt name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName supportedLocales name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName analyticsLevel name type string format title description default enum 0 all 1 no_ip 2 none enumNames 0 All 1 NoIp 2 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName AnalyticsLevel required 0 instanceName 1 homeUrl 2 logoutUrl 3 version 4 isDocker 5 platform 6 showCharts 7 showAlbumArt 8 supportedLocales 9 analyticsLevel user name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Vue_UserGlobals properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName displayName name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RolePermissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view administration 2 view system logs 3 administer settings 4 administer api keys 5 administer stations 6 administer custom fields 7 administer backups 8 administer storage locations enumNames 0 All 1 View 2 Logs 3 Settings 4 ApiKeys 5 Stations 6 CustomFields 7 Backups 8 StorageLocations enumDescriptions const nullable readOnly writeOnly deprecated example examples refName GlobalPermissions station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RoleStationPermission properties id name type integer format title description The station ID. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view station management 2 view station reports 3 view station logs 4 manage station profile 5 manage station broadcasting 6 manage station streamers 7 manage station mounts 8 manage station remotes 9 manage station media 10 delete station media 11 manage station automation 12 manage station web hooks 13 manage station podcasts enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions required 0 id 1 permissions required 0 global 1 station required 0 id 1 displayName 2 permissions notifications name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_ToastNotification properties message name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName variant name type string format title description default enum 0 success 1 warning 2 danger 3 info enumNames 0 Success 1 Warning 2 Error 3 Info enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FlashLevels required 0 message 1 title 2 variant componentProps name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type {} format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 locale 1 localeShort 2 localeWithDashes 3 timeConfig 4 apiCsrf 5 dashboardProps 6 user 7 notifications 8 componentProps", "documentId": "schema:Vue_AppGlobals", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-appglobals/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-appglobals/index.md" } ] }, { "id": "api/models/vue-dashboardglobals/index.md", "kind": "schema", "title": "Vue_DashboardGlobals", "description": "Fields: instanceName, homeUrl, logoutUrl, version, isDocker, platform and 4 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-dashboardglobals/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-dashboardglobals/index.md", "file": "api/models/vue-dashboardglobals/index.md", "searchText": "name Vue_DashboardGlobals type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Vue_DashboardGlobals properties instanceName name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName homeUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName logoutUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName version name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName isDocker name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName platform name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName showCharts name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName showAlbumArt name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName supportedLocales name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName additionalProperties name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName analyticsLevel name type string format title description default enum 0 all 1 no_ip 2 none enumNames 0 All 1 NoIp 2 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName AnalyticsLevel required 0 instanceName 1 homeUrl 2 logoutUrl 3 version 4 isDocker 5 platform 6 showCharts 7 showAlbumArt 8 supportedLocales 9 analyticsLevel", "documentId": "schema:Vue_DashboardGlobals", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-dashboardglobals/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-dashboardglobals/index.md" } ] }, { "id": "api/models/vue-stationfeatures/index.md", "kind": "schema", "title": "Vue_StationFeatures", "description": "Fields: media, sftp, podcasts, streamers, webhooks, requests and 5 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-stationfeatures/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-stationfeatures/index.md", "file": "api/models/vue-stationfeatures/index.md", "searchText": "name Vue_StationFeatures type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Vue_StationFeatures properties media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftp name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName podcasts name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamers name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName webhooks name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mountPoints name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hlsStreams name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remoteRelays name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName customLiquidsoapConfig name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autoDjQueue name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 media 1 sftp 2 podcasts 3 streamers 4 webhooks 5 requests 6 mountPoints 7 hlsStreams 8 remoteRelays 9 customLiquidsoapConfig 10 autoDjQueue", "documentId": "schema:Vue_StationFeatures", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-stationfeatures/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-stationfeatures/index.md" } ] }, { "id": "api/models/vue-stationglobals/index.md", "kind": "schema", "title": "Vue_StationGlobals", "description": "Fields: id, name, shortName, description, isEnabled, hasStarted and 21 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-stationglobals/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-stationglobals/index.md", "file": "api/models/vue-stationglobals/index.md", "searchText": "name Vue_StationGlobals type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName shortName name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName isEnabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hasStarted name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName needsRestart name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName timezone name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName offlineText name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName maxBitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName maxMounts name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName maxHlsStreams name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enablePublicPages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicPageUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enableOnDemand name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName onDemandUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enableStreamers name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName webDjUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicPodcastsUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicScheduleUrl name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enableRequests name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName features name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Vue_StationFeatures properties media name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftp name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName podcasts name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamers name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName webhooks name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName requests name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName mountPoints name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hlsStreams name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName remoteRelays name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName customLiquidsoapConfig name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autoDjQueue name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 media 1 sftp 2 podcasts 3 streamers 4 webhooks 5 requests 6 mountPoints 7 hlsStreams 8 remoteRelays 9 customLiquidsoapConfig 10 autoDjQueue ipGeoAttribution name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backendType name type string format title description default enum 0 liquidsoap 1 none enumNames 0 Liquidsoap 1 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName BackendAdapters frontendType name type string format title description default enum 0 icecast 1 shoutcast2 2 rsas 3 remote enumNames 0 Icecast 1 Shoutcast 2 Rsas 3 Remote enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FrontendAdapters canReload name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName useManualAutoDj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name 2 shortName 3 description 4 isEnabled 5 hasStarted 6 needsRestart 7 timezone 8 offlineText 9 maxBitrate 10 maxMounts 11 maxHlsStreams 12 enablePublicPages 13 publicPageUrl 14 enableOnDemand 15 onDemandUrl 16 enableStreamers 17 webDjUrl 18 publicPodcastsUrl 19 publicScheduleUrl 20 enableRequests 21 features 22 ipGeoAttribution 23 backendType 24 frontendType 25 canReload 26 useManualAutoDj", "documentId": "schema:Vue_StationGlobals", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-stationglobals/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-stationglobals/index.md" } ] }, { "id": "api/models/vue-userglobals/index.md", "kind": "schema", "title": "Vue_UserGlobals", "description": "Fields: id, displayName and permissions.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-userglobals/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-userglobals/index.md", "file": "api/models/vue-userglobals/index.md", "searchText": "name Vue_UserGlobals type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Vue_UserGlobals properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName displayName name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RolePermissions properties global name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view administration 2 view system logs 3 administer settings 4 administer api keys 5 administer stations 6 administer custom fields 7 administer backups 8 administer storage locations enumNames 0 All 1 View 2 Logs 3 Settings 4 ApiKeys 5 Stations 6 CustomFields 7 Backups 8 StorageLocations enumDescriptions const nullable readOnly writeOnly deprecated example examples refName GlobalPermissions station name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_RoleStationPermission properties id name type integer format title description The station ID. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName permissions name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum 0 administer all 1 view station management 2 view station reports 3 view station logs 4 manage station profile 5 manage station broadcasting 6 manage station streamers 7 manage station mounts 8 manage station remotes 9 manage station media 10 delete station media 11 manage station automation 12 manage station web hooks 13 manage station podcasts enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions required 0 id 1 permissions required 0 global 1 station required 0 id 1 displayName 2 permissions", "documentId": "schema:Vue_UserGlobals", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-userglobals/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/vue-userglobals/index.md" } ] }, { "id": "api/models/api-widgetcustomization/index.md", "kind": "schema", "title": "Api_WidgetCustomization", "description": "Fields: primaryColor, backgroundColor, textColor, showAlbumArt, roundedCorners, autoplay and 11 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-widgetcustomization/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-widgetcustomization/index.md", "file": "api/models/api-widgetcustomization/index.md", "searchText": "name Api_WidgetCustomization type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties primaryColor name type string format title description Primary accent color (hex without #). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2196F3 examples refName backgroundColor name type string format title description Background color (hex without #). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example ffffff examples refName textColor name type string format title description Text color (hex without #). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 000000 examples refName showAlbumArt name type boolean format title description Whether album art should be shown. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName roundedCorners name type boolean format title description Whether the widget should use rounded corners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autoplay name type boolean format title description Whether autoplay should be requested. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName showVolumeControls name type boolean format title description Whether the volume controls are visible. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName showTrackProgress name type boolean format title description Whether track progress is visible. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName showStreamSelection name type boolean format title description Whether stream selection controls are visible. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName showHistoryButton name type boolean format title description Whether the history button is visible. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName showRequestButton name type boolean format title description Whether the request button is visible. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName showPlaylistButton name type boolean format title description Whether the playlist download button is visible. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName initialVolume name type integer format title description Initial player volume (0-100). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 75 examples refName minimum 0 maximum 100 layout name type string format title description Layout variant for the widget. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example horizontal examples refName enablePopupPlayer name type boolean format title description Whether to show an \"open popup\" button. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName continuousPlay name type boolean format title description Whether to persist playback state across pages. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName customCss name type string format title description Additional CSS applied to the widget. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example .radio-player-widget { border-radius: 12px; } examples refName ", "documentId": "schema:Api_WidgetCustomization", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-widgetcustomization/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-widgetcustomization/index.md" } ] }, { "id": "api/models/apikey/index.md", "kind": "schema", "title": "ApiKey", "description": "ApiKey", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/apikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/apikey/index.md", "file": "api/models/apikey/index.md", "searchText": "name ApiKey type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ApiKey allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:ApiKey", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/apikey/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/apikey/index.md" } ] }, { "id": "api/models/auditlog/index.md", "kind": "schema", "title": "AuditLog", "description": "AuditLog", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/auditlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/auditlog/index.md", "file": "api/models/auditlog/index.md", "searchText": "name AuditLog type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName AuditLog required 0 timestamp 1 operation 2 operationText 3 class 4 identifier 5 targetClass 6 target 7 changes 8 user allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties timestamp name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName operation name type format title description default enum 0 1 1 2 2 3 enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName operationText name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName class name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName identifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName targetClass name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName target name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName changes name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_AuditLogChangeset properties field name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName from name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName to name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 field 1 from 2 to user name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:AuditLog", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/auditlog/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/auditlog/index.md" } ] }, { "id": "api/models/customfield/index.md", "kind": "schema", "title": "CustomField", "description": "CustomField", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/customfield/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/customfield/index.md", "file": "api/models/customfield/index.md", "searchText": "name CustomField type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName CustomField required 0 name allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName short_name name type string format title description The programmatic name for the field. Can be auto-generated from the full name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName auto_assign name type string format title description An ID3v2 field to automatically assign to this value, if it exists in the media file. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:CustomField", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/customfield/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/customfield/index.md" } ] }, { "id": "api/models/analyticslevel/index.md", "kind": "schema", "title": "AnalyticsLevel", "description": "One of: all, no_ip and none.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/analyticslevel/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/analyticslevel/index.md", "file": "api/models/analyticslevel/index.md", "searchText": "name AnalyticsLevel type string format title description default enum 0 all 1 no_ip 2 none enumNames 0 All 1 NoIp 2 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName AnalyticsLevel", "documentId": "schema:AnalyticsLevel", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/analyticslevel/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/analyticslevel/index.md" } ] }, { "id": "api/models/filetypes/index.md", "kind": "schema", "title": "FileTypes", "description": "One of: directory, media, cover_art, unprocessable_file and other.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/filetypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/filetypes/index.md", "file": "api/models/filetypes/index.md", "searchText": "name FileTypes type string format title description default enum 0 directory 1 media 2 cover_art 3 unprocessable_file 4 other enumNames 0 Directory 1 Media 2 CoverArt 3 UnprocessableFile 4 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FileTypes", "documentId": "schema:FileTypes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/filetypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/filetypes/index.md" } ] }, { "id": "api/models/ipsources/index.md", "kind": "schema", "title": "IpSources", "description": "One of: local, xff and cloudflare.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/ipsources/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/ipsources/index.md", "file": "api/models/ipsources/index.md", "searchText": "name IpSources type string format title description default enum 0 local 1 xff 2 cloudflare enumNames 0 Local 1 XForwardedFor 2 Cloudflare enumDescriptions const nullable readOnly writeOnly deprecated example examples refName IpSources", "documentId": "schema:IpSources", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/ipsources/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/ipsources/index.md" } ] }, { "id": "api/models/logintokentypes/index.md", "kind": "schema", "title": "LoginTokenTypes", "description": "One of: reset_password and login.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/logintokentypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/logintokentypes/index.md", "file": "api/models/logintokentypes/index.md", "searchText": "name LoginTokenTypes type string format title description default enum 0 reset_password 1 login enumNames 0 ResetPassword 1 Login enumDescriptions const nullable readOnly writeOnly deprecated example examples refName LoginTokenTypes", "documentId": "schema:LoginTokenTypes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/logintokentypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/logintokentypes/index.md" } ] }, { "id": "api/models/playlistgroupallowedrequests/index.md", "kind": "schema", "title": "PlaylistGroupAllowedRequests", "description": "One of: any, playlist and none.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistgroupallowedrequests/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistgroupallowedrequests/index.md", "file": "api/models/playlistgroupallowedrequests/index.md", "searchText": "name PlaylistGroupAllowedRequests type string format title description default enum 0 any 1 playlist 2 none enumNames 0 Any 1 Playlist 2 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistGroupAllowedRequests", "documentId": "schema:PlaylistGroupAllowedRequests", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistgroupallowedrequests/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistgroupallowedrequests/index.md" } ] }, { "id": "api/models/playlistorders/index.md", "kind": "schema", "title": "PlaylistOrders", "description": "One of: random, shuffle and sequential.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistorders/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistorders/index.md", "file": "api/models/playlistorders/index.md", "searchText": "name PlaylistOrders type string format title description default enum 0 random 1 shuffle 2 sequential enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders", "documentId": "schema:PlaylistOrders", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistorders/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistorders/index.md" } ] }, { "id": "api/models/playlistremotetypes/index.md", "kind": "schema", "title": "PlaylistRemoteTypes", "description": "One of: stream, playlist and other.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistremotetypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistremotetypes/index.md", "file": "api/models/playlistremotetypes/index.md", "searchText": "name PlaylistRemoteTypes type string format title description default enum 0 stream 1 playlist 2 other enumNames 0 Stream 1 Playlist 2 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistRemoteTypes", "documentId": "schema:PlaylistRemoteTypes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistremotetypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistremotetypes/index.md" } ] }, { "id": "api/models/playlistsources/index.md", "kind": "schema", "title": "PlaylistSources", "description": "One of: songs, playlists, remote_url and requests.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistsources/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistsources/index.md", "file": "api/models/playlistsources/index.md", "searchText": "name PlaylistSources type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources", "documentId": "schema:PlaylistSources", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistsources/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/playlistsources/index.md" } ] }, { "id": "api/models/playlisttypes/index.md", "kind": "schema", "title": "PlaylistTypes", "description": "One of: default, once_per_x_songs, once_per_x_minutes, once_per_hour and custom.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/playlisttypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/playlisttypes/index.md", "file": "api/models/playlisttypes/index.md", "searchText": "name PlaylistTypes type string format title description default enum 0 default 1 once_per_x_songs 2 once_per_x_minutes 3 once_per_hour 4 custom enumNames 0 Standard 1 OncePerXSongs 2 OncePerXMinutes 3 OncePerHour 4 Advanced enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistTypes", "documentId": "schema:PlaylistTypes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/playlisttypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/playlisttypes/index.md" } ] }, { "id": "api/models/podcastsources/index.md", "kind": "schema", "title": "PodcastSources", "description": "One of: manual and playlist.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/podcastsources/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/podcastsources/index.md", "file": "api/models/podcastsources/index.md", "searchText": "name PodcastSources type string format title description default enum 0 manual 1 playlist enumNames 0 Manual 1 Playlist enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:PodcastSources", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/podcastsources/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/podcastsources/index.md" } ] }, { "id": "api/models/stationbackendperformancemodes/index.md", "kind": "schema", "title": "StationBackendPerformanceModes", "description": "One of: less_memory, less_cpu, balanced and disabled.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbackendperformancemodes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbackendperformancemodes/index.md", "file": "api/models/stationbackendperformancemodes/index.md", "searchText": "name StationBackendPerformanceModes type string format title description default enum 0 less_memory 1 less_cpu 2 balanced 3 disabled enumNames 0 LessMemory 1 LessCpu 2 Balanced 3 Disabled enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:StationBackendPerformanceModes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbackendperformancemodes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbackendperformancemodes/index.md" } ] }, { "id": "api/models/storagelocationadapters/index.md", "kind": "schema", "title": "StorageLocationAdapters", "description": "One of: local, s3, dropbox and sftp.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocationadapters/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocationadapters/index.md", "file": "api/models/storagelocationadapters/index.md", "searchText": "name StorageLocationAdapters type string format title description default enum 0 local 1 s3 2 dropbox 3 sftp enumNames 0 Local 1 S3 2 Dropbox 3 Sftp enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationAdapters", "documentId": "schema:StorageLocationAdapters", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocationadapters/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocationadapters/index.md" } ] }, { "id": "api/models/storagelocationtypes/index.md", "kind": "schema", "title": "StorageLocationTypes", "description": "One of: backup, station_media, station_recordings and station_podcasts.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocationtypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocationtypes/index.md", "file": "api/models/storagelocationtypes/index.md", "searchText": "name StorageLocationTypes type string format title description default enum 0 backup 1 station_media 2 station_recordings 3 station_podcasts enumNames 0 Backup 1 StationMedia 2 StationRecordings 3 StationPodcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationTypes", "documentId": "schema:StorageLocationTypes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocationtypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocationtypes/index.md" } ] }, { "id": "api/models/api-listenerdevice/index.md", "kind": "schema", "title": "Api_ListenerDevice", "description": "Fields: client, is_browser, is_mobile, is_bot, browser_family and os_family.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listenerdevice/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listenerdevice/index.md", "file": "api/models/api-listenerdevice/index.md", "searchText": "name Api_ListenerDevice type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_ListenerDevice properties client name type string format title description Summary of the listener client. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Firefox 121.0, Windows examples refName is_browser name type boolean format title description If the listener device is likely a browser. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_mobile name type boolean format title description If the listener device is likely a mobile device. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_bot name type boolean format title description If the listener device is likely a crawler. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName browser_family name type string format title description Summary of the listener browser family. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Firefox examples refName os_family name type string format title description Summary of the listener OS family. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Windows examples refName ", "documentId": "schema:Api_ListenerDevice", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listenerdevice/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listenerdevice/index.md" } ] }, { "id": "api/models/api-listenerlocation/index.md", "kind": "schema", "title": "Api_ListenerLocation", "description": "Fields: description, region, city, country, lat and lon.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listenerlocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listenerlocation/index.md", "file": "api/models/api-listenerlocation/index.md", "searchText": "name Api_ListenerLocation type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_ListenerLocation properties description name type string format title description A description of the location. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Austin, Texas, US examples refName region name type string format title description The approximate region/state of the listener. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Texas examples refName city name type string format title description The approximate city of the listener. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Austin examples refName country name type string format title description The approximate country of the listener. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example United States examples refName lat name type number format float title description Latitude. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 30.000000 examples refName lon name type number format float title description Longitude. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example -97.000000 examples refName ", "documentId": "schema:Api_ListenerLocation", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listenerlocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/api-listenerlocation/index.md" } ] }, { "id": "api/models/podcastbrandingconfiguration/index.md", "kind": "schema", "title": "PodcastBrandingConfiguration", "description": "Fields: public_custom_html and enable_op3_prefix.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/podcastbrandingconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/podcastbrandingconfiguration/index.md", "file": "api/models/podcastbrandingconfiguration/index.md", "searchText": "name PodcastBrandingConfiguration type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PodcastBrandingConfiguration properties public_custom_html name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_op3_prefix name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:PodcastBrandingConfiguration", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/podcastbrandingconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/podcastbrandingconfiguration/index.md" } ] }, { "id": "api/models/relay/index.md", "kind": "schema", "title": "Relay", "description": "Relay", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/relay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/relay/index.md", "file": "api/models/relay/index.md", "searchText": "name Relay type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Relay allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties base_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-url.example.com examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Relay examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName created_at name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2025-01-31T21:31:58+00:00 examples refName updated_at name type string format date-time title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2025-01-31T21:31:58+00:00 examples refName ", "documentId": "schema:Relay", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/relay/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/relay/index.md" } ] }, { "id": "api/models/settings/index.md", "kind": "schema", "title": "Settings", "description": "Fields: app_unique_identifier, base_url, instance_name, prefer_browser_url, use_radio_proxy, history_keep_days and 48 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/settings/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/settings/index.md", "file": "api/models/settings/index.md", "searchText": "name Settings type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Settings properties app_unique_identifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName base_url name type string format title description Site Base URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://your.azuracast.site examples refName instance_name name type string format title description AzuraCast Instance Name default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example My AzuraCast Instance examples refName prefer_browser_url name type boolean format title description Prefer Browser URL (If Available) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName use_radio_proxy name type boolean format title description Use Web Proxy for Radio default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName history_keep_days name type integer format title description Days of Playback History to Keep default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName always_use_ssl name type boolean format title description Always Use HTTPS default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName api_access_control name type string format title description API 'Access-Control-Allow-Origin' header default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example * examples refName enable_liquidsoap_editing name type boolean format title description Allow stations to manually edit Liquidsoap code. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_all_webhooks name type boolean format title description Allow stations to dispatch webhooks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName filter_local_user_urls name type boolean format title description Prevent users from using local IPs or URLs in Webhooks, etc. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_static_nowplaying name type boolean format title description Whether to use high-performance static JSON for Now Playing data updates. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName analytics name type format title description Listener Analytics Collection default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 all 1 no_ip 2 none enumNames 0 All 1 NoIp 2 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName AnalyticsLevel check_for_updates name type boolean format title description Check for Updates and Announcements default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName update_results name type format title description Results of the latest update check. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Api_Admin_UpdateDetails properties current_release name type string format title description The stable-equivalent branch your installation currently appears to be on. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.3 examples refName latest_release name type string format title description The current latest stable release of the software. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0.20.4 examples refName needs_rolling_update name type boolean format title description If you are on the Rolling Release, whether your installation needs to be updated. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName needs_release_update name type boolean format title description Whether a newer stable release is available than the version you are currently using. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName rolling_updates_available name type integer format title description If you are on the Rolling Release, the number of updates released since your version. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName can_switch_to_stable name type boolean format title description Whether you can seamlessly move from the Rolling Release channel to Stable without issues. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName update_last_run name type integer format title description The UNIX timestamp when updates were last checked. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName public_theme name type format title description Base Theme for Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example light examples refName oneOf 0 name type string format title description default enum 0 browser 1 light 2 dark enumNames 0 Browser 1 Light 2 Dark enumDescriptions const nullable readOnly writeOnly deprecated example examples refName SupportedThemes hide_album_art name type boolean format title description Hide Album Art on Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName homepage_redirect_url name type string format title description Homepage Redirect URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/ examples refName default_album_art_url name type string format title description Default Album Art URL default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://example.com/image.jpg examples refName use_external_album_art_when_processing_media name type boolean format title description Attempt to fetch album art from external sources when processing media. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName use_external_album_art_in_apis name type boolean format title description Attempt to fetch album art from external sources in API requests. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName last_fm_api_key name type string format title description An API key to connect to Last.fm services, if provided. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example SAMPLE-API-KEY examples refName hide_product_name name type boolean format title description Hide AzuraCast Branding on Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName public_custom_css name type string format title description Custom CSS for Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_js name type string format title description Custom JS for Public Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName internal_custom_css name type string format title description Custom CSS for Internal Pages default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backup_enabled name type boolean format title description Whether backup is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName backup_time_code name type string format title description The timecode (i.e. 400 for 4:00AM) when automated backups should run. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 400 examples refName backup_exclude_media name type boolean format title description Whether to exclude media in automated backups. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName backup_keep_copies name type integer format title description Number of backups to keep, or infinite if zero/null. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2 examples refName backup_storage_location name type integer format title description The storage location ID for automated backups. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName backup_format name type string format title description The output format for the automated backup. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example zip examples refName backup_last_run name type integer format title description The UNIX timestamp when automated backup was last run. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName backup_last_output name type string format title description The output of the latest automated backup task. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName setup_complete_time name type integer format title description The UNIX timestamp when setup was last completed. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName sync_disabled name type boolean format title description Temporarily disable all sync tasks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example false examples refName sync_last_run name type integer format title description The last run timestamp for the unified sync task. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName external_ip name type string format title description This installation's external IP. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 192.168.1.1 examples refName geolite_license_key name type string format title description The license key for the Maxmind Geolite download. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName geolite_last_run name type integer format title description The UNIX timestamp when the Maxmind Geolite was last downloaded. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName mail_enabled name type boolean format title description Enable e-mail delivery across the application. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName mail_sender_name name type string format title description The name of the sender of system e-mails. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraCast examples refName mail_sender_email name type string format title description The e-mail address of the sender of system e-mails. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example example@example.com examples refName mail_smtp_host name type string format title description The host to send outbound SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example smtp.example.com examples refName mail_smtp_port name type integer format title description The port for sending outbound SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 465 examples refName mail_smtp_username name type string format title description The username when connecting to SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example username examples refName mail_smtp_password name type string format title description The password when connecting to SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName mail_smtp_secure name type boolean format title description Whether to use a secure (TLS) connection when sending SMTP mail. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName avatar_service name type string format title description The external avatar service to use when fetching avatars. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example libravatar examples refName avatar_default_url name type string format title description The default avatar URL. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName acme_email name type string format title description ACME (LetsEncrypt) e-mail address. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName acme_domains name type string format title description ACME (LetsEncrypt) domain name(s). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ip_source name type format title description IP Address Source default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName oneOf 0 name type string format title description default enum 0 local 1 xff 2 cloudflare enumNames 0 Local 1 XForwardedFor 2 Cloudflare enumDescriptions const nullable readOnly writeOnly deprecated example examples refName IpSources", "documentId": "schema:Settings", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/settings/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/settings/index.md" } ] }, { "id": "api/models/sftpuser/index.md", "kind": "schema", "title": "SftpUser", "description": "SftpUser", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/sftpuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/sftpuser/index.md", "file": "api/models/sftpuser/index.md", "searchText": "name SftpUser type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName SftpUser allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName publicKeys name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:SftpUser", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/sftpuser/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/sftpuser/index.md" } ] }, { "id": "api/models/station/index.md", "kind": "schema", "title": "Station", "description": "Station", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/station/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/station/index.md", "file": "api/models/station/index.md", "searchText": "name Station type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName Station allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The full display name of the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example AzuraTest Radio examples refName short_name name type string format title description The URL-friendly name for the station, typically auto-generated from the full station name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example azuratest_radio examples refName is_enabled name type boolean format title description If set to 'false', prevents the station from broadcasting but leaves it in the database. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName frontend_type name type string format title description default enum 0 icecast 1 shoutcast2 2 rsas 3 remote enumNames 0 Icecast 1 Shoutcast 2 Rsas 3 Remote enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FrontendAdapters frontend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationFrontendConfiguration properties custom_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName admin_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName relay_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listeners name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_user_agents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_countries name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allowed_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_license_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_user_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_type name type string format title description default enum 0 liquidsoap 1 none enumNames 0 Liquidsoap 1 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName BackendAdapters backend_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBackendConfiguration properties charset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName telnet_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_format name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName use_manual_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reset_sequential_queues_on_restart name type boolean format title description Reset the internal queue of sequential playlists when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_queue_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_mount_point name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_buffer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName audio_processing_method name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName post_processing_include_live name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_license_key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_configuration_path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_preset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_loudness_target name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_replaygain_metadata name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_type name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_high name type number format float title description The dB level above which a track is considered 'loud' ('high' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_medium name type number format float title description The dB level below which a track is considered 'quiet' ('medium' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_margin name type number format float title description The dB difference above which two tracks are considered too different to overlap ('margin' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName duplicate_prevention_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks tracks and titles against, also applies to artists when duplicate_prevention_artist_time_range is not set. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName duplicate_prevention_artist_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks artists against, uses duplicate_prevention_time_range if set to null. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName performance_mode name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segment_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_in_playlist name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_overhead name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_enable_on_public_player name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName live_broadcast_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_auto_cue name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName write_playlists_to_liquidsoap name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName share_encoders name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_top name type string format title description Custom Liquidsoap Configuration: Top Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_playlists name type string format title description Custom Liquidsoap Configuration: Pre-Playlists Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_live name type string format title description Custom Liquidsoap Configuration: Pre-Live Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_fade name type string format title description Custom Liquidsoap Configuration: Pre-Fade Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config name type string format title description Custom Liquidsoap Configuration: Pre-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_bottom name type string format title description Custom Liquidsoap Configuration: Post-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A sample radio station. examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://demo.azuracast.com/ examples refName genre name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Various examples refName radio_base_dir name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio examples refName enable_requests name type boolean format title description Whether listeners can request songs to play on this station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName request_delay name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName request_threshold name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName requests_only_via_playlists name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName disconnect_deactivate_streamer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName enable_streamers name type boolean format title description Whether streamers are allowed to broadcast to this station at all. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_streamer_live name type boolean format title description Whether a streamer is currently active on the station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_page name type boolean format title description Whether this station's public pages (player, on-demand streaming, etc.) are visible to non-authenticated users. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_public_api name type boolean format title description Whether the public-facing API endpoints (now playing, art, etc.) are visible to non-authenticated users. Automatically enabled if 'enable_public_page' is true. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand name type boolean format title description Whether this station has a public 'on-demand' streaming and download page. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_on_demand_download name type boolean format title description Whether the 'on-demand' page offers download capability. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_hls name type boolean format title description Whether HLS streaming is enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName api_history_items name type integer format title description The number of 'last played' history items to show for a station in API responses. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName timezone name type string format title description The time zone that station operations should take place in. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example UTC examples refName max_bitrate name type integer format title description The maximum bitrate at which a station may broadcast, in Kbps. 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName max_mounts name type integer format title description The maximum number of mount points the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName max_hls_streams name type integer format title description The maximum number of HLS streams the station can have, 0 for unlimited default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName branding_config name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBrandingConfiguration properties default_album_art_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_css name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_js name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName offline_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:Station", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/station/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/station/index.md" } ] }, { "id": "api/models/stationbackendconfiguration/index.md", "kind": "schema", "title": "StationBackendConfiguration", "description": "Fields: charset, dj_port, telnet_port, record_streams, record_streams_format, record_streams_bitrate and 35 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbackendconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbackendconfiguration/index.md", "file": "api/models/stationbackendconfiguration/index.md", "searchText": "name StationBackendConfiguration type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBackendConfiguration properties charset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName telnet_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_format name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName record_streams_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName use_manual_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reset_sequential_queues_on_restart name type boolean format title description Reset the internal queue of sequential playlists when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_queue_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_mount_point name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dj_buffer name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName audio_processing_method name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName post_processing_include_live name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_license_key name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName stereo_tool_configuration_path name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_preset name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName master_me_loudness_target name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_replaygain_metadata name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_type name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade name type number format float title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_high name type number format float title description The dB level above which a track is considered 'loud' ('high' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_medium name type number format float title description The dB level below which a track is considered 'quiet' ('medium' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName crossfade_smart_margin name type number format float title description The dB difference above which two tracks are considered too different to overlap ('margin' parameter in 'cross.smart'). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName duplicate_prevention_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks tracks and titles against, also applies to artists when duplicate_prevention_artist_time_range is not set. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName duplicate_prevention_artist_time_range name type integer format title description The time range (in minutes) of the song history that duplicate prevention checks artists against, uses duplicate_prevention_time_range if set to null. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName performance_mode name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segment_length name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_in_playlist name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_segments_overhead name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_enable_on_public_player name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName hls_is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName live_broadcast_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enable_auto_cue name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName write_playlists_to_liquidsoap name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName share_encoders name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_top name type string format title description Custom Liquidsoap Configuration: Top Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_playlists name type string format title description Custom Liquidsoap Configuration: Pre-Playlists Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_live name type string format title description Custom Liquidsoap Configuration: Pre-Live Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_pre_fade name type string format title description Custom Liquidsoap Configuration: Pre-Fade Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config name type string format title description Custom Liquidsoap Configuration: Pre-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName custom_config_bottom name type string format title description Custom Liquidsoap Configuration: Post-Broadcast Section default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:StationBackendConfiguration", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbackendconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbackendconfiguration/index.md" } ] }, { "id": "api/models/stationbrandingconfiguration/index.md", "kind": "schema", "title": "StationBrandingConfiguration", "description": "Fields: default_album_art_url, public_custom_css, public_custom_js and offline_text.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbrandingconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbrandingconfiguration/index.md", "file": "api/models/stationbrandingconfiguration/index.md", "searchText": "name StationBrandingConfiguration type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationBrandingConfiguration properties default_album_art_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_css name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName public_custom_js name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName offline_text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:StationBrandingConfiguration", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbrandingconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationbrandingconfiguration/index.md" } ] }, { "id": "api/models/stationfrontendconfiguration/index.md", "kind": "schema", "title": "StationFrontendConfiguration", "description": "Fields: custom_config, source_pw, admin_pw, relay_pw, streamer_pw, port and 7 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationfrontendconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationfrontendconfiguration/index.md", "file": "api/models/stationfrontendconfiguration/index.md", "searchText": "name StationFrontendConfiguration type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationFrontendConfiguration properties custom_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName source_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName admin_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName relay_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName streamer_pw name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listeners name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_user_agents name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName banned_countries name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allowed_ips name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_license_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sc_user_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:StationFrontendConfiguration", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationfrontendconfiguration/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationfrontendconfiguration/index.md" } ] }, { "id": "api/models/stationhlsstream/index.md", "kind": "schema", "title": "StationHlsStream", "description": "StationHlsStream", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationhlsstream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationhlsstream/index.md", "file": "api/models/stationhlsstream/index.md", "searchText": "name StationHlsStream type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationHlsStream allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac_lofi examples refName format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example aac examples refName oneOf 0 name type string format title description default enum 0 aac 1 aac_he 2 aac_he_v2 enumNames 0 AacLowComplexity 1 AacHighEfficiencyV1 2 AacHighEfficiencyV2 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HlsStreamProfiles bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName ", "documentId": "schema:StationHlsStream", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationhlsstream/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationhlsstream/index.md" } ] }, { "id": "api/models/stationmediametadata/index.md", "kind": "schema", "title": "StationMediaMetadata", "description": "Fields: amplify, fade_in, fade_out, cue_in, cue_out and cross_start_next.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationmediametadata/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationmediametadata/index.md", "file": "api/models/stationmediametadata/index.md", "searchText": "name StationMediaMetadata type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties amplify name type number format float title description Value (in dB) to amplify the current track to produce a uniform loudness. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example -1.5 examples refName fade_in name type number format float title description Seconds from the start of the track to end fading in. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2.0 examples refName fade_out name type number format float title description Seconds from the end of the track to begin fading out. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2.0 examples refName cue_in name type number format float title description Seconds from the start of the track to start playback (cue in). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3.5 examples refName cue_out name type number format float title description Seconds from the start of the track to end playback (cue out). default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 181.5 examples refName cross_start_next name type number format float title description Seconds from the start of the track to begin fading in the next track. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 180.0 examples refName ", "documentId": "schema:StationMediaMetadata", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationmediametadata/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationmediametadata/index.md" } ] }, { "id": "api/models/stationmount/index.md", "kind": "schema", "title": "StationMount", "description": "StationMount", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationmount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationmount/index.md", "file": "api/models/stationmount/index.md", "searchText": "name StationMount type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationMount allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /radio.mp3 examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_default name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName fallback_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /error.mp3 examples refName relay_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://radio.example.com:8000/radio.mp3 examples refName authhash name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName max_listener_duration name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 43200 examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName frontend_config name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName ", "documentId": "schema:StationMount", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationmount/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationmount/index.md" } ] }, { "id": "api/models/stationplaylist/index.md", "kind": "schema", "title": "StationPlaylist", "description": "StationPlaylist", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationplaylist/index.md", "file": "api/models/stationplaylist/index.md", "searchText": "name StationPlaylist type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPlaylist allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test Playlist examples refName description name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A playlist containing my favorite songs examples refName type name type string format title description default enum 0 default 1 once_per_x_songs 2 once_per_x_minutes 3 once_per_hour 4 custom enumNames 0 Standard 1 OncePerXSongs 2 OncePerXMinutes 3 OncePerHour 4 Advanced enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistTypes source name type string format title description default enum 0 songs 1 playlists 2 remote_url 3 requests enumNames 0 Songs 1 Playlists 2 RemoteUrl 3 Requests enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistSources order name type string format title description default enum 0 random 1 shuffle 2 sequential enumNames 0 Random 1 Shuffle 2 Sequential enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistOrders remote_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://remote-url.example.com/stream.mp3 examples refName remote_type name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example stream examples refName oneOf 0 name type string format title description default enum 0 stream 1 playlist 2 other enumNames 0 Stream 1 Playlist 2 Other enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistRemoteTypes remote_buffer name type integer format title description The total time (in seconds) that Liquidsoap should buffer remote URL streams. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName is_jingle name type boolean format title description If yes, do not send jingle metadata to AutoDJ or trigger web hooks. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName play_per_songs name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 5 examples refName play_per_minutes name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120 examples refName play_per_hour_minute name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 15 examples refName weight name type integer format title description The relative weight of the playlist. Larger numbers play more often than playlists with lower number weights. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 3 examples refName include_in_requests name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName include_in_on_demand name type boolean format title description Whether this playlist's media is included in 'on demand' download/streaming if enabled. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName backend_options name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example interrupt,loop_once,single_track,merge examples refName items name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName avoid_duplicates name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName preserve_queue_on_restart name type boolean format title description Don't reset this playlist's queue when the station is restarted or its configuration is rewritten. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName podcasts name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName playlists name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:StationPlaylist", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationplaylist/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationplaylist/index.md" } ] }, { "id": "api/models/stationplaylistgroup/index.md", "kind": "schema", "title": "StationPlaylistGroup", "description": "StationPlaylistGroup", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationplaylistgroup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationplaylistgroup/index.md", "file": "api/models/stationplaylistgroup/index.md", "searchText": "name StationPlaylistGroup type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The playlist name. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example My Playlist examples refName weight name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 examples refName consecutive_plays name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0 examples refName play_full_cycle name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName preserve_queue_on_recursive_reset name type boolean format title description Keep the member's queue on a recursive queue reset of a parent playlist group, also keeps the queues of its nested members. If the same playlist is added to a group more than once, all of its entries share this setting. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allowed_requests name type string format title description default enum 0 any 1 playlist 2 none enumNames 0 Any 1 Playlist 2 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName PlaylistGroupAllowedRequests", "documentId": "schema:StationPlaylistGroup", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationplaylistgroup/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationplaylistgroup/index.md" } ] }, { "id": "api/models/stationremote/index.md", "kind": "schema", "title": "StationRemote", "description": "StationRemote", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationremote/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationremote/index.md", "file": "api/models/stationremote/index.md", "searchText": "name StationRemote type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationRemote allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128kbps MP3 examples refName is_visible_on_public_pages name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 shoutcast1 1 shoutcast2 2 icecast 3 azurarelay enumNames 0 Shoutcast1 1 Shoutcast2 2 Icecast 3 AzuraRelay enumDescriptions const nullable readOnly writeOnly deprecated example examples refName RemoteAdapters is_editable name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example true examples refName enable_autodj name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName autodj_format name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example mp3 examples refName oneOf 0 name type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats autodj_bitrate name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 128 examples refName custom_listen_url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-listen-url.example.com/stream.mp3 examples refName url name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://custom-url.example.com examples refName mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /stream.mp3 examples refName admin_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName source_port name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 8000 examples refName source_mount name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example / examples refName source_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example source examples refName source_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example password examples refName is_public name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName listeners_unique name type integer format title description The most recent number of unique listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 10 examples refName listeners_total name type integer format title description The most recent number of total (non-unique) listeners. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 12 examples refName ", "documentId": "schema:StationRemote", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationremote/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationremote/index.md" } ] }, { "id": "api/models/stationschedule/index.md", "kind": "schema", "title": "StationSchedule", "description": "StationSchedule", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationschedule/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationschedule/index.md", "file": "api/models/stationschedule/index.md", "searchText": "name StationSchedule type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties start_time name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 900 examples refName end_time name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 2200 examples refName days name type array format title description Array of ISO-8601 days (1 for Monday, 7 for Sunday) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 0,1,2,3 examples refName items name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName loop_once name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName prevent_requests name type boolean format title description Used to suppress the global request queue while this schedule window is active. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reset_queue_at_start name type boolean format title description Reset the playlist's internal queue when this schedule window becomes active. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reset_queue_recursive name type boolean format title description Also reset nested playlist groups and member playlists (playlist groups only). Members with preserve_queue_on_recursive_reset keep their queues. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:StationSchedule", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationschedule/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationschedule/index.md" } ] }, { "id": "api/models/stationstreamer/index.md", "kind": "schema", "title": "StationStreamer", "description": "Station streamers (DJ accounts) allowed to broadcast to a station.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationstreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationstreamer/index.md", "file": "api/models/stationstreamer/index.md", "searchText": "name StationStreamer type object format title description Station streamers (DJ accounts) allowed to broadcast to a station. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationStreamer allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties streamer_username name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example dj_test examples refName streamer_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName display_name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Test DJ examples refName comments name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example This is a test DJ account. examples refName is_active name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName enforce_schedule name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName reactivate_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName schedule_items name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:StationStreamer", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationstreamer/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationstreamer/index.md" } ] }, { "id": "api/models/stationstreamerbroadcast/index.md", "kind": "schema", "title": "StationStreamerBroadcast", "description": "Each individual broadcast associated with a streamer.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationstreamerbroadcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationstreamerbroadcast/index.md", "file": "api/models/stationstreamerbroadcast/index.md", "searchText": "name StationStreamerBroadcast type object format title description Each individual broadcast associated with a streamer. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id", "documentId": "schema:StationStreamerBroadcast", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationstreamerbroadcast/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationstreamerbroadcast/index.md" } ] }, { "id": "api/models/stationwebhook/index.md", "kind": "schema", "title": "StationWebhook", "description": "StationWebhook", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationwebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationwebhook/index.md", "file": "api/models/stationwebhook/index.md", "searchText": "name StationWebhook type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationWebhook allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties name name type string format title description The nickname of the webhook connector. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Twitter Post examples refName type name type string format title description default enum 0 generic 1 email 2 tunein 3 radiode 4 radioreg 5 getmeradio 6 discord 7 telegram 8 groupme 9 mastodon 10 bluesky 11 google_analytics_v4 12 matomo_analytics 13 twitter 14 google_analytics enumNames 0 Generic 1 Email 2 TuneIn 3 RadioDe 4 RadioReg 5 GetMeRadio 6 Discord 7 Telegram 8 GroupMe 9 Mastodon 10 Bluesky 11 GoogleAnalyticsV4 12 MatomoAnalytics 13 Twitter 14 GoogleAnalyticsV3 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName WebhookTypes is_enabled name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName triggers name type array format title description List of events that should trigger the webhook notification. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName config name type array format title description Detailed webhook configuration (if applicable) default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName metadata name type array format title description Internal details used by the webhook to preserve state. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:StationWebhook", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationwebhook/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationwebhook/index.md" } ] }, { "id": "api/models/storagelocation/index.md", "kind": "schema", "title": "StorageLocation", "description": "StorageLocation", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocation/index.md", "file": "api/models/storagelocation/index.md", "searchText": "name StorageLocation type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocation allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties type name type string format title description default enum 0 backup 1 station_media 2 station_recordings 3 station_podcasts enumNames 0 Backup 1 StationMedia 2 StationRecordings 3 StationPodcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationTypes adapter name type string format title description default enum 0 local 1 s3 2 dropbox 3 sftp enumNames 0 Local 1 S3 2 Dropbox 3 Sftp enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StorageLocationAdapters path name type string format title description The local path, if the local adapter is used, or path prefix for S3/remote adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example /var/azuracast/stations/azuratest_radio/media examples refName s3CredentialKey name type string format title description The credential key for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-key-here examples refName s3CredentialSecret name type string format title description The credential secret for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-secret-here examples refName s3Region name type string format title description The region for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-region examples refName s3Version name type string format title description The API version for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example latest examples refName s3Bucket name type string format title description The S3 bucket name for S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example your-bucket-name examples refName s3Endpoint name type string format title description The optional custom S3 endpoint S3 adapters. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example https://your-region.digitaloceanspaces.com examples refName s3UsePathStyle name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAppKey name type string format title description The optional Dropbox App Key. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAppSecret name type string format title description The optional Dropbox App Secret. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName dropboxAuthToken name type string format title description The optional Dropbox Auth Token. default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftpHost name type string format title description The host for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 127.0.0.1 examples refName sftpUsername name type string format title description The username for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example root examples refName sftpPassword name type string format title description The password for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example abc123 examples refName sftpPort name type integer format title description The port for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 20 examples refName sftpPrivateKey name type string format title description The private key for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName sftpPrivateKeyPassPhrase name type string format title description The private key pass phrase for SFTP adapters default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName storageQuotaBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120000 examples refName storageQuota name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 50 GB examples refName storageUsedBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 60000 examples refName storageUsed name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 GB examples refName storageAvailableBytes name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 120000 examples refName storageAvailable name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1 GB examples refName ", "documentId": "schema:StorageLocation", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocation/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/storagelocation/index.md" } ] }, { "id": "api/models/hasautoincrementid/index.md", "kind": "schema", "title": "HasAutoIncrementId", "description": "Field: id.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hasautoincrementid/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hasautoincrementid/index.md", "file": "api/models/hasautoincrementid/index.md", "searchText": "name HasAutoIncrementId type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id", "documentId": "schema:HasAutoIncrementId", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hasautoincrementid/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hasautoincrementid/index.md" } ] }, { "id": "api/models/hassongfields/index.md", "kind": "schema", "title": "HasSongFields", "description": "Fields: song_id, text, artist, title and album.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hassongfields/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hassongfields/index.md", "file": "api/models/hassongfields/index.md", "searchText": "name HasSongFields type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties song_id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName text name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName artist name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName title name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName album name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:HasSongFields", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hassongfields/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hassongfields/index.md" } ] }, { "id": "api/models/hassplittokenfields/index.md", "kind": "schema", "title": "HasSplitTokenFields", "description": "Fields: id and verifier.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hassplittokenfields/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hassplittokenfields/index.md", "file": "api/models/hassplittokenfields/index.md", "searchText": "name HasSplitTokenFields type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:HasSplitTokenFields", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hassplittokenfields/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hassplittokenfields/index.md" } ] }, { "id": "api/models/hasuniqueid/index.md", "kind": "schema", "title": "HasUniqueId", "description": "Field: id.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hasuniqueid/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hasuniqueid/index.md", "file": "api/models/hasuniqueid/index.md", "searchText": "name HasUniqueId type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id", "documentId": "schema:HasUniqueId", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hasuniqueid/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hasuniqueid/index.md" } ] }, { "id": "api/models/user/index.md", "kind": "schema", "title": "User", "description": "User", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/user/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/user/index.md", "file": "api/models/user/index.md", "searchText": "name User type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:User", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/user/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/user/index.md" } ] }, { "id": "api/models/userlogintoken/index.md", "kind": "schema", "title": "UserLoginToken", "description": "UserLoginToken", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/userlogintoken/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/userlogintoken/index.md", "file": "api/models/userlogintoken/index.md", "searchText": "name UserLoginToken type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName UserLoginToken allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasSplitTokenFields properties id name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName verifier name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties user name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName User allOf 0 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HasAutoIncrementId properties id name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName required 0 id 1 name type object format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName properties email name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example demo@azuracast.com examples refName auth_password name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName name name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example Demo Account examples refName locale name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example en_US examples refName show_24_hour_time name type boolean format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName two_factor_secret name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example A1B2C3D4 examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName updated_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1609480800 examples refName roles name type array format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName items name type format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example examples refName type name type string format title description default enum 0 reset_password 1 login enumNames 0 ResetPassword 1 Login enumDescriptions const nullable readOnly writeOnly deprecated example examples refName LoginTokenTypes comment name type string format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example SSO Login examples refName created_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1640998800 examples refName expires_at name type integer format title description default enum enumNames enumDescriptions const nullable readOnly writeOnly deprecated example 1640998800 examples refName ", "documentId": "schema:UserLoginToken", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/userlogintoken/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/userlogintoken/index.md" } ] }, { "id": "api/models/flashlevels/index.md", "kind": "schema", "title": "FlashLevels", "description": "One of: success, warning, danger and info.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/flashlevels/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/flashlevels/index.md", "file": "api/models/flashlevels/index.md", "searchText": "name FlashLevels type string format title description default enum 0 success 1 warning 2 danger 3 info enumNames 0 Success 1 Warning 2 Error 3 Info enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FlashLevels", "documentId": "schema:FlashLevels", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/flashlevels/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/flashlevels/index.md" } ] }, { "id": "api/models/globalpermissions/index.md", "kind": "schema", "title": "GlobalPermissions", "description": "One of: administer all, view administration, view system logs, administer settings, administer api keys, administer stations and 3 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/globalpermissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/globalpermissions/index.md", "file": "api/models/globalpermissions/index.md", "searchText": "name GlobalPermissions type string format title description default enum 0 administer all 1 view administration 2 view system logs 3 administer settings 4 administer api keys 5 administer stations 6 administer custom fields 7 administer backups 8 administer storage locations enumNames 0 All 1 View 2 Logs 3 Settings 4 ApiKeys 5 Stations 6 CustomFields 7 Backups 8 StorageLocations enumDescriptions const nullable readOnly writeOnly deprecated example examples refName GlobalPermissions", "documentId": "schema:GlobalPermissions", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/globalpermissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/globalpermissions/index.md" } ] }, { "id": "api/models/releasechannel/index.md", "kind": "schema", "title": "ReleaseChannel", "description": "One of: latest and stable.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/releasechannel/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/releasechannel/index.md", "file": "api/models/releasechannel/index.md", "searchText": "name ReleaseChannel type string format title description default enum 0 latest 1 stable enumNames 0 RollingRelease 1 Stable enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:ReleaseChannel", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/releasechannel/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/releasechannel/index.md" } ] }, { "id": "api/models/stationpermissions/index.md", "kind": "schema", "title": "StationPermissions", "description": "One of: administer all, view station management, view station reports, view station logs, manage station profile, manage station broadcasting and 8 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationpermissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationpermissions/index.md", "file": "api/models/stationpermissions/index.md", "searchText": "name StationPermissions type string format title description default enum 0 administer all 1 view station management 2 view station reports 3 view station logs 4 manage station profile 5 manage station broadcasting 6 manage station streamers 7 manage station mounts 8 manage station remotes 9 manage station media 10 delete station media 11 manage station automation 12 manage station web hooks 13 manage station podcasts enumNames 0 All 1 View 2 Reports 3 Logs 4 Profile 5 Broadcasting 6 Streamers 7 MountPoints 8 RemoteRelays 9 Media 10 DeleteMedia 11 Automation 12 WebHooks 13 Podcasts enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StationPermissions", "documentId": "schema:StationPermissions", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/stationpermissions/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/stationpermissions/index.md" } ] }, { "id": "api/models/supportedlocales/index.md", "kind": "schema", "title": "SupportedLocales", "description": "One of: en_US.UTF-8, cs_CZ.UTF-8, nl_NL.UTF-8, fr_FR.UTF-8, de_DE.UTF-8, el_GR.UTF-8 and 13 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/supportedlocales/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/supportedlocales/index.md", "file": "api/models/supportedlocales/index.md", "searchText": "name SupportedLocales type string format title description default enum 0 en_US.UTF-8 1 cs_CZ.UTF-8 2 nl_NL.UTF-8 3 fr_FR.UTF-8 4 de_DE.UTF-8 5 el_GR.UTF-8 6 it_IT.UTF-8 7 ja_JP.UTF-8 8 ko_KR.UTF-8 9 nb_NO.UTF-8 10 pl_PL.UTF-8 11 pt_PT.UTF-8 12 pt_BR.UTF-8 13 ru_RU.UTF-8 14 zh_CN.UTF-8 15 es_ES.UTF-8 16 sv_SE.UTF-8 17 tr_TR.UTF-8 18 uk_UA.UTF-8 enumNames 0 English 1 Czech 2 Dutch 3 French 4 German 5 Greek 6 Italian 7 Japanese 8 Korean 9 Norwegian 10 Polish 11 Portuguese 12 PortugueseBrazilian 13 Russian 14 SimplifiedChinese 15 Spanish 16 Swedish 17 Turkish 18 Ukrainian enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:SupportedLocales", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/supportedlocales/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/supportedlocales/index.md" } ] }, { "id": "api/models/supportedthemes/index.md", "kind": "schema", "title": "SupportedThemes", "description": "One of: browser, light and dark.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/supportedthemes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/supportedthemes/index.md", "file": "api/models/supportedthemes/index.md", "searchText": "name SupportedThemes type string format title description default enum 0 browser 1 light 2 dark enumNames 0 Browser 1 Light 2 Dark enumDescriptions const nullable readOnly writeOnly deprecated example examples refName SupportedThemes", "documentId": "schema:SupportedThemes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/supportedthemes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/supportedthemes/index.md" } ] }, { "id": "api/models/audioprocessingmethods/index.md", "kind": "schema", "title": "AudioProcessingMethods", "description": "One of: none, nrj, master_me and stereo_tool.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/audioprocessingmethods/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/audioprocessingmethods/index.md", "file": "api/models/audioprocessingmethods/index.md", "searchText": "name AudioProcessingMethods type string format title description default enum 0 none 1 nrj 2 master_me 3 stereo_tool enumNames 0 None 1 Liquidsoap 2 MasterMe 3 StereoTool enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:AudioProcessingMethods", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/audioprocessingmethods/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/audioprocessingmethods/index.md" } ] }, { "id": "api/models/backendadapters/index.md", "kind": "schema", "title": "BackendAdapters", "description": "One of: liquidsoap and none.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/backendadapters/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/backendadapters/index.md", "file": "api/models/backendadapters/index.md", "searchText": "name BackendAdapters type string format title description default enum 0 liquidsoap 1 none enumNames 0 Liquidsoap 1 None enumDescriptions const nullable readOnly writeOnly deprecated example examples refName BackendAdapters", "documentId": "schema:BackendAdapters", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/backendadapters/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/backendadapters/index.md" } ] }, { "id": "api/models/crossfademodes/index.md", "kind": "schema", "title": "CrossfadeModes", "description": "One of: normal, smart and none.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/crossfademodes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/crossfademodes/index.md", "file": "api/models/crossfademodes/index.md", "searchText": "name CrossfadeModes type string format title description default enum 0 normal 1 smart 2 none enumNames 0 Normal 1 Smart 2 Disabled enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:CrossfadeModes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/crossfademodes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/crossfademodes/index.md" } ] }, { "id": "api/models/frontendadapters/index.md", "kind": "schema", "title": "FrontendAdapters", "description": "One of: icecast, shoutcast2, rsas and remote.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/frontendadapters/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/frontendadapters/index.md", "file": "api/models/frontendadapters/index.md", "searchText": "name FrontendAdapters type string format title description default enum 0 icecast 1 shoutcast2 2 rsas 3 remote enumNames 0 Icecast 1 Shoutcast 2 Rsas 3 Remote enumDescriptions const nullable readOnly writeOnly deprecated example examples refName FrontendAdapters", "documentId": "schema:FrontendAdapters", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/frontendadapters/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/frontendadapters/index.md" } ] }, { "id": "api/models/hlsstreamprofiles/index.md", "kind": "schema", "title": "HlsStreamProfiles", "description": "One of: aac, aac_he and aac_he_v2.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hlsstreamprofiles/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hlsstreamprofiles/index.md", "file": "api/models/hlsstreamprofiles/index.md", "searchText": "name HlsStreamProfiles type string format title description default enum 0 aac 1 aac_he 2 aac_he_v2 enumNames 0 AacLowComplexity 1 AacHighEfficiencyV1 2 AacHighEfficiencyV2 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName HlsStreamProfiles", "documentId": "schema:HlsStreamProfiles", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/hlsstreamprofiles/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/hlsstreamprofiles/index.md" } ] }, { "id": "api/models/mastermepresets/index.md", "kind": "schema", "title": "MasterMePresets", "description": "One of: music_general, speech_general, ebu_r128, apple_podcasts and youtube.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/mastermepresets/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/mastermepresets/index.md", "file": "api/models/mastermepresets/index.md", "searchText": "name MasterMePresets type string format title description default enum 0 music_general 1 speech_general 2 ebu_r128 3 apple_podcasts 4 youtube enumNames 0 MusicGeneral 1 SpeechGeneral 2 EbuR128 3 ApplePodcasts 4 YouTube enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:MasterMePresets", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/mastermepresets/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/mastermepresets/index.md" } ] }, { "id": "api/models/remoteadapters/index.md", "kind": "schema", "title": "RemoteAdapters", "description": "One of: shoutcast1, shoutcast2, icecast and azurarelay.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/remoteadapters/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/remoteadapters/index.md", "file": "api/models/remoteadapters/index.md", "searchText": "name RemoteAdapters type string format title description default enum 0 shoutcast1 1 shoutcast2 2 icecast 3 azurarelay enumNames 0 Shoutcast1 1 Shoutcast2 2 Icecast 3 AzuraRelay enumDescriptions const nullable readOnly writeOnly deprecated example examples refName RemoteAdapters", "documentId": "schema:RemoteAdapters", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/remoteadapters/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/remoteadapters/index.md" } ] }, { "id": "api/models/streamformats/index.md", "kind": "schema", "title": "StreamFormats", "description": "One of: mp3, ogg, aac, opus and flac.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/streamformats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/streamformats/index.md", "file": "api/models/streamformats/index.md", "searchText": "name StreamFormats type string format title description default enum 0 mp3 1 ogg 2 aac 3 opus 4 flac enumNames 0 Mp3 1 Ogg 2 Aac 3 Opus 4 Flac enumDescriptions const nullable readOnly writeOnly deprecated example examples refName StreamFormats", "documentId": "schema:StreamFormats", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/streamformats/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/streamformats/index.md" } ] }, { "id": "api/models/webhooktriggers/index.md", "kind": "schema", "title": "WebhookTriggers", "description": "One of: song_changed, song_changed_live, listener_gained, listener_lost, live_connect, live_disconnect and 2 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/webhooktriggers/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/webhooktriggers/index.md", "file": "api/models/webhooktriggers/index.md", "searchText": "name WebhookTriggers type string format title description default enum 0 song_changed 1 song_changed_live 2 listener_gained 3 listener_lost 4 live_connect 5 live_disconnect 6 station_offline 7 station_online enumNames 0 SongChanged 1 SongChangedLive 2 ListenerGained 3 ListenerLost 4 LiveConnect 5 LiveDisconnect 6 StationOffline 7 StationOnline enumDescriptions const nullable readOnly writeOnly deprecated example examples refName ", "documentId": "schema:WebhookTriggers", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/webhooktriggers/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/webhooktriggers/index.md" } ] }, { "id": "api/models/webhooktypes/index.md", "kind": "schema", "title": "WebhookTypes", "description": "One of: generic, email, tunein, radiode, radioreg, getmeradio and 9 more.", "tab": "api", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/webhooktypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/webhooktypes/index.md", "file": "api/models/webhooktypes/index.md", "searchText": "name WebhookTypes type string format title description default enum 0 generic 1 email 2 tunein 3 radiode 4 radioreg 5 getmeradio 6 discord 7 telegram 8 groupme 9 mastodon 10 bluesky 11 google_analytics_v4 12 matomo_analytics 13 twitter 14 google_analytics enumNames 0 Generic 1 Email 2 TuneIn 3 RadioDe 4 RadioReg 5 GetMeRadio 6 Discord 7 Telegram 8 GroupMe 9 Mastodon 10 Bluesky 11 GoogleAnalyticsV4 12 MatomoAnalytics 13 Twitter 14 GoogleAnalyticsV3 enumDescriptions const nullable readOnly writeOnly deprecated example examples refName WebhookTypes", "documentId": "schema:WebhookTypes", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/api/models/webhooktypes/", "markdown": "https://sourcey-azuracast.pages.dev/docs/api/models/webhooktypes/index.md" } ] }, { "id": "about-this-preview/index.md", "kind": "page", "title": "About this preview", "description": "An unofficial rebuild of the AzuraCast documentation with Sourcey, and how it measures against the current site.", "tab": "@pages", "url": "https://sourcey-azuracast.pages.dev/docs/about-this-preview/", "markdown": "https://sourcey-azuracast.pages.dev/docs/about-this-preview/index.md", "file": "about-this-preview/index.md", "searchText": "\n# About this preview {#about-this-preview}\n\n\nThis is an unofficial preview of the AzuraCast documentation, rebuilt with [Sourcey](https://sourcey.com), an open-source docs engine licensed under AGPL-3.0. It is not run by the AzuraCast project. Search engines are asked not to index it, and it comes down on request, or after 30 days.\n\n\n## What it is built from {#what-it-is-built-from}\n\n\n- The website repository, [AzuraCast/azuracast.com](https://github.com/AzuraCast/azuracast.com) at `c7c1bc6`, converted with `sourcey migrate`: all 52 documentation pages at their current addresses, with every heading link still landing, and the station guide as its own Guides section.\n- The [API reference](/docs/api/) from the `openapi.yml` in the AzuraCast repository, with a page for each of its 269 operations. The documentation's links to `/api` land on the operation they mean.\n- One correction, applied as an overlay rather than to the specification: the station queue responses refer to `App\\Entity\\StationQueue`, a schema the specification never defines.\n\n\n## Measured beside the current site {#measured-beside-the-current-site}\n\n\nBoth sites were built from their own sources and served side by side on one machine, compressed as hosts serve them. Each page was opened in a fresh browser at 1440 by 1000 pixels and measured once the network settled, on 21 October 2026 with Sourcey 3.8.3.\n\n| | Current site | This preview |\n| --- | --- | --- |\n| Page | `/docs/contribute/donate/` | `/docs/contribute/donate/` |\n| Requests | 10 | 5 |\n| Download | 45.2 KB | 37.7 KB |\n| JavaScript heap | 1.1 MB | 0.8 MB |\n| DOM nodes | 752 | 567 |\n| First search, typing \"install\" | 11.6 KB in 1 request | 38.2 KB in 3 requests |\n\nThe API reference's overview downloads 53.4 KB in 6 requests and its heaviest operation page 51.1 KB, each first painting within 0.35 s. As one page the reference came to 24 MB of HTML, so each operation has a page of its own: plain HTML that search engines and assistants can read and anyone can link to.\n\nThe preview builds in 6.6 s from cold, peaking at 1.38 GB of memory, and in 5.3 s with its cache. It writes 72.7 MB, of which 43.5 MB is what readers load (the current site writes 27 MB, 7.2 MB of it for readers); both publish the project's 19.5 MB press kit and promotional audio.\n\n\n## For agents {#for-agents}\n\n\nEvery page and operation is also published as Markdown, with an [llms.txt](/docs/llms.txt), a [documents index](/docs/documents.json), the [OpenAPI bundle](/docs/api/openapi.json), and [ARD](/docs/ard.json) and [API catalog](/docs/api-catalog.json) discovery files.\n\n\n## Links on the current site {#links-on-the-current-site}\n\n\nEvery link in the current documentation lands where it points.\n", "documentId": "about-this-preview", "locale": "en", "contentLocale": "en", "contentVersion": "current", "versionScope": "site", "alternates": [ { "locale": "en", "contentVersion": "current", "url": "https://sourcey-azuracast.pages.dev/docs/about-this-preview/", "markdown": "https://sourcey-azuracast.pages.dev/docs/about-this-preview/index.md" } ] } ] }