HCP for cloud scale includes RESTful HTTP management application programming interfaces (MAPIs) for the Object Storage Management application and the System Management application. These MAPIs are separate and use separate ports.
System Management
You can execute all functions supported in the System Management application using MAPI methods. The System Management methods are served by the Admin service from any HCP for cloud scale node.
All URLs for the System Management MAPI methods have the following base, or root, uniform resource identifier (URI):
https://hcpcs_cluster:8000/api/admin/
The System Management MAPI is described in Swagger, available from the System Management user interface. Those methods are not described in this document.
Object Storage Management
You can execute all functions supported in the Object Storage Management application and the S3 Console application using MAPI methods. The Object Storage Management management API (MAPI) supports management of the following:
- Storage components and Amazon Simple Storage Service (Amazon S3) settings
- Storage component encryption
- KMIP (Key Management Interoperability Protocol) servers
- Administrative resources such as serial numbers and system events
- User resources such as S3 user credentials and OAuth tokens
- Public information such as available public ports
The Object Storage Management MAPI methods are served by the MAPI Gateway service from any HCP for cloud scale node.
All URLs for the Object Storage Management MAPI methods have the following base, or root, uniform resource identifier (URI):
https://hcpcs_cluster:9099/mapi/v1/
The Object Storage Management MAPI is described in the Management API Reference. It is also described in Swagger, available from the Object Storage Management user interface.