Storage Locations

get

List all current storage locations in the system.

Authorizations

Responses

200

Success

application/json

Responseall of[]

403

Access denied.

application/json

500

A generic exception has occurred.

application/json

get

HTTPcURLJavaScriptPython

GET /api/admin/storage_locations HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "links": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "id": 1,
    "type": "station_media",
    "adapter": "local",
    "path": "/var/azuracast/stations/azuratest_radio/media",
    "s3CredentialKey": "your-key-here",
    "s3CredentialSecret": "your-secret-here",
    "s3Region": "your-region",
    "s3Version": "latest",
    "s3Bucket": "your-bucket-name",
    "s3Endpoint": "https://your-region.digitaloceanspaces.com",
    "dropboxAppKey": "",
    "dropboxAppSecret": "",
    "dropboxAuthToken": "",
    "sftpHost": "127.0.0.1",
    "sftpUsername": "root",
    "sftpPassword": "abc123",
    "sftpPort": 20,
    "sftpPrivateKey": "text",
    "sftpPrivateKeyPassPhrase": "text",
    "storageQuota": "50 GB",
    "storageQuotaBytes": "120000",
    "storageUsed": "1 GB",
    "storageUsedBytes": "60000",
    "storageAvailable": "1 GB",
    "storageAvailableBytes": "120000",
    "storageUsedPercent": "75",
    "isFull": "true",
    "uri": "/var/azuracast/www",
    "stations": [
      "AzuraTest Radio"
    ]
  }
]

post

Create a new storage location.

Authorizations

Body

all ofOptional

Responses

200

Success

application/json

Responseall of

403

Access denied.

application/json

500

A generic exception has occurred.

application/json

post

HTTPcURLJavaScriptPython

POST /api/admin/storage_locations HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 818

{
  "links": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "type": "station_media",
  "adapter": "local",
  "path": "/var/azuracast/stations/azuratest_radio/media",
  "s3CredentialKey": "your-key-here",
  "s3CredentialSecret": "your-secret-here",
  "s3Region": "your-region",
  "s3Version": "latest",
  "s3Bucket": "your-bucket-name",
  "s3Endpoint": "https://your-region.digitaloceanspaces.com",
  "dropboxAppKey": "",
  "dropboxAppSecret": "",
  "dropboxAuthToken": "",
  "sftpHost": "127.0.0.1",
  "sftpUsername": "root",
  "sftpPassword": "abc123",
  "sftpPort": 20,
  "sftpPrivateKey": "text",
  "sftpPrivateKeyPassPhrase": "text",
  "storageQuota": "50 GB",
  "storageQuotaBytes": "120000",
  "storageUsed": "1 GB",
  "storageUsedBytes": "60000",
  "storageAvailable": "1 GB",
  "storageAvailableBytes": "120000",
  "storageUsedPercent": "75",
  "isFull": "true",
  "uri": "/var/azuracast/www",
  "stations": [
    "AzuraTest Radio"
  ]
}

{
  "links": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "type": "station_media",
  "adapter": "local",
  "path": "/var/azuracast/stations/azuratest_radio/media",
  "s3CredentialKey": "your-key-here",
  "s3CredentialSecret": "your-secret-here",
  "s3Region": "your-region",
  "s3Version": "latest",
  "s3Bucket": "your-bucket-name",
  "s3Endpoint": "https://your-region.digitaloceanspaces.com",
  "dropboxAppKey": "",
  "dropboxAppSecret": "",
  "dropboxAuthToken": "",
  "sftpHost": "127.0.0.1",
  "sftpUsername": "root",
  "sftpPassword": "abc123",
  "sftpPort": 20,
  "sftpPrivateKey": "text",
  "sftpPrivateKeyPassPhrase": "text",
  "storageQuota": "50 GB",
  "storageQuotaBytes": "120000",
  "storageUsed": "1 GB",
  "storageUsedBytes": "60000",
  "storageAvailable": "1 GB",
  "storageAvailableBytes": "120000",
  "storageUsedPercent": "75",
  "isFull": "true",
  "uri": "/var/azuracast/www",
  "stations": [
    "AzuraTest Radio"
  ]
}

get

Retrieve details for a single storage location.

Authorizations

Path parameters

idinteger · int64Required

User 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

HTTPcURLJavaScriptPython

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

{
  "links": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "type": "station_media",
  "adapter": "local",
  "path": "/var/azuracast/stations/azuratest_radio/media",
  "s3CredentialKey": "your-key-here",
  "s3CredentialSecret": "your-secret-here",
  "s3Region": "your-region",
  "s3Version": "latest",
  "s3Bucket": "your-bucket-name",
  "s3Endpoint": "https://your-region.digitaloceanspaces.com",
  "dropboxAppKey": "",
  "dropboxAppSecret": "",
  "dropboxAuthToken": "",
  "sftpHost": "127.0.0.1",
  "sftpUsername": "root",
  "sftpPassword": "abc123",
  "sftpPort": 20,
  "sftpPrivateKey": "text",
  "sftpPrivateKeyPassPhrase": "text",
  "storageQuota": "50 GB",
  "storageQuotaBytes": "120000",
  "storageUsed": "1 GB",
  "storageUsedBytes": "60000",
  "storageAvailable": "1 GB",
  "storageAvailableBytes": "120000",
  "storageUsedPercent": "75",
  "isFull": "true",
  "uri": "/var/azuracast/www",
  "stations": [
    "AzuraTest Radio"
  ]
}

put

Update details of a single storage location.

Authorizations

Path parameters

idinteger · int64Required

Storage Location 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

HTTPcURLJavaScriptPython

PUT /api/admin/storage_location/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 818

{
  "links": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": 1,
  "type": "station_media",
  "adapter": "local",
  "path": "/var/azuracast/stations/azuratest_radio/media",
  "s3CredentialKey": "your-key-here",
  "s3CredentialSecret": "your-secret-here",
  "s3Region": "your-region",
  "s3Version": "latest",
  "s3Bucket": "your-bucket-name",
  "s3Endpoint": "https://your-region.digitaloceanspaces.com",
  "dropboxAppKey": "",
  "dropboxAppSecret": "",
  "dropboxAuthToken": "",
  "sftpHost": "127.0.0.1",
  "sftpUsername": "root",
  "sftpPassword": "abc123",
  "sftpPort": 20,
  "sftpPrivateKey": "text",
  "sftpPrivateKeyPassPhrase": "text",
  "storageQuota": "50 GB",
  "storageQuotaBytes": "120000",
  "storageUsed": "1 GB",
  "storageUsedBytes": "60000",
  "storageAvailable": "1 GB",
  "storageAvailableBytes": "120000",
  "storageUsedPercent": "75",
  "isFull": "true",
  "uri": "/var/azuracast/www",
  "stations": [
    "AzuraTest Radio"
  ]
}

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

delete

Delete a single storage location.

Authorizations

Path parameters

idinteger · int64Required

Storage Location 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

HTTPcURLJavaScriptPython

DELETE /api/admin/storage_location/{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>"
}