IBM Cloud Object Storage System™ Version 3.13.6 Simple Object HTTP API 2.5 Developer Guide
This developer guide describes the Simple Object HTTP application programming interface (SOH API) of the IBM Cloud Object Storage System, version 3.13.6. The SOH API is a REST API that lets application developers build REST-based applications to access object vaults, and it is part of the Dispersed Storage Object (DSO) API Family. Version 2.5 of the API adds the X-Clv-Request-Id header to all HTTP responses and introduces the URL scheme http://{accesser-ip}/soh/{vault-name}/{object-id}.
The guide explains deployment and client configuration, the API REST URI format, how the API version is determined, request IDs and authentication with a user name and password or an X.509 certificate and private key. It then documents the individual operations: vault listing, vault status query, write object with content digest, read object, delete object, object status and list, followed by notices and trademarks.
| API version header | X-SOH-Version |
|---|---|
| URL scheme (new in version 2.5) | http://{accesser-ip}/soh/{vault-name}/{object-id} |
| Request ID header | X-Clv-Request-Id |
| Authentication methods | User name and password (Basic access authentication, RFC 1945) or X.509 certificate and private key pair (PKI, RFC 2246) |
| Default API in ClevOS 2.8.0 | SOH API |
| HTTPS access | Supported |
All HTTP responses now include an X-Clv-Request-Id header that carries an identifier unique to each response.
The JSON document returned by a vault listing or vault status query indicates the protocol name and version, and each response includes the X-SOH-Version header.
It allows authentication with a user name and password using basic access authentication, or with an X.509 certificate and private key pair for PKI authentication.
The documented URL forms are relative to the SOH API base URL, and the commands are always relative to http://{accesser-ip}/soh/.
It is written for application developers and describes the methods, requests and responses of the Dispersed Storage Network Simple Object HTTP API.