IBM Cloud Object Storage System Version 3.14.3 Simple Object HTTP API 2.5 Developer Guide

IBM Cloud Object Storage System™ Version 3.14.3 Simple Object HTTP API 2.5 Developer Guide


IBM Cloud Object Storage System Version 3.14.3 Simple Object HTTP API 2.5 Developer Guide - cover page
Brand
IBM
Category
Storage
Document type
Programming Manual
Language
English
Pages
23
File format
PDF
File size
904 KB
Published
30 November, 2023
Updated
30 November, 2023
MD5 checksum
40AEB9A1F7A5F9821B92125A03107637

About this manual

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.

What's inside

  • Introduction
  • What's new in the 2.5 API
  • Deployment and Client Configuration
  • API REST URI format
  • API version
  • Request ID
  • Authentication
  • Vault listing
  • Write object
  • List

Specifications

API version2.5
Base URL schemehttp://{accesser-ip}/soh/{vault-name}/{object-id}
Authentication methodsUser name and password, or X.509 certificate and private key pair
Request ID headerX-Clv-Request-Id, unique for each response
Version headerX-SOH-Version
HTTPS supportSupported
Default API in ClevOS 2.8.0SOH API
DeploymentAutomatically deployed on IBM Cloud Object Storage Accesser appliances

Frequently asked questions

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.

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.

How can clients determine the SOH API version?

From the JSON document returned by a vault listing or vault status query, or from the X-SOH-Version header included in each server response.

What URL scheme is used to access the SOH API?

http://{accesser-ip}/soh/{vault-name}/{object-id}, where {accesser-ip} is the Accesser appliance address and {vault-name} selects the vault.

Download PDF (904 KB)

More IBM Manuals


View all IBM manuals →