Settings

PreviousRoles NextStations

Last updated 7 months ago

get

List the current values of all editable system settings.

Authorizations

Responses

200

Success

application/json

403

Access denied.

application/json

500

A generic exception has occurred.

application/json

get

GET /api/admin/settings HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "app_unique_identifier": "text",
  "base_url": "https://your.azuracast.site",
  "instance_name": "My AzuraCast Instance",
  "prefer_browser_url": "false",
  "use_radio_proxy": "false",
  "history_keep_days": 1,
  "always_use_ssl": "false",
  "api_access_control": "*",
  "enable_static_nowplaying": "false",
  "analytics": null,
  "check_for_updates": "true",
  "update_results": "",
  "update_last_run": 1609480800,
  "public_theme": "light",
  "hide_album_art": "false",
  "homepage_redirect_url": "https://example.com/",
  "default_album_art_url": "https://example.com/image.jpg",
  "use_external_album_art_when_processing_media": "false",
  "use_external_album_art_in_apis": "false",
  "last_fm_api_key": "SAMPLE-API-KEY",
  "hide_product_name": "false",
  "public_custom_css": "",
  "public_custom_js": "",
  "internal_custom_css": "",
  "backup_enabled": "false",
  "backup_time_code": 400,
  "backup_exclude_media": "false",
  "backup_keep_copies": 2,
  "backup_storage_location": 1,
  "backup_format": "zip",
  "backup_last_run": 1609480800,
  "backup_last_output": "",
  "setup_complete_time": 1609480800,
  "sync_disabled": "false",
  "sync_last_run": 1609480800,
  "external_ip": "192.168.1.1",
  "geolite_license_key": "",
  "geolite_last_run": 1609480800,
  "enable_advanced_features": false,
  "mail_enabled": "true",
  "mail_sender_name": "AzuraCast",
  "mail_sender_email": "example@example.com",
  "mail_smtp_host": "smtp.example.com",
  "mail_smtp_port": 465,
  "mail_smtp_username": "username",
  "mail_smtp_password": "password",
  "mail_smtp_secure": "true",
  "avatar_service": "libravatar",
  "avatar_default_url": "",
  "acme_email": "",
  "acme_domains": "",
  "ip_source": null
}

put

Update settings to modify any settings provided.

Authorizations

Body

app_unique_identifierstringOptional

base_urlstring | nullableOptional

Site Base URL

Example: https://your.azuracast.site

instance_namestring | nullableOptional

AzuraCast Instance Name

Example: My AzuraCast Instance

prefer_browser_urlbooleanOptional

Prefer Browser URL (If Available)

Example: false

use_radio_proxybooleanOptional

Use Web Proxy for Radio

Example: false

history_keep_daysintegerOptional

Days of Playback History to Keep

always_use_sslbooleanOptional

Always Use HTTPS

Example: false

api_access_controlstring | nullableOptional

API 'Access-Control-Allow-Origin' header

Example: *

enable_static_nowplayingbooleanOptional

Whether to use high-performance static JSON for Now Playing data updates.

Example: false

analyticsany | nullableOptional

Listener Analytics Collection

check_for_updatesbooleanOptional

Check for Updates and Announcements

Example: true

update_last_runintegerOptional

The UNIX timestamp when updates were last checked.

Example: 1609480800

public_themeany | nullableOptional

Base Theme for Public Pages

Example: light

hide_album_artbooleanOptional

Hide Album Art on Public Pages

Example: false

homepage_redirect_urlstring | nullableOptional

Homepage Redirect URL

Example: https://example.com/

default_album_art_urlstring | nullableOptional

Default Album Art URL

Example: https://example.com/image.jpg

use_external_album_art_when_processing_mediabooleanOptional

Attempt to fetch album art from external sources when processing media.

Example: false

use_external_album_art_in_apisbooleanOptional

Attempt to fetch album art from external sources in API requests.

Example: false

last_fm_api_keystring | nullableOptional

An API key to connect to Last.fm services, if provided.

Example: SAMPLE-API-KEY

hide_product_namebooleanOptional

Hide AzuraCast Branding on Public Pages

Example: false

public_custom_cssstring | nullableOptional

Custom CSS for Public Pages

public_custom_jsstring | nullableOptional

Custom JS for Public Pages

internal_custom_cssstring | nullableOptional

Custom CSS for Internal Pages

backup_enabledbooleanOptional

Whether backup is enabled.

Example: false

backup_time_codestring | nullableOptional

The timecode (i.e. 400 for 4:00AM) when automated backups should run.

Example: 400

backup_exclude_mediabooleanOptional

