REST, S3 compatible, and WebDav API configuration

Content Platform Tenant Management Help

Version
9.7.x
File Size
4269 KB
Audience
anonymous
Part Number
MK-95HCPH002-19

You use the HTTP(S) panel to enable and configure the REST, S3 compatible, and WebDAV APIs for a namespace. To display this panel, on the left side of the Protocols panel, click HTTP(S).

Although you use a single panel to enable these protocols, you enable or disable them independently of each other.

Before you can enable the S3 compatible API for a namespace, ACLs must be enabled for the namespace.

The top of the HTTP(S) panel shows the URL for access to the namespace through the REST API. If the HTTPS port is open or if neither the HTTPS or HTTP port is open, this URL starts with https. If only the HTTP port is open, the URL starts with http.

Note: Certain countries prohibit the export of encryption technology. HCP systems shipped to restricted countries have the HTTPS option on the namespace protocols page disabled. If you do not see the checkbox to enable HTTPS and you are in a country where SSL encryption is permitted, please contact your HCP system administrator.

The HTTP(S) panel lets you:

  • Enable the REST API.
  • Enable the S3 compatible API.
  • Enable the WebDAV API.
  • Specify whether the REST, S3 compatible, and WebDAV APIs require the use of SSL security.
  • Specify whether the REST, S3 compatible APIs require user authentication for access to the namespace.
  • If the tenant supports user authentication with Active Directory, specify whether HCP supports AD single sign-on for REST and S3 compatible APIs access to the namespace. This affects the Namespace Browser, HCP Search Console, and other HTTP-based applications that support Integrated Windows authentication.
  • Specify whether the WebDAV API requires basic authentication for access to the namespace.
  • If WebDAV basic authentication is enabled, specify the username and password against which HCP authenticates WebDAV access to the namespace.

    The username and password you specify for WebDAV basic authentication has no relationship to HCP or AD user accounts.

    Tip: Be sure to give WebDAV users the specified username and password.
  • Specify whether WebDAV dead properties can be stored as custom metadata. If they can be, they are stored in the annotation named default.
  • Specify the client IP addresses that have access to the namespace through the REST, S3 compatible, and WebDAV APIs.

By default, when a namespace is first created, the REST API is enabled with authentication required. If the HCP system supports the use of SSL for data access, the REST API also requires the use of SSL security by default.