REST API for Session Border Controller, Enterprise Session Border Controller, and Subscriber-Aware Load Balancer, Release 9.3.0

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

version(required): string

REST API version string.
Available values: v1.2

Allowed Values: [ "v1.2" ]

Query Parameters

volume: string

The file system volume

Header Parameters

Authorization(required):

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.

Response

Supported Media Types

application/xml

200 Response

OK - Requested data is returned in response body

Root Schema : response

Type: object

Show Source

data(required): array data
links(required): object links
messages(required): object messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "storage":{
                        "type":"array",
                        "items":{
                            "type":"object",
                            "required":[
                                "volume",
                                "totalBytes",
                                "availableBytes",
                                "usedBytes"
                            ],
                            "properties":{
                                "volume":{
                                    "type":"string",
                                    "example":"/boot"
                                },
                                "totalBytes":{
                                    "type":"integer",
                                    "example":"1995030528"
                                },
                                "availableBytes":{
                                    "type":"integer",
                                    "example":"1682923520"
                                },
                                "usedBytes":{
                                    "type":"integer",
                                    "example":"312107008"
                                }
                            }
                        }
                    }
                }
            }
        },
        "messages":{
            "type":"object"
        },
        "links":{
            "type":"object"
        }
    }
}

Nested Schema : data

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "storage":{
                "type":"array",
                "items":{
                    "type":"object",
                    "required":[
                        "volume",
                        "totalBytes",
                        "availableBytes",
                        "usedBytes"
                    ],
                    "properties":{
                        "volume":{
                            "type":"string",
                            "example":"/boot"
                        },
                        "totalBytes":{
                            "type":"integer",
                            "example":"1995030528"
                        },
                        "availableBytes":{
                            "type":"integer",
                            "example":"1682923520"
                        },
                        "usedBytes":{
                            "type":"integer",
                            "example":"312107008"
                        }
                    }
                }
            }
        }
    }
}

Nested Schema : links

Type: object

Nested Schema : messages

Type: object

Nested Schema : items

Type: object

Show Source

storage: array storage

{
    "type":"object",
    "properties":{
        "storage":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "volume",
                    "totalBytes",
                    "availableBytes",
                    "usedBytes"
                ],
                "properties":{
                    "volume":{
                        "type":"string",
                        "example":"/boot"
                    },
                    "totalBytes":{
                        "type":"integer",
                        "example":"1995030528"
                    },
                    "availableBytes":{
                        "type":"integer",
                        "example":"1682923520"
                    },
                    "usedBytes":{
                        "type":"integer",
                        "example":"312107008"
                    }
                }
            }
        }
    }
}

Nested Schema : storage

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "volume",
            "totalBytes",
            "availableBytes",
            "usedBytes"
        ],
        "properties":{
            "volume":{
                "type":"string",
                "example":"/boot"
            },
            "totalBytes":{
                "type":"integer",
                "example":"1995030528"
            },
            "availableBytes":{
                "type":"integer",
                "example":"1682923520"
            },
            "usedBytes":{
                "type":"integer",
                "example":"312107008"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

availableBytes(required): integer

Example: 1682923520
totalBytes(required): integer

Example: 1995030528
usedBytes(required): integer

Example: 312107008
volume(required): string

Example: /boot

{
    "type":"object",
    "required":[
        "volume",
        "totalBytes",
        "availableBytes",
        "usedBytes"
    ],
    "properties":{
        "volume":{
            "type":"string",
            "example":"/boot"
        },
        "totalBytes":{
            "type":"integer",
            "example":"1995030528"
        },
        "availableBytes":{
            "type":"integer",
            "example":"1682923520"
        },
        "usedBytes":{
            "type":"integer",
            "example":"312107008"
        }
    }
}

400 Response

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

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

401 Response

Unauthorized - Request lacks valid authentication credentials.

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): array links
messages(required): array messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "errorMessage":{
                        "type":"string",
                        "example":"Error message string"
                    }
                }
            }
        },
        "links":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "link":{
                        "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                        "type":"string",
                        "example":"Available URL(s) message string"
                    }
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "link":{
                "description":"If available, a message with possible valid API URL(s) for the client to invoke",
                "type":"string",
                "example":"Available URL(s) message string"
            }
        }
    }
}

Nested Schema : messages

Type: array

Show Source

Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "errorMessage":{
                "type":"string",
                "example":"Error message string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

link: string

If available, a message with possible valid API URL(s) for the client to invoke

Example: Available URL(s) message string

{
    "type":"object",
    "properties":{
        "link":{
            "description":"If available, a message with possible valid API URL(s) for the client to invoke",
            "type":"string",
            "example":"Available URL(s) message string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

errorMessage: string

Example: Error message string

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Error message string"
        }
    }
}

404 Response

Resource not found

Root Schema : response

Type: object

Show Source

data(required): object data
links(required): object links
messages(required): object messages

{
    "xml":{
        "name":"response"
    },
    "type":"object",
    "required":[
        "data",
        "messages",
        "links"
    ],
    "properties":{
        "data":{
            "type":"object"
        },
        "messages":{
            "type":"object",
            "properties":{
                "errorMessage":{
                    "type":"string",
                    "example":"Unknown resource requested: [POST]:system/storage"
                }
            }
        },
        "links":{
            "type":"object",
            "properties":{
                "link":{
                    "type":"string",
                    "example":"https://thewater-sd/rest/v1.1/system/storage"
                }
            }
        }
    }
}

Nested Schema : data

Type: object

Nested Schema : links

Type: object

Show Source

link: string

Example: https://thewater-sd/rest/v1.1/system/storage

{
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "example":"https://thewater-sd/rest/v1.1/system/storage"
        }
    }
}

Nested Schema : messages

Type: object

Show Source

errorMessage: string

Example: Unknown resource requested: [POST]:system/storage

{
    "type":"object",
    "properties":{
        "errorMessage":{
            "type":"string",
            "example":"Unknown resource requested: [POST]:system/storage"
        }
    }
}

Examples

Examples of Accessing the API

See Authenticate for how to acquire a token.

curl
Python

The following example shows how to get file system storage space information using curl.

curl -X GET \
    --header "Accept: application/xml" \
    --header "Authorization: Bearer $TOKEN" \
    "https://${SBCIP}/rest/v1.2/system/storage"

The following example shows how to get file system storage space information using Python.

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

Example of the Response Body

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

<?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>