Whether to exclude media in automated backups.

Example: false

backup_keep_copiesintegerOptional

Number of backups to keep, or infinite if zero/null.

Example: 2

backup_storage_locationinteger | nullableOptional

The storage location ID for automated backups.

Example: 1

backup_formatstring | nullableOptional

The output format for the automated backup.

Example: zip

backup_last_runintegerOptional

The UNIX timestamp when automated backup was last run.

Example: 1609480800

backup_last_outputstring | nullableOptional

The output of the latest automated backup task.

setup_complete_timeintegerOptional

The UNIX timestamp when setup was last completed.

Example: 1609480800

sync_disabledbooleanOptional

Temporarily disable all sync tasks.

Example: false

sync_last_runintegerOptional

The last run timestamp for the unified sync task.

Example: 1609480800

external_ipstring | nullableOptional

This installation's external IP.

Example: 192.168.1.1

geolite_license_keystring | nullableOptional

The license key for the Maxmind Geolite download.

geolite_last_runintegerOptional

The UNIX timestamp when the Maxmind Geolite was last downloaded.

Example: 1609480800

enable_advanced_featuresbooleanOptional

Whether to enable 'advanced' functionality in the system that is intended for power users.

Example: false

mail_enabledbooleanOptional

Enable e-mail delivery across the application.

Example: true

mail_sender_namestring | nullableOptional

The name of the sender of system e-mails.

Example: AzuraCast

mail_sender_emailstring | nullableOptional

The e-mail address of the sender of system e-mails.

Example: example@example.com

mail_smtp_hoststring | nullableOptional

The host to send outbound SMTP mail.

Example: smtp.example.com

mail_smtp_portintegerOptional

The port for sending outbound SMTP mail.

Example: 465

mail_smtp_usernamestring | nullableOptional

The username when connecting to SMTP mail.

Example: username

mail_smtp_passwordstring | nullableOptional

The password when connecting to SMTP mail.

Example: password

mail_smtp_securebooleanOptional

Whether to use a secure (TLS) connection when sending SMTP mail.

Example: true

avatar_servicestring | nullableOptional

The external avatar service to use when fetching avatars.

Example: libravatar

avatar_default_urlstring | nullableOptional

The default avatar URL.

acme_emailstring | nullableOptional

ACME (LetsEncrypt) e-mail address.

acme_domainsstring | nullableOptional

ACME (LetsEncrypt) domain name(s).

ip_sourceany | nullableOptional

IP Address Source

Responses

200

Success

application/json

403

Access denied.

application/json

500

A generic exception has occurred.

application/json

put

PUT /api/admin/settings HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 1500

{
  "app_unique_identifier": "text",
  "base_url": "https://your.azuracast.site",
  "instance_name": "My AzuraCast Instance",
  "prefer_browser_url": "false",
  "use_radio_proxy": "false",
  "history_keep_days": 1,
  "always_use_ssl": "false",
  "api_access_control": "*",
  "enable_static_nowplaying": "false",
  "analytics": null,
  "check_for_updates": "true",
  "update_results": "",
  "update_last_run": 1609480800,
  "public_theme": "light",
  "hide_album_art": "false",
  "homepage_redirect_url": "https://example.com/",
  "default_album_art_url": "https://example.com/image.jpg",
  "use_external_album_art_when_processing_media": "false",
  "use_external_album_art_in_apis": "false",
  "last_fm_api_key": "SAMPLE-API-KEY",
  "hide_product_name": "false",
  "public_custom_css": "",
  "public_custom_js": "",
  "internal_custom_css": "",
  "backup_enabled": "false",
  "backup_time_code": 400,
  "backup_exclude_media": "false",
  "backup_keep_copies": 2,
  "backup_storage_location": 1,
  "backup_format": "zip",
  "backup_last_run": 1609480800,
  "backup_last_output": "",
  "setup_complete_time": 1609480800,
  "sync_disabled": "false",
  "sync_last_run": 1609480800,
  "external_ip": "192.168.1.1",
  "geolite_license_key": "",
  "geolite_last_run": 1609480800,
  "enable_advanced_features": false,
  "mail_enabled": "true",
  "mail_sender_name": "AzuraCast",
  "mail_sender_email": "example@example.com",
  "mail_smtp_host": "smtp.example.com",
  "mail_smtp_port": 465,
  "mail_smtp_username": "username",
  "mail_smtp_password": "password",
  "mail_smtp_secure": "true",
  "avatar_service": "libravatar",
  "avatar_default_url": "",
  "acme_email": "",
  "acme_domains": "",
  "ip_source": null
}

{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}