URLs for HCP access through the management API

With the HCP management API, you use one of these formats to specify the resource URL in a request:

A format that starts with admin:

https://admin.hcp-domain-name:9090/mapi/resource-identifier

In this format, hcp-domain-name is the name of the domain associated with the [hcp_system] network.

For example:

https://admin.hcp.example.com:9090/mapi/tenants

To use this format, you need a system-level user account. Additionally, the management API must be configured at the system level to allow access from your client IP address.

A format that starts by identifying a tenant:

https://tenant-name.hcp-domain-name:9090/mapi/resource-identifier

In this format, hcp-domain-name is the name of the domain associated with the tenant management network.

For example:

https://finance.hcp.example.com:9090/mapi/tenants/finance/namespaces

To use this format, you need a tenant-level user account or, if the tenant has granted system-level users administrative access to itself or is the default tenant, a system-level user account. Additionally, for an HCP tenant, the management API must be configured at the tenant level to allow access from your client IP address.

The following considerations apply to these URLs:

The management API requires the use of SSL security with HTTP (HTTPS).

Note: If the HCP system uses a self signed SSL server certificate, the program submitting the management API request must include instructions either to trust the SSL certificate or not to perform SSL certificate verification. With cURL, you specify the instruction not to perform SSL certificate verification by including the -k or --insecure option in the request command line. In Python with PycURL, you do this by setting the SSL_VERIFYPEER option to false or 0 (zero)

The URL must always include the port number 9090. This is the port on which HCP listens for management API requests.

The URL must always include the mapi interface identifier. This identifier is case sensitive.

For information about resource identifiers, see Resources.

© 2015, 2020 Hitachi Vantara LLC. All rights reserved.