protocols

Content Platform Tenant Management Help

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

The protocols data type describes the protocols resource for default namespaces.

Note: For HCPnamespaces, the protocols resource is superseded by the .../protocols/http resource, which has a data type of httpProtocol.

Properties

The table below describes the properties included in the protocols data type.

Property Data type Description
httpEnabled Boolean

Specifies whether the HTTP protocol is enabled for the namespace. Valid values are:

true
HTTP is enabled.
false
HTTP is disabled.

The default is false.

httpsEnabled Boolean

Specifies whether the HTTPS protocol is enabled for the namespace. Valid values are:

true
HTTPS is enabled.
false
HTTPS is disabled.

The default is true.

ipSettings ipSettings Specifies which IP addresses can and cannot access the namespace through the HTTP and HTTPS protocols.

Example

Here’s an XML example of the protocols data type:

<protocols>
    <httpEnabled>false</httpEnabled>
    <httpsEnabled>true</httpsEnabled>
    <ipSettings>
     <allowAddresses>
         <ipAddress>192.168.140.10</ipAddress>
             <ipAddress>192.168.140.14</ipAddress>
             <ipAddress>192.168.140.15</ipAddress>
            <ipAddress>192.168.149.0/24</ipAddress>
         </allowAddresses>
        <allowIfInBothLists>false</allowIfInBothLists>
         <denyAddresses>
             <ipAddress>192.168.149.5</ipAddress>
         </denyAddresses>
     </ipSettings>
</protocols>