List

Edit online

The GET method that is used with the X-Operation header set to list retrieves a full or partial listing of objects that are stored in the vault. The URL consists of the vault name.

This operation is inefficient and is recommended for use in recovery scenarios only. List results are sorted numerically. The amount of data that is returned can be large. If transmission is interrupted, a list operation can be resumed by using the X-Start-Id header to indicate the last returned object identifier. Listing will resume after the indicated start object identifier, which will not be returned at the beginning of the listing.

Sample request


GET /vault-name HTTP/1.1
Host: access.example.com
X-Operation: list
X-Start-Id: 0af2592884594185968ab68cb51b0f2a0000
The list of stored objects is retrieved from a vault that is named vault-name by using the access server access.example.com. The X-Start-Id header is optional. When omitted, a complete list is retrieved. When present, listing starts after the indicated object identifier.

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: ba30f684-7fb9-49bc-928e-ee05aa832096
Content-Length: 222
196b9e5c94d64afbb23901d6806170bf0000
6f8c571646554dbbb6a3c9429b47f1340000
9d82186423354edc9fddd43dd969adfa0000
d6133cd067ad4ea38cdcd1faa1e4e9040000
dc559d4b6602476d870c65673756be010000
e5c4483d371a44cf991e5fa4cf36caf00000
The response contains a list of object identifiers that are delimited by the end-of-line character.

Status codes

Table 1. List - status codes
Code Status Description
200 OK The object was successfully written to the vault.
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 read from 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.

Limiting list results

The X-List-Length-Limit header will cause listing to stop after the indicated number of object identifiers is returned. A client can also stop listing by closing the connection.