Show information about this installation and its update status.

GET

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

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

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

const data = await response.text();

import requests

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

{
  "current_release": "0.20.3",
  "latest_release": "0.20.4",
  "needs_rolling_update": true,
  "needs_release_update": true,
  "rolling_updates_available": 0,
  "can_switch_to_stable": true
}

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

200OKApi_Admin_UpdateDetails

Success

Response fields application/json

current_releasestring | null

The stable-equivalent branch your installation currently appears to be on.

Example

0.20.3

latest_releasestring | null

The current latest stable release of the software.

Example

0.20.4

needs_rolling_updateboolean

If you are on the Rolling Release, whether your installation needs to be updated.

needs_release_updateboolean

Whether a newer stable release is available than the version you are currently using.

rolling_updates_availableinteger

If you are on the Rolling Release, the number of updates released since your version.

can_switch_to_stableboolean

Whether you can seamlessly move from the Rolling Release channel to Stable without issues.

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