List all current storage locations in the system.

GET

https://demo.azuracast.com/api/admin/storage_locations

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

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

const data = await response.text();

import requests

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

[
  {
    "id": 0,
    "type": "backup",
    "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",
    "s3UsePathStyle": false,
    "dropboxAppKey": "",
    "dropboxAppSecret": "",
    "dropboxAuthToken": "",
    "sftpHost": "127.0.0.1",
    "sftpUsername": "root",
    "sftpPassword": "abc123",
    "sftpPort": 20,
    "sftpPrivateKey": "string",
    "sftpPrivateKeyPassPhrase": "string",
    "storageQuotaBytes": "120000",
    "storageQuota": "50 GB",
    "storageUsedBytes": "60000",
    "storageUsed": "1 GB",
    "storageAvailableBytes": "120000",
    "storageAvailable": "1 GB",
    "links": {},
    "storageUsedPercent": "75",
    "isFull": "true",
    "uri": "/var/azuracast/www",
    "stations": [
      "AzuraTest Radio"
    ]
  }
]

{
  "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<HasAutoIncrementId & object & HasLinks & object>

Success

Response fields application/json

Array<HasAutoIncrementId & object & HasLinks & object>

Show child attributes

idintegerrequiredread only

typeStorageLocationTypesbackupstation_mediastation_recordingsstation_podcasts

adapterStorageLocationAdapterslocals3dropboxsftp

pathstring

The local path, if the local adapter is used, or path prefix for S3/remote adapters.

Example

/var/azuracast/stations/azuratest_radio/media

s3CredentialKeystring | null

The credential key for S3 adapters.

Example

your-key-here

s3CredentialSecretstring | null

The credential secret for S3 adapters.

Example

your-secret-here

s3Regionstring | null

The region for S3 adapters.

Example

your-region

s3Versionstring | null

The API version for S3 adapters.

Example

latest

s3Bucketstring | null

The S3 bucket name for S3 adapters.

Example

your-bucket-name

s3Endpointstring | null

The optional custom S3 endpoint S3 adapters.

Example

https://your-region.digitaloceanspaces.com

s3UsePathStyleboolean | null

Example

false

dropboxAppKeystring | null

The optional Dropbox App Key.

Example

dropboxAppSecretstring | null

The optional Dropbox App Secret.

Example

dropboxAuthTokenstring | null

The optional Dropbox Auth Token.

Example

sftpHoststring | null

The host for SFTP adapters

Example

127.0.0.1

sftpUsernamestring | null

The username for SFTP adapters

Example

root

sftpPasswordstring | null

The password for SFTP adapters

Example

abc123

sftpPortinteger | null

The port for SFTP adapters

Example

sftpPrivateKeystring | null

The private key for SFTP adapters

sftpPrivateKeyPassPhrasestring | null

The private key pass phrase for SFTP adapters

storageQuotaBytesany | null

Example

storageQuotastring | null

Example

50 GB

storageUsedBytesany

Example

storageUsedstring

Example

1 GB

storageAvailableBytesany | null

Example

storageAvailablestring

Example

1 GB

linksobjectread only

Show child attributes

[key: string]string

storageUsedPercentinteger | null

Example

isFullboolean

Example

true

uristring

The URI associated with the storage location.

Example

/var/azuracast/www

stationsArray<string> | null

The stations using this storage location, if any.

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