Namespace resources

Namespace resources let you create, retrieve information about, modify, and delete namespaces. The table below provides information about these resources.

.../tenants/tenant-name/namespaces

Data typeMethodUseAccessNotes
namespacePUTCreate an HCP namespaceTenant-level user account with the administrator role or allow namespace management propertyNot valid for the default namespace.
ListGETRetrieve a list of the namespaces owned by a tenant
  • For an HCP tenant, tenant-level user account with the monitor, administrator, or compliance role or allow namespace management property
  • For the default tenant, system-level user account with the monitor or administrator role

The listed namespaces are identified by namespace name.

In XML, the element that identifies each namespace is name. The root element for the list of namespaces is namespaces.

In JSON, the name in the name/value pair that lists the namespaces is name.

For a user with the allow namespace management property and no roles, the retrieved list includes only the namespaces the user owns.

.../tenants/tenant-name/namespaces/cors

Data typeMethodUseAccessNotes
corsPUTSet the CORS rules configuration for a namespace
  • System-level user account with the administrator role
  • Tenant-level user account with the administrator role
A CORS configuration set on a namespace overrides the default tenant-level CORS configuration.
GETRetrieve the CORS configuration for a namespace
  • System-level user account with the monitor or administrator role
  • Tenant-level user account with the monitor or administrator role
DELETEDelete the CORS configuration for a namespace
  • System-level user account with the administrator role
  • Tenant-level user account with the administrator role
If a CORS configuration is not set on the namespace, the HTTP status code 404 Not Found is returned.

.../tenants/tenant-name/namespaces/namespace-name

Data typeMethodUseAccessNotes
namespaceGETRetrieve information about a namespace
  • For an HCP namespace, tenant-level user account with the monitor or administrator role or allow namespace management property
  • For the default namespace, system-level user account with the monitor or administrator role
A user with the allow namespace management property and no roles can retrieve information only about the namespaces the user owns. In this case, the retrieved information includes only the namespace name and owner.
N/AHEADCheck for the existence of a namespace
  • For an HCP namespace, tenant-level user account with the monitor, administrator, or compliance role or allow namespace management property
  • For the default namespace, system-level user account with the monitor or administrator role
namespacePOSTModify a namespace
  • For an HCP namespace, tenant-level user account with the administrator role
  • For the default namespace, system-level user account with the administrator role
N/ADELETEDelete an HCP namespaceTenant-level user account with the administrator role or allow namespace management property

A user with the allow namespace management property and no roles can delete only the namespaces the user owns.

The namespace cannot contain any objects.

Not valid for the default namespace.

.../tenants/tenant-name/namespaces/namespace-name/chargebackReport

Data typeMethodUseAccessNotes

chargeback

Report

GETGenerate a chargeback report for a namespaceTenant-level user account with the monitor or administrator role

Not valid for the default namespace.

Supported output formats are XML, JSON, and CSV.

.../tenants/tenant-name/namespaces/namespace-name/complianceSettings

Data typeMethodUseAccessNotes
compliance SettingsGETRetrieve the default retention, shred, custom metadata handling, and disposition settings for a namespace
  • For an HCP namespace, tenant-level user account with the monitor, administrator, or compliance role
  • For the default namespace, system-level user account with the monitor, administrator, or compliance role
Default retention and shred settings do not apply to the default namespace.
POSTModify the default retention, shred, custom metadata handling, or disposition setting for a namespace
  • For an HCP namespace, tenant-level user account with the compliance role
  • For the default namespace, system-level user account with the compliance role

../tenants/tenant-name/namespaces/namespace-name/customMetadataIndexingSettings

Data typeMethodUseAccessNotes
custom Metadata Indexing SettingsGETRetrieve settings specific to metadata query engine indexing of custom metadata for a search-enabled namespace
  • For an HCP namespace, tenant-level user account with the monitor or administrator role
  • For the default namespace, system-level user account with the monitor or administrator role
Not valid for namespaces that do not have search enabled.
POSTModify settings specific to metadata query engine indexing of custom metadata for a search-enabled namespace
  • For an HCP namespace, tenant-level user account with the administrator role
  • For the default namespace, system-level user account with the administrator role

.../tenants/tenant-name/namespaces/namespace-name/permissions

Data typeMethodUseAccessNotes
ListGETRetrieve the list of permissions in the data access permission mask for a namespace
  • For an HCP namespace, tenant-level user account with the monitor or administrator role
  • For the default namespace, system-level user account with the monitor or administrator role
ListPOSTModify the list of permissions in the data access permission mask for a namespace
  • For an HCP namespace, tenant-level user account with the administrator role
  • For the default namespace, system-level user account with the administrator role

Valid values for permissions are:

  • DELETE
  • PRIVILEGED
  • PURGE
  • READ
  • SEARCH
  • WRITE

These values are case sensitive.

The set of permissions specified in the request body replaces the set of permissions currently included in the data access permission mask for the namespace. To remove all permissions, specify an empty list.

If the set of permissions includes PURGE, delete permission is enabled automatically. If the set of permissions includes SEARCH, read permission is enabled automatically.

By default, when you create a namespace, its data access permission mask includes all permissions.

.../tenants/tenant-name/namespaces/namespace-name/protocols

Data typeMethodUseAccessNotes
protocolsGETRetrieve a subset of the HTTP namespace access protocol settings for the default namespaceSystem-level user account with the monitor or administrator roleNot valid for HCP namespaces. For HCP namespaces, this resource has been superseded by the .../protocols/http resource.
POSTModify a subset of the HTTP namespace access protocol settings for the default namespaceSystem-level user account with the administrator role

.../tenants/tenant-name/namespaces/namespace-name/protocols/protocol-name

Data typeMethodUseAccessNotes
Determined by protocol-name. Possible data types are:
  • cifsProtocol
  • httpProtocol
  • nfsProtocol
  • smtpProtocol
GETRetrieve the applicable namespace access protocol settings for a namespaceTenant-level user account with the monitor or administrator role

Not valid for the default namespace.

Valid values for protocol-name are:

  • cifs
  • http
  • nfs
  • smtp

These values are case sensitive.

The httpProtocol data type includes properties for both the HTTP and WebDAV protocols.

POSTModify the applicable namespace access protocol settings for a namespaceTenant-level user account with the administrator role

.../tenants/tenant-name/namespaces/namespace-name/replicationCollisionSettings

Data typeMethodUseAccessNotes
replication Collision SettingsGETRetrieve the replication collision handling settings for a namespace
  • For an HCP namespace, tenant-level user account with the monitor or administrator role
  • For the default namespace, system-level user account with the monitor or administrator role
POSTModify the replication collision handling settings for a namespace
  • For an HCP namespace, tenant-level user account with the administrator role
  • For the default namespace, system-level user account with the administrator role

.../tenants/tenant-name/namespaces/namespace-name/statistics

Data typeMethodUseAccessNotes
statisticsGETRetrieve information about the content of a namespace
  • For an HCP namespace, tenant-level user account with the monitor or administrator role
  • For the default namespace, system-level user account with the monitor or administrator role

.../tenants/tenant-name/namespaces/namespace-name/versioningSettings

Data typeMethodUseAccessNotes

versioning

Settings

GETRetrieve the versioning settings for a namespaceTenant-level user account with the monitor or administrator role or the allow namespace management property

A user with the allow namespace management property and no roles can retrieve and modify only the versioning enabled property and that property only for the namespaces the user owns.

Not valid for the default namespace.

POSTModify the versioning settings for a namespaceTenant-level user account with the administrator role or the allow namespace management property
DELETEDelete the versioning settings for a namespaceTenant-level user account with the monitor or administrator role or the allow namespace management property