What you can do with the management API

The HCP management API lets you work with tenants, namespaces, retention classes, content classes, tenant-level user and group accounts, and replication.

For tenants, you can:

Create or modify HCP tenants or the default tenant

Delete HCP tenants

Retrieve information about a single tenant

Retrieve a list of all tenants

Set default properties for namespaces created for a tenant

Retrieve statistics about the content of the namespaces owned by a tenant

Generate a chargeback report for a tenant

For namespaces, you can:

Create or modify HCP namespaces or the default namespace

Delete HCP namespaces

Retrieve information about a single namespace

Retrieve a list of all the namespaces owned by a tenant

Retrieve statistics about the content of a namespace

Generate a chargeback report for a namespace

Reset the indexing checkpoint for a namespace

For retention classes, you can:

Create, modify, and delete retention classes for a namespace

Retrieve information about a single retention class

Retrieve a list of all the retention classes defined for a namespace

For content classes, you can:

Create, modify, and delete content classes for a tenant

Retrieve information about a single content class

Retrieve a list of all the content classes defined for a tenant

For locally authenticated system-level user accounts, you can change the password for a single user account.

For tenant-level user accounts, you can:

Create, modify, and delete user accounts

Retrieve information about a single user account

Retrieve a list of all the user accounts defined for a tenant

Reset the passwords of all locally authenticated user accounts with the security role

For tenant-level group accounts, you can:

Create, modify, and delete group accounts

Retrieve information about a single group account

Retrieve a list of all the group accounts defined for a tenant

Create a new group account with the security role or give the security role to an existing group account

For replication, you can:

Create, modify, and delete replication links

Specify link content

Retrieve a list of all links in which the HCP participates

Monitor replication progress at the link level and the tenant level

Schedule, suspend, and resume activity on links

Pause and resume replication of individual tenants

Shut down and reestablish all links

Fail over, restore, and failback links

Set the replication network

Enable DNS failover

Enable automatic sharing of domains and SSL server certificates

Specify whether tenant and namespace replication status is displayed in the Tenant Management Console for HCP tenants

For details on the activities supported by the management API, see Resources.

Trademarks and Legal Disclaimer

© 2017 Hitachi Data Systems Corporation. All rights reserved.