/mgmt/status/default/FilesystemStatus GET

Use the HTTP GET method with the /mgmt/status/default/FilesystemStatus resource to request the current usage of storage capacity on the appliance.

Resource URL

https://host:port/mgmt/status/default/FilesystemStatus
Where port is 5554 by default.

Request headers

The following header must be sent with the request:
Authorization
This header must be sent to perform authentication.

Request body format

None.

Security requirements

The caller must be authenticated as an appliance user with sufficient authority. For more information about security, see Types of user and how they are authenticated and User authorization, credential mapping, and access profiles.

Response status codes

200
Status information retrieved successfully.
400
Invalid data provided.
401
Not authenticated.
The caller must be authenticated as an appliance user. See Types of user and how they are authenticated for more information.
403
Not authorized.
The caller is authenticated but does not the authority to perform this action. See User authorization, credential mapping, and access profiles for more information.

Response headers

Content-Type
This header is returned with a value of application/json.

Response body format

The response is in JSON format. The response includes usage information for storage on the appliance. Each object contains the following fields:
FreeEncrypted
Integer.
Free, or unused and available, encrypted storage space on the appliance. All files placed in encrypted storage are automatically encrypted for security by the appliance.
TotalEncrypted
Integer.
Total encrypted storage space on the appliance (the maximum capacity). All files placed in encrypted storage are automatically encrypted for security by the appliance.
FreeTemporary
Integer.
Free, or unused and available, temporary storage space on the appliance. The appliance uses temporary storage for processing, logging and debugging.
TotalTemporary
Integer.
Total temporary storage space on the appliance. The appliance uses temporary storage for processing, logging and debugging.
FreeInternal
Integer.
Free, or unused and available, internal storage space on the appliance. The appliance uses internal storage for import, export, firmware upgrades and debug captures.
TotalInternal
Integer.
Total internal storage space on the appliance. The appliance uses internal storage for import, export, firmware upgrades and debug captures.

Examples

The following example requests usage information for storage on the appliance.

The following URL is used with the HTTP GET method:
https://localhost:5554/mgmt/status/default/FilesystemStatus
The following listing shows sections from the received response:
{
  "_links": {
    "self": {
      "href": "/mgmt/status/default/FilesystemStatus"
    },
    "doc": {
      "href": "/mgmt/docs/status/FilesystemStatus"
    }
  },
  "FilesystemStatus": {
    "FreeEncrypted": 8683,
    "TotalEncrypted": 15008,
    "FreeTemporary": 4051,
    "TotalTemporary": 4096,
    "FreeInternal": 3071,
    "TotalInternal": 3072
  }
}