Service Control

get

Retrieve the current status of all serivces associated with the radio broadcast.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
Responses
200

Success

application/json
get
GET /api/station/{station_id}/status HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "backend_running": true,
  "frontend_running": true,
  "station_has_started": true,
  "station_needs_restart": true
}
post

Restart all services associated with the radio broadcast.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
Responses
200

Success

application/json
post
POST /api/station/{station_id}/restart 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>"
}
post

Perform service control actions on the radio frontend (Icecast, Shoutcast, etc.)

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
actionstringOptional

The action to perform (start, stop, restart)

Default: restart
Responses
200

Success

application/json
post
POST /api/station/{station_id}/frontend/{action} 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>"
}
post

Perform service control actions on the radio backend (Liquidsoap)

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
actionstringOptional

The action to perform (for all: start, stop, restart, skip, disconnect)

Default: restart
Responses
200

Success

application/json
post
POST /api/station/{station_id}/backend/{action} 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>"
}

Last updated