Remote Relays

get

List all current remote relays.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

string · stringOptional

Responses

200

Success

application/json

Responseall of[]

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

get

GET /api/station/{station_id}/remotes HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "links": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "id": 1,
    "display_name": "128kbps MP3",
    "is_visible_on_public_pages": true,
    "type": "icecast",
    "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
  }
]

post

Create a new remote relay.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

string · stringOptional

Body

all ofOptional

Responses

200

Success

application/json

Responseall of

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

post

POST /api/station/{station_id}/remotes HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 532

{
  "links": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "display_name": "128kbps MP3",
  "is_visible_on_public_pages": true,
  "type": "icecast",
  "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": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "display_name": "128kbps MP3",
  "is_visible_on_public_pages": true,
  "type": "icecast",
  "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
}

get

Retrieve details for a single remote relay.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

string · stringOptional

idinteger · int64Required

Remote Relay ID

Responses

200

Success

application/json

Responseall of

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

get

GET /api/station/{station_id}/remote/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "links": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "display_name": "128kbps MP3",
  "is_visible_on_public_pages": true,
  "type": "icecast",
  "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
}

put

Update details of a single remote relay.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

string · stringOptional

idinteger · int64Required

Remote Relay ID

Body

all ofOptional

Responses

200

Success

application/json

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

put

PUT /api/station/{station_id}/remote/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 532

{
  "links": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "display_name": "128kbps MP3",
  "is_visible_on_public_pages": true,
  "type": "icecast",
  "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
}

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

delete

Delete a single remote relay.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

string · stringOptional

idinteger · int64Required

Remote Relay ID

Responses

200

Success

application/json

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

delete

DELETE /api/station/{station_id}/remote/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

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

PreviousQueue NextSFTP Users

Last updated 10 months ago