API reference

Edit online

API REST URI format
Details of the SOH API commands.
API version
The SOH API version can be programmatically determined in two ways.
Request ID
All HTTP responses include a header that is called X-Clv-Request-Id, which includes an identifier that is unique for each response. It can be used by a Cleversafe Support Engineer for diagnostics and troubleshooting purposes. This request ID is logged internally on Accesser appliances on a per-request basis. The purpose of the value is to correlate failures that are presented to a client application with a request that was processed on the server. If client applications encounter a failure during an operation, they can log or output the request ID for use by users.
Authentication
The SOH API allows authentication by using a user name and password or an X.509 certificate and private key pair.
Vault listing
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.
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.
Write object
The PUT method is used to add an object to a vault. An object identifier is generated before the object is stored and returned after the operation is complete. The application should treat the object identifier as an opaque string. An object cannot be overwritten after it is created. Instead, an application must write any new data to a new object and delete the old object. Data that is written to a vault is visible after a response is returned from the write operation. Read and delete operations do not succeed until a write returns.
Content digest
When an object is written, the client can request that the access server calculate a digest on the written content with the X-Digest request header. This digest is returned as a hex-encoded value with the X-Content-Digest response header. The purpose of content digest calculation is to allow clients to verify that the correct information was written across the wire. The calculated digest is not stored with the data. Data at rest integrity is ensured by the integrity codecs that are configured for the vault. Currently, three supported digest algorithms are available. Digest algorithm specifications are not case-sensitive.
Read object
The GET method retrieves a previously stored object by using the object identifier. The URL consists of the vault name followed by the object identifier. An object is not available until it is written. Partially completed objects cannot be accessed with the read operation.
Delete object
The DELETE method removes a previously stored object by using the object identifier. The URL consists of the vault name followed by the object identifier. This operation reports success if the object was deleted from the system.
Object status
The HEAD method returns the status of a previously stored object by using the object identifier. The URL consists of the vault name followed by the object identifier. An object is not available until it is written. Partially completed objects cannot be accessed with the read operation.
List
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.

Parent topic: Simple Object HTTP API 2.5 Developer Reference