IBM Cloud Object Storage System 3.13.6 Simple Object HTTP API 2.5 Developer Guide

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


IBM Cloud Object Storage System 3.13.6 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
44CB112C84473D974C463E5766C8A4AB

About this manual

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.

What's inside

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

Specifications

API version headerX-SOH-Version
URL scheme (new in version 2.5)http://{accesser-ip}/soh/{vault-name}/{object-id}
Request ID headerX-Clv-Request-Id
Authentication methodsUser 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.0SOH API
HTTPS accessSupported

Frequently asked questions

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.

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.

What authentication methods does the SOH API support?

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.

What URL form do the SOH API commands use?

The documented URL forms are relative to the SOH API base URL, and the commands are always relative to http://{accesser-ip}/soh/.

Who is the guide intended for?

It is written for application developers and describes the methods, requests and responses of the Dispersed Storage Network Simple Object HTTP API.

Download PDF (904 KB)

More IBM Manuals


View all IBM manuals →