Return a list of all currently active AzuraRelay instances.

GET

https://demo.azuracast.com/api/admin/relays/list

curl -X GET 'https://demo.azuracast.com/api/admin/relays/list' \
  -H 'X-API-Key: YOUR_TOKEN'

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

const data = await response.text();

import requests

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

[
  {
    "id": 0,
    "base_url": "https://custom-url.example.com",
    "name": "Relay",
    "is_visible_on_public_pages": true,
    "created_at": "2025-01-31T21:31:58+00:00",
    "updated_at": "2025-01-31T21:31:58+00:00"
  }
]

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

Response

200OKArray<Relay>

Success

Response fields application/json

Array<Relay>

Show child attributes

idintegerrequiredread only

base_urlstring

Example

https://custom-url.example.com

namestring | null

Example

Relay

is_visible_on_public_pagesboolean

Example

true

created_atstring<date-time>

Example

2025-01-31T21:31:58+00:00

updated_atstring<date-time>

Example

2025-01-31T21:31:58+00:00

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