< Previous | Contents | Next >

About the HCP HS3 API

The HCP HS3 API is a RESTful, HTTP-based API that is compatible with Amazon S3. Using this API, you can:

Create buckets (PUT bucket)

List the buckets you own (GET service)

Check the existence of a bucket (HEAD bucket)

Add ACLs to existing buckets (PUT bucket acl)

Retrieve ACLs for buckets (GET bucket acl)

Enable or suspend object versioning for buckets you own (PUT bucket versioning)

Check the status of object versioning for buckets you own (GET bucket versioning)

List objects that are in a bucket (GET bucket)

List versions of objects that are in a bucket (GET bucket versions)

Delete buckets you own, as long as the buckets don’t have any objects in them (DELETE bucket)

Store objects in a bucket (PUT object)

Create folders in a bucket (PUT object/)

Add custom metadata to existing objects, where the custom metadata is specified as property/value pairs (PUT object copy replace)

Check the existence of an object or folder (HEAD object)

Retrieve custom metadata for objects (HEAD object)

Add ACLs to existing objects (PUT object acl)

Retrieve ACLs for objects (GET object acl)

Copy objects (PUT object copy)

Chapter 1: Introduction to Hitachi Content Platform 5

Other bucket access methods

Retrieve objects (GET object)

Delete objects (DELETE object)

To use the HS3 API to perform the operations listed above, you can write applications that use any standard HTTP client library. HS3 is also compatible with many third-party tools that support Amazon S3. For information on configuring third-party tools for use with HS3, see Appendix C, “Using third-party tools with HS3,” on page 213.