API REST URI format

Details of the SOH API commands.

An overview of the command set is shown in the table.
Table 1. SOH API REST URI Formats
Operation URL Form Method Headers Output
Vault Listing / GET   JSON Document
Vault Status /vault-name GET   JSON Document
Write Object /vault-name PUT X-Digest Object Identifier
Read Object /vault-name/object-id GET   Source Data
Delete Object /vault-name/object-id DELETE  
Object Status /vault-name/object-id HEAD  
List /vault-name GET X-Operation, X-Start-Id, X-List-Length-Limit Object Identifiers
The URL forms that are documented in the table are relative to the SOH API base URL. These commands are always relative to http://{accesser-ip}/soh/. When the default API is configured to SOH API, they are also available relative to http://{accesser-ip}/.
Note: For more information, see Deployment and Client Configuration.