Update settings to modify any settings provided.

PUT

https://demo.azuracast.com/api/admin/settings

curl -X PUT 'https://demo.azuracast.com/api/admin/settings' \
  -H 'X-API-Key: YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "app_unique_identifier": "string",
  "base_url": "https://your.azuracast.site",
  "instance_name": "My AzuraCast Instance",
  "prefer_browser_url": "false",
  "use_radio_proxy": "false",
  "history_keep_days": 0,
  "always_use_ssl": "false",
  "api_access_control": "*",
  "enable_liquidsoap_editing": "true",
  "enable_all_webhooks": "true",
  "filter_local_user_urls": "true",
  "enable_static_nowplaying": "false",
  "analytics": "all",
  "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,
  "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": "local"
}'

const body = `{
  "app_unique_identifier": "string",
  "base_url": "https://your.azuracast.site",
  "instance_name": "My AzuraCast Instance",
  "prefer_browser_url": "false",
  "use_radio_proxy": "false",
  "history_keep_days": 0,
  "always_use_ssl": "false",
  "api_access_control": "*",
  "enable_liquidsoap_editing": "true",
  "enable_all_webhooks": "true",
  "filter_local_user_urls": "true",
  "enable_static_nowplaying": "false",
  "analytics": "all",
  "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,
  "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": "local"
}`;

const response = await fetch('https://demo.azuracast.com/api/admin/settings', {
  method: 'PUT',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
    'Content-Type': 'application/json',
  },
  body,
});

const data = await response.text();

import requests

body = '''{
  "app_unique_identifier": "string",
  "base_url": "https://your.azuracast.site",
  "instance_name": "My AzuraCast Instance",
  "prefer_browser_url": "false",
  "use_radio_proxy": "false",
  "history_keep_days": 0,
  "always_use_ssl": "false",
  "api_access_control": "*",
  "enable_liquidsoap_editing": "true",
  "enable_all_webhooks": "true",
  "filter_local_user_urls": "true",
  "enable_static_nowplaying": "false",
  "analytics": "all",
  "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,
  "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": "local"
}'''

response = requests.put(
    'https://demo.azuracast.com/api/admin/settings',
    data=body.encode('utf-8'),
    headers={
        'X-API-Key': 'YOUR_TOKEN',
        'Content-Type': 'application/json',
    },
)
print(response.text)

Request Body

{
  "app_unique_identifier": "string",
  "base_url": "https://your.azuracast.site",
  "instance_name": "My AzuraCast Instance",
  "prefer_browser_url": "false",
  "use_radio_proxy": "false",
  "history_keep_days": 0,
  "always_use_ssl": "false",
  "api_access_control": "*",
  "enable_liquidsoap_editing": "true",
  "enable_all_webhooks": "true",
  "filter_local_user_urls": "true",
  "enable_static_nowplaying": "false",
  "analytics": "all",
  "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,
  "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": "local"
}

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

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

{
  "code": 500,
  "type": "NotLoggedInException",
  "message": "Error description.",
  "formatted_message": "<b>Error description.</b><br>Detailed error text.",
  "extra_data": [],
  "success": false
}

Body

application/json

app_unique_identifierstring

base_urlstring | null

Site Base URL

Example

https://your.azuracast.site

instance_namestring | null

AzuraCast Instance Name

Example

My AzuraCast Instance

prefer_browser_urlboolean

Prefer Browser URL (If Available)

Example

false

use_radio_proxyboolean

Use Web Proxy for Radio

Example

false

history_keep_daysinteger

Days of Playback History to Keep

always_use_sslboolean

Always Use HTTPS

Example

false

api_access_controlstring | null

API ‘Access-Control-Allow-Origin’ header

Example

enable_liquidsoap_editingboolean

Allow stations to manually edit Liquidsoap code.

Example

true

enable_all_webhooksboolean

Allow stations to dispatch webhooks.

Example

true

filter_local_user_urlsboolean

Prevent users from using local IPs or URLs in Webhooks, etc.

Example

true

enable_static_nowplayingboolean

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

Example

false

analyticsAnalyticsLevel | null

Listener Analytics Collection

Show child attributes

One of

AnalyticsLevelallno_ipnone

check_for_updatesboolean

Check for Updates and Announcements

Example

true

update_resultsApi_Admin_UpdateDetails | null

Results of the latest update check.

Show child attributes

One of

current_releasestring | null

The stable-equivalent branch your installation currently appears to be on.

Example

0.20.3

latest_releasestring | null

The current latest stable release of the software.

Example

0.20.4

needs_rolling_updateboolean

If you are on the Rolling Release, whether your installation needs to be updated.

needs_release_updateboolean

Whether a newer stable release is available than the version you are currently using.

rolling_updates_availableinteger

If you are on the Rolling Release, the number of updates released since your version.

can_switch_to_stableboolean

Whether you can seamlessly move from the Rolling Release channel to Stable without issues.

Example

update_last_runinteger

The UNIX timestamp when updates were last checked.

Example

1609480800

public_themeSupportedThemes | null

Base Theme for Public Pages

Show child attributes

One of

SupportedThemesbrowserlightdark

Example

light

hide_album_artboolean

Hide Album Art on Public Pages

Example

false

homepage_redirect_urlstring | null

Homepage Redirect URL

Example

https://example.com/

default_album_art_urlstring | null

Default Album Art URL

Example

https://example.com/image.jpg

use_external_album_art_when_processing_mediaboolean

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

Example

false

use_external_album_art_in_apisboolean

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

Example

false

last_fm_api_keystring | null

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

Example

SAMPLE-API-KEY

hide_product_nameboolean

Hide AzuraCast Branding on Public Pages

Example

false

public_custom_cssstring | null

Custom CSS for Public Pages

Example

public_custom_jsstring | null

Custom JS for Public Pages

Example

internal_custom_cssstring | null

Custom CSS for Internal Pages

Example

backup_enabledboolean

Whether backup is enabled.

Example

false

backup_time_codestring | null

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

Example

backup_exclude_mediaboolean

Whether to exclude media in automated backups.

Example

false

backup_keep_copiesinteger

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

Example

backup_storage_locationinteger | null

The storage location ID for automated backups.

Example

backup_formatstring | null

The output format for the automated backup.

Example

zip

backup_last_runinteger

The UNIX timestamp when automated backup was last run.

Example

1609480800

backup_last_outputstring | null

The output of the latest automated backup task.

Example

setup_complete_timeinteger

The UNIX timestamp when setup was last completed.

Example

1609480800

sync_disabledboolean

Temporarily disable all sync tasks.

Example

false

sync_last_runinteger

The last run timestamp for the unified sync task.

Example

1609480800

external_ipstring | null

This installation’s external IP.

Example

192.168.1.1

geolite_license_keystring | null

The license key for the Maxmind Geolite download.

Example

geolite_last_runinteger

The UNIX timestamp when the Maxmind Geolite was last downloaded.

Example

1609480800

mail_enabledboolean

Enable e-mail delivery across the application.

Example

true

mail_sender_namestring | null

The name of the sender of system e-mails.

Example

AzuraCast

mail_sender_emailstring | null

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

Example

example@example.com

mail_smtp_hoststring | null

The host to send outbound SMTP mail.

Example

smtp.example.com

mail_smtp_portinteger

The port for sending outbound SMTP mail.

Example

mail_smtp_usernamestring | null

The username when connecting to SMTP mail.

Example

username

mail_smtp_passwordstring | null

The password when connecting to SMTP mail.

Example

password

mail_smtp_secureboolean

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

Example

true

avatar_servicestring | null

The external avatar service to use when fetching avatars.

Example

libravatar

avatar_default_urlstring | null

The default avatar URL.

Example

acme_emailstring | null

ACME (LetsEncrypt) e-mail address.

Example

acme_domainsstring | null

ACME (LetsEncrypt) domain name(s).

Example

ip_sourceIpSources | null

IP Address Source

Show child attributes

One of

IpSourceslocalxffcloudflare

Response

200OKApi_Status

Success

Response fields application/json

successbooleanrequired

Example

true

messagestringrequired

Example

Changes saved successfully.

formatted_messagestringrequired

Example

<b>Changes saved successfully.</b>

403ForbiddenApi_Error

Access denied.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

500Internal Server ErrorApi_Error

A generic exception has occurred.

Response fields application/json

codeintegerrequired

The numeric code of the error.

Example

typestringrequired

The programmatic class of error.

Example

NotLoggedInException

messagestringrequired

The text description of the error.

Example

Error description.

formatted_messagestring | nullrequired

The HTML-formatted text description of the error.

Example

<b>Error description.</b><br>Detailed error text.

extra_dataArray<any>required

Stack traces and other supplemental data.

successbooleanrequired

Used for API calls that expect an \Entity\Api\Status type response.

Example

false

Authorization

ApiKeyapiKey in header

Docs by Sourcey