The GET method is used to list all of the vaults that are deployed to
a specific Accesser appliance. When a vault name is not specified as part of the URL, a JSON
document that contains basic protocol name and version information and a vault listing is
returned. The HEAD method can also be used to obtain API version information
without returning a vault listing.
Sample request
GET / HTTP/1.1
Host: access.example.com
Requests protocol and vault
listing.
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: 40c5252a-716b-4a96-ac51-af0a5aa0893d
Content-Length: 316
{
"interface_name": "hydroxide",
"interface_version": "2.5",
"vaults": [
{
"vault_identifier": "7bb87f5b-72ce-4ec5-a487-363b10000716",
"vault_name": "vault-name"
},
{
"vault_identifier": "06a2beb3-8d3c-4cc0-9a28-acaca84d7f2c",
"vault_name": "other-vault-name"
}
]
}
The response indicates that it is SOH API v2.5 and that two vaults exist, one named vault-name
and another named other-vault-name.
Status codes
Table 1. Vault listing - status codes
| Code |
Status |
Description |
| 200 |
OK |
Vault listing query was successful. |
| 400 |
Bad Request |
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 |
Client has insufficient privileges to perform the operation. |
| 500 |
Internal Server Error |
Internal error was encountered on the access server. It is an unrecoverable error.
Details can be provided in message body. |
Response fields
Table 2. Vault listing - 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 |
The interface version. Callers can use this value to ensure that the server is
exposing the appropriate level of functions. |
| vaults/vault_identifier |
The universally unique identifier (UUID) of the vault this listing describes. |
| vaults/vault_name |
The name of the vault this listing describes. |