Introduction to the HCP management API

The Hitachi Content Platform (HCP) management API is a RESTful HTTP interface to a subset of the administrative functions of an HCP system. Using this API, you can manage tenants, namespaces, retention classes, content classes, tenant-level user and group accounts, and replication of HCP tenants and namespaces and default-namespace directories.

Each entity you can manage is referred to as a resource. Each resource has properties that provide information about it.

This chapter:

Describes what you can do with the management API

Explains who can use the management API

Contains an introduction to resources and properties

Lists the HTTP methods supported by the management API

Describes the input and output formats supported by the management API

Introduces query parameters that can be used with resource requests

Describes HCP-specific headers that are returned in response to resource requests

Provides instructions for enabling the management API

To learn about tenants, namespaces, retention classes, content classes, user and group accounts, and replication, see Administering HCP, Managing a Tenant and Its Namespaces, Managing the Default Tenant and Namespaces, and Replicating Tenants and Namespaces.

Note:  

Most of the examples in this book use cURL and Python with PycURL, a Python interface that uses the libcurl library. cURL and PycURL are both freely available open-source software. You can download them from http://curl.haxx.se.

In version 7.12.1 of PycURL, the PUT method was deprecated and replaced with UPLOAD. The Python examples in this book show UPLOAD but work equally well with PUT.

Trademark and LegalDisclaimer

© 2016 Hitachi Data Systems Corporation. All rights reserved.