Retrieving settings for an individual namespace

You use the HTTP GET method to retrieve the settings for an individual namespace. The response contains information about the namespace only if you have any permissions for the namespace.

Access permissions

If you’re accessing the namespace anonymously, the namespace you specify must allow anonymous access through the HTTP protocol.

Request header

GET /proc HTTP/1.1

Response header

This operation does not return any request-specific response headers.

Response body

ElementAttributeDescription
namespacestenantHostNameDomain and subdomain of the tenant host.
namespaceshttpSchemeType of http connection to the tenant. Either http or https.
namespacenameName of the namespace
namespacenameIDNAURL of the namespace
namespaceversioningEnabledBoolean. Specifies if versioning is enabled for the namespace.
namespacesearchEnabledBoolean. Specifies if search is enabled for the namespace.
namespaceretentionModeSpecifies the retention mode for the namespace. Values are either compliance or enterprise.
namespacedefaultShredValueBoolean. Specifies whether or not the objects in the namespace are shredded after deletion.
namespacedefaultIndexValueBoolean. Specifies whether or not the objects in the namespace are indexed.
namespacedefaultRetentionValueSpecifies the retention value for the namespace.
namespacehashSchemeSpecifies the hash algorithm of the namespace.
namespacedplSpecifies the data protection level of the namespace.
namespacedescriptionProvides the description of the namespace.

Return codes

This operation does not have any request-specific return codes.

Example: Retrieving settings for an individual namespace

Here’s a sample HTTP GET request that returns the settings for the finance namespace owned by the europe tenant in the hcp.example.com system and that can be accessed by the user identified by the Authorization header.

Request with curl command line

curl -k -H "Authorization: HCP bXl1c2Vy:3f3c6784e97531774380db177774ac8d"
    "https://finance.europe.hcp.example.com/proc?single=true"

Request in Python using PycURL

import pycurl
curl = pycurl.Curl()
curl.setopt(pycurl.HTTPHEADER, ["Authorization: HCP
  bXl1c2Vy:3f3c6784e97531774380db177774ac8d"])
curl.setopt(pycurl.URL,
  "https://finance.europe.hcp.example.com/proc?single=true")
curl.setopt(pycurl.SSL_VERIFYPEER, 0)
curl.setopt(pycurl.SSL_VERIFYHOST, 0)
curl.perform()
print curl.getinfo(pycurl.RESPONSE_CODE)
curl.close()

Request headers

GET /proc HTTP/1.1
Host: /finance.europe.hcp.example.com
Authorization: HCP bXl1c2Vy:3f3c6784e97531774380db177774ac8d

Response headers

HTTP/1.1 200 OK
X-HCP-Time: 1334326410
Content-Length: 1275

Response body

<namespaces xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation="/static/xsd/proc-namespaces.xsd"
    tenantHostName="europe.hcp.example.com"
    httpScheme="https">
    <namespace name="finance"
         nameIDNA="finance"
         versioningEnabled="true"
         searchEnabled="true"
         retentionMode="enterprise"
         defaultShredValue="false"
         defaultIndexValue="true"
         defaultRetentionValue="0"
         hashScheme="SHA-256"
         dpl="2"
         >
        <description><![CDATA[
            Finance department
        ]]></description>
    </namespace>
</namespaces>