Vault status query
The GET method is used to query overall vault status and obtain API version information. When an object identifier is not specified as part of the URL, a JSON document that contains basic protocol name and version information and vault capacity statistics is returned. The HEAD method can also be used to obtain API version information without returning vault status information.
Sample request
GET /vault-name HTTP/1.1
Host: access.example.com
Sample response
HTTP/1.1 200 OK
Server: Cleversafe/3.2.0.0
Accept-Ranges: bytes
Date: Wed, 25 Sep 2013 14:38:12 GMT
X-SOH-Version: 2.5
X-Clv-Request-Id: 18161859-a867-4779-9399-87cfce838496
Content-Length: 348
{
"interface_name": "hydroxide",
"interface_version": "2.5",
"vault_identifier": "8646e9d4-5ee7-4345-a908-0bb8989fd22f",
"vault_name": "vault-name",
"vault_usage": {
"total_size": "239681228800",
"quota_size": "214748364800",
"used_size": "210517893120",
"free_size": "28901191680",
"usable_size": "4230471680"
}
}
The response indicates that it is SOH API version 2.5 and that the vault named vault-name. The vault contains about 196 GiB of data and 27 GiB of free space. The vault has a hard quota of exactly 200 GiB, which means that about 4 GiB of the total available free space can be used.
Status codes
| Code | Status | Description |
|---|---|---|
| 200 | OK | The vault status query was successful. |
| 400 | Bad Request | The request could not be understood by the access server due to malformed syntax. |
| 401 | Unauthorized | User authentication is needed. The request either did not provide correct credentials or the user does not have permission to write to the indicated vault. |
| 403 | Forbidden | The client has insufficient privileges to perform the operation. |
| 500 | Internal Server Error | An internal error was encountered on the access server. It is an unrecoverable error. Details can be provided in message body. |
Response fields
| Field | Description |
|---|---|
| interface_name | Interface name. Callers can use this value to ensure that they are connecting to the correct location. |
| interface_version | Interface version. Callers can use this value to ensure that the server is exposing the appropriate level of functions. |
| vault_identifier | Universally unique identifier (UUID) of the vault accessible at this URL. |
| vault_name | Name of the vault accessible at this URL. |
| vault_usage/total_size | Total number of bytes that could possibly be allocated to this vault. |
| vault_usage/quota_size | Total number of bytes that can be allocated to this vault when accounting for any configured hard quota. |
| vault_usage/used_size | Estimated total number of bytes stored in this vault. |
| vault_usage/free_size | Number of bytes that could be added to this vault. |
| vault_usage/usable_size | Number of bytes that can be added to this vault when accounting for any configured hard quota. |