Jump to

• Request
• Response
• Examples

Get supported REST API versions

get

/rest/api/supportedversions

Retrieve a list of the supported REST API versions for this software release.

Request

There are no request parameters for this operation.

Back to Top

Response

200 Response

OK - Requested data is returned in response body

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.

401 Response

Unauthorized - Request lacks valid authentication credentials.

404 Response

This API must not contain a version number

Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get supported REST API versions by submitting a GET request on the REST resource using cURL. For more information about cURL, see Use cURL.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/api/supportedversions"

Example of Accessing the API with Python

The following example shows how to get supported REST API versions by submitting a GET request on the REST resource using Python. This example assumes you have a valid token stored in the token variable. For an example of authenticating with Python, see Authenticate.

import requests
headers = { "Accept":"application/xml", "Authorization":"Bearer " + token }
url  = "https://" + sbcip + "/rest/api/supportedversions"
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200
Server: nginx/1.14.1
Date: Wed, 01 Apr 2020 10:58:18 GMT
Content-Type: application/xml
Transfer-Encoding: chunked
Connection: keep-alive

Example of the Response Body

The following example shows the contents of the response body in XML format.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<response>
  <data>
    <supportedVersions>
      <latestVersion>v1.1</latestVersion>
      <otherVersions>
        <version>v1.0</version>
      </otherVersions>
    </supportedVersions>
  </data>
  <messages/>
  <links/>
</response>

Back to Top