Key facts
Start here

IBM Cloud Object Storage System Version 3.14.3 Simple Object HTTP API 2.5 Developer Guide
Published by IBM, this developer guide describes the Simple Object HTTP (SOH) API 2.5 for IBM Cloud Object Storage System Version 3.14.3. It explains the REST URI format, API version reporting, request IDs, authentication, and the requests for vault listing and status, object write, read, delete, and listing.
According to the guide, the SOH API is part of the Dispersed Storage Object API Family and is automatically deployed on IBM Cloud Object Storage Accesser appliances. Clients reach it at http://{accesser-ip}/soh/{vault-name}/{object-id}, or at the root URL when the SOH API is set as the default API; HTTPS access is also supported. Version 2.5 adds the X-Clv-Request-Id response header.
IBM Simple Object HTTP API 2.5 specifications
| API version | 2.5 |
|---|---|
| Base URL scheme | http://{accesser-ip}/soh/{vault-name}/{object-id} |
| Authentication methods | User name and password, or X.509 certificate and private key pair |
| Request ID header | X-Clv-Request-Id, unique for each response |
| Version header | X-SOH-Version |
| HTTPS support | Supported |
| Default API in ClevOS 2.8.0 | SOH API |
| Deployment | Automatically deployed on IBM Cloud Object Storage Accesser appliances |
Source: IBM Cloud Object Storage System Version 3.14.3 Simple Object HTTP API 2.5 Developer Guide
All IBM Simple Object HTTP API 2.5 documents by type
Instruction set, parameters and examples for configuring or programming the device.
Questions answered in these manuals
What is the SOH API?
The Simple Object HTTP API is a REST API that lets application developers access object vaults on an IBM Cloud Object Storage System; it is part of the Dispersed Storage Object API Family.
From: IBM Cloud Object Storage System Version 3.14.3 Simple Object HTTP API 2.5 Developer Guide
What is new in the 2.5 API?
All HTTP responses now include an X-Clv-Request-Id header with an identifier unique to each response, which can be used by a Cleversafe Support Engineer for diagnostics and troubleshooting.
From: IBM Cloud Object Storage System Version 3.14.3 Simple Object HTTP API 2.5 Developer Guide
What is new in the Simple Object HTTP API 2.5?
All HTTP responses now include an X-Clv-Request-Id header that carries an identifier unique to each response.
From: IBM Cloud Object Storage System 3.13.6 Simple Object HTTP API 2.5 Developer Guide
How can I determine the SOH API version?
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.
From: IBM Cloud Object Storage System 3.13.6 Simple Object HTTP API 2.5 Developer Guide
