1. REST API for Session Border Controller Release 8.3
  2. Tasks
  3. system

Get file system storage space information

get

https://{managementIp}/rest/{version}/system/storage

Retrieves the remaining and used amount of space in the boot directory, code, and ramdrv devices.

Request

Path Parameters
Query Parameters
Header Parameters
  • The value in the Authorization header must be the string "Bearer {access token}", where {access token} is a valid, unexpired token received in response to a prior /rest/{version}/auth/token request.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

OK - Requested data is returned in response body
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: array
Show Source
Nested Schema : messages
Type: object
Nested Schema : items
Type: object
Show Source
Nested Schema : storage
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

400 Response

The request is malformed in some way or is missing required information and therefore cannot be processed.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

401 Response

Unauthorized - Request lacks valid authentication credentials.
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: array
Show Source
Nested Schema : items
Type: object
Show Source

404 Response

Resource not found
Body ()
Root Schema : response
Type: object
Show Source
Nested Schema : data
Type: object
Nested Schema : messages
Type: object
Show Source
Back to Top

Examples

Example of Accessing the API with cURL

The following example shows how to get file system storage space information 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://10.0.0.2/rest/v1.1/system/storage"

Example of Accessing the API with Python

The following example shows how to get file system storage space information 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://10.0.0.2/rest/v1.1/system/storage"
resp = requests.get(url, headers=headers)

Example of the Response Headers

The following shows an example of the response headers.

HTTP/1.1 200 OK
Date: Thu, 17 Jan 2019 13:07:50 GMT
Cache-Control: no-cache
Content-Length: 637
Content-Type: application/xml
Connection: keep-alive
Keep-Alive: timeout=60, max=99
Last-Modified: Thu, 17 Jan 2019 13:07:50 GMT
X-Appweb-Seq: 37

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>
    <storage>
      <volume>/opt</volume>
      <totalBytes>15614533632</totalBytes>
      <availableBytes>11936608256</availableBytes>
      <usedBytes>3677925376</usedBytes>
    </storage>
    <storage>
      <volume>/code</volume>
      <totalBytes>1950601216</totalBytes>
      <availableBytes>1947521024</availableBytes>
      <usedBytes>3080192</usedBytes>
    </storage>
    <storage>
      <volume>/boot</volume>
      <totalBytes>1949552640</totalBytes>
      <availableBytes>1853411328</availableBytes>
      <usedBytes>96141312</usedBytes>
    </storage>
  </data>
  <messages/>
  <links/>
</response>
Back to Top