Retrieve details for a single remote relay.

GET

https://demo.azuracast.com/api/station/{station_id}/remote/{id}

curl -X GET 'https://demo.azuracast.com/api/station/0/remote/0' \
  -H 'X-API-Key: YOUR_TOKEN'

const response = await fetch('https://demo.azuracast.com/api/station/0/remote/0', {
  method: 'GET',
  headers: {
    'X-API-Key': 'YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://demo.azuracast.com/api/station/0/remote/0',
    headers={
        'X-API-Key': 'YOUR_TOKEN',
    },
)
print(response.text)

{
  "id": 0,
  "display_name": "128kbps MP3",
  "is_visible_on_public_pages": true,
  "type": "shoutcast1",
  "is_editable": "true",
  "enable_autodj": false,
  "autodj_format": "mp3",
  "autodj_bitrate": 128,
  "custom_listen_url": "https://custom-listen-url.example.com/stream.mp3",
  "url": "https://custom-url.example.com",
  "mount": "/stream.mp3",
  "admin_password": "password",
  "source_port": 8000,
  "source_mount": "/",
  "source_username": "source",
  "source_password": "password",
  "is_public": false,
  "listeners_unique": 10,
  "listeners_total": 12,
  "links": {}
}

{
  "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
}

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

Parameters

station_idinteger | stringrequiredpath

idinteger<int64>requiredpath

Remote Relay ID

Response

200OKHasAutoIncrementId & object & HasLinks

Success

Response fields application/json

idintegerrequiredread only

display_namestring

Example

128kbps MP3

is_visible_on_public_pagesboolean

Example

true

typeRemoteAdaptersshoutcast1shoutcast2icecastazurarelay

is_editablebooleanread only

Example

true

enable_autodjboolean

Example

false

autodj_formatStreamFormats | null

Show child attributes

One of

StreamFormatsmp3oggaacopusflac

Example

mp3

autodj_bitrateinteger | null

Example

custom_listen_urlstring | null

Example

https://custom-listen-url.example.com/stream.mp3

urlstring

Example

https://custom-url.example.com

mountstring | null

Example

/stream.mp3

admin_passwordstring | null

Example

password

source_portinteger | null

Example

source_mountstring | null

Example

source_usernamestring | null

Example

source

source_passwordstring | null

Example

password

is_publicboolean

Example

false

listeners_uniqueinteger

The most recent number of unique listeners.

Example

listeners_totalinteger

The most recent number of total (non-unique) listeners.

Example

linksobjectread only

Show child attributes

[key: string]string

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

404Not FoundApi_Error

Record not found.

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