SecureHD Policy Editor API Resources

Examine and manage security policies for your account.

API Summary

Operation Method Endpoint
Policies
List Policies GET /config-media-security/v1/security
Create a Policy POST /config-media-security/v1/security
Get a Policy GET /config-media-security/v1/security/{policyID}
Modify a Policy PUT /config-media-security/v1/security/{policyID}
Mark a Policy for Deletion DELETE /config-media-security/v1/security/{policyID}
Get Policy per Environment GET /config-media-security/v1/security/{policyID}/{environment}
Clone a Policy POST /config-media-security/v1/security/{policyID}/clonePolicy
Promote a Policy PUT /config-media-security/v1/security/{policyID}/promote
Remove a Policy DELETE /config-media-security/v1/security/{policyID}/promoteDelete
Restore a Policy Deletion PUT /config-media-security/v1/security/{policyID}/revertDelete
Restore a Policy Edit PUT /config-media-security/v1/security/{policyID}/revertEdit
HD Configuration/Digital Properties
Get an HD Config Policy GET /config-media-security/v1/security/live/{domain}/policy
Modify an HD Config Policy PUT /config-media-security/v1/security/live/{domain}/policy
Get an HD Config Policy per Environment GET /config-media-security/v1/security/live/{domain}/policy/{environment}
List Policy Assignments GET /config-media-security/v1/security/live/{policyID}/policyassignments
Get a Policy Assignment GET /config-media-security/v1/security/live/{policyID}/policyassignments/{environment}
Promote a Policy Assignment PUT /config-media-security/v1/security/live/{policyID}/policyassignments/promote
Revert a Policy Assignment Promotion PUT /config-media-security/v1/security/live/{policyID}/policyassignments/revert
Security Services
List Countries GET /config-media-security/v1/security/countries
List Designated Market Areas GET /config-media-security/v1/security/dmas
List Regions GET /config-media-security/v1/security/regions
List Regions per Country GET /config-media-security/v1/security/regions/{countryCode}
Miscellaneous
List Access Control Groups GET /config-media-security/v1/security/acgs

List Policies

List all the security policies for account

GET /config-media-security/v1/security

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<security-policies>
    <security-policy>
        <id>1234</id>
        <name>POLICY NAME</name>
        <description>Description for 'POLICY NAME'</description>
        <environment>Staging</environment>
        <token-auth-feature>
            <enabled>true</enabled>
            <password>RANDOMHEXVALUES</password>
            <enforce-on-initial-request>true</enforce-on-initial-request>
            <enforce-on-content-request>true</enforce-on-content-request>
        </token-auth-feature>
        <media-encryption-feature>
            <enabled>true</enabled>
            <percentage-coverage>100</percentage-coverage>
        </media-encryption-feature>
        <content-targeting-feature>
            <enabled>false</enabled>
            <geo-protection>
                <enabled>false</enabled>
                <allow-locations>true</allow-locations>
                <countries>
                    <country>
                        <country-code>US</country-code>
                    </country>
                </countries>
                <regions />
                <override-ips />
                <geo-redirect-on-deny-enabled>false</geo-redirect-on-deny-enabled>
                <dmas />
            </geo-protection>
            <ip-access>
                <enabled>false</enabled>
                <allow-ips>false</allow-ips>
                <ip-list />
                <ip-redirect-on-deny-enabled>false</ip-redirect-on-deny-enabled>
            </ip-access>
            <referral-domain>
                <enabled>false</enabled>
                <allowed-domains />
                <referrer-redirect-on-deny-enabled>false
                </referrer-redirect-on-deny-enabled>
            </referral-domain>
        </content-targeting-feature>
        <player-verification-feature>
            <enabled>false</enabled>
            <support-player-enabled>false</support-player-enabled>
            <reset-support-player>false</reset-support-player>
            <time-left-for-support-player>0</time-left-for-support-player>
            <players />
        </player-verification-feature>
    </security-policy>
    <security-policy>
        <security-policy>
            <id>1234</id>
            <name>POLICY NAME</name>
            <description>Description for 'POLICY NAME'</description>
            <environment>Production</environment>
            <token-auth-feature>
                <enabled>true</enabled>
                <password>RANDOMHEXVALUES</password>
                <enforce-on-initial-request>true</enforce-on-initial-request>
                <enforce-on-content-request>true</enforce-on-content-request>
            </token-auth-feature>
            <media-encryption-feature>
                <enabled>true</enabled>
                <percentage-coverage>100</percentage-coverage>
            </media-encryption-feature>
            <content-targeting-feature>
                <enabled>false</enabled>
                <geo-protection>
                    <enabled>false</enabled>
                    <allow-locations>true</allow-locations>
                    <countries>
                        <country>
                            <country-code>US</country-code>
                        </country>
                    </countries>
                    <regions />
                    <override-ips />
                    <geo-redirect-on-deny-enabled>false</geo-redirect-on-deny-enabled>
                    <dmas />
                </geo-protection>
                <ip-access>
                    <enabled>false</enabled>
                    <allow-ips>false</allow-ips>
                    <ip-list />
                    <ip-redirect-on-deny-enabled>false</ip-redirect-on-deny-enabled>
                </ip-access>
                <referral-domain>
                    <enabled>false</enabled>
                    <allowed-domains />
                    <referrer-redirect-on-deny-enabled>false
                    </referrer-redirect-on-deny-enabled>
                </referral-domain>
            </content-targeting-feature>
            <player-verification-feature>
                <enabled>false</enabled>
                <support-player-enabled>false</support-player-enabled>
                <reset-support-player>false</reset-support-player>
                <time-left-for-support-player>0</time-left-for-support-player>
                <players />
            </player-verification-feature>
        </security-policy>
        <security-policy>
            <id>12345</id>
            <name>POLICY NAME</name>
            <description>Description for 'POLICY NAME'</description>
            <environment>Staging</environment>
            <token-auth-feature>
                <enabled>false</enabled>
                <enforce-on-initial-request>true</enforce-on-initial-request>
                <enforce-on-content-request>true</enforce-on-content-request>
            </token-auth-feature>
            <media-encryption-feature>
                <enabled>false</enabled>
                <percentage-coverage>100</percentage-coverage>
            </media-encryption-feature>
            <content-targeting-feature>
                <enabled>true</enabled>
                <geo-protection>
                    <enabled>true</enabled>
                    <allow-locations>true</allow-locations>
                    <countries>
                        <country>
                            <country-code>NO</country-code>
                        </country>
                    </countries>
                    <regions />
                    <override-ips>
                        <override-ip>253.252.253.253</override-ip>
                        <override-ip>253.252.253.253</override-ip>
                    </override-ips>
                    <geo-redirect-on-deny-enabled>false</geo-redirect-on-deny-enabled>
                    <dmas />
                </geo-protection>
                <ip-access>
                    <enabled>false</enabled>
                    <allow-ips>false</allow-ips>
                    <ip-list />
                    <ip-redirect-on-deny-enabled>false</ip-redirect-on-deny-enabled>
                </ip-access>
                <referral-domain>
                    <enabled>false</enabled>
                    <allowed-domains />
                    <referrer-redirect-on-deny-enabled>false
                    </referrer-redirect-on-deny-enabled>
                </referral-domain>
            </content-targeting-feature>
            <player-verification-feature>
                <enabled>true</enabled>
                <support-player-enabled>false</support-player-enabled>
                <reset-support-player>false</reset-support-player>
                <time-left-for-support-player>24</time-left-for-support-player>
                <ttl>1d</ttl>
                <players>
                    <player>
                        <hash>SAMPLEHASH1</hash>
                        <description>Sample Player 2</description>
                        <enabled>true</enabled>
                    </player>
                    <player>
                        <hash>SAMPLEHASH1</hash>
                        <description>Sample Player</description>
                        <enabled>true</enabled>
                    </player>
                </players>
            </player-verification-feature>
        </security-policy>

Create a Policy

Create new security policy on staging network

POST /config-media-security/v1/security

Content-Type: application/xml

Request:

<?xml version="1.0"?>
<security-policy>
    <name>POLICY NAME</name>
    <description>Description for 'POLICY NAME'</description>
    <token-auth-feature>
        <enabled>true</enabled>
        <password>RANDOMHEXVALUES</password>
        <enforce-on-initial-request>true</enforce-on-initial-request>
        <enforce-on-content-request>true</enforce-on-content-request>
    </token-auth-feature>
    <media-encryption-feature>
        <enabled>true</enabled>
        <percentage-coverage>100</percentage-coverage>
    </media-encryption-feature>
    <content-targeting-feature>
        <enabled>false</enabled>
        <geo-protection>
            <enabled>false</enabled>
            <allow-locations>true</allow-locations>
            <countries>
                <country>
                    <country-code>US</country-code>
                </country>
            </countries>
            <regions />
            <override-ips />
            <geo-redirect-on-deny-enabled>false</geo-redirect-on-deny-enabled>
            <dmas />
        </geo-protection>
        <ip-access>
            <enabled>false</enabled>
            <allow-ips>false</allow-ips>
            <ip-list />
            <ip-redirect-on-deny-enabled>false</ip-redirect-on-deny-enabled>
        </ip-access>
        <referral-domain>
            <enabled>false</enabled>
            <allowed-domains />
            <referrer-redirect-on-deny-enabled>false
            </referrer-redirect-on-deny-enabled>
        </referral-domain>
    </content-targeting-feature>
    <player-verification-feature>
        <enabled>false</enabled>
        <support-player-enabled>false</support-player-enabled>
        <reset-support-player>false</reset-support-player>
        <time-left-for-support-player>0</time-left-for-support-player>
        <players>
            <player>
                <hash>SAMPLEHASH1</hash>
                <description>Sample Player 2</description>
                <enabled>true</enabled>
            </player>
            <player>
                <hash>SAMPLEHASH1</hash>
                <description>Sample Player</description>
                <enabled>true</enabled>
            </player>
        </players>
    </player-verification-feature>
</security-policy>

Status 200 application/xml

Response:

<?xml version="1.0"?>
<security-policy>
    <id>1234</id>
    <name>POLICY NAME</name>
    <description>Description for 'POLICY NAME'</description>
    <environment>Staging</environment>
    <token-auth-feature>
        <enabled>true</enabled>
        <password>RANDOMHEXVALUES</password>
        <enforce-on-initial-request>true</enforce-on-initial-request>
        <enforce-on-content-request>true</enforce-on-content-request>
    </token-auth-feature>
    <media-encryption-feature>
        <enabled>true</enabled>
        <percentage-coverage>100</percentage-coverage>
    </media-encryption-feature>
    <content-targeting-feature>
        <enabled>false</enabled>
        <geo-protection>
            <enabled>false</enabled>
            <allow-locations>true</allow-locations>
            <countries>
                <country>
                    <country-code>US</country-code>
                </country>
            </countries>
            <regions />
            <override-ips />
            <geo-redirect-on-deny-enabled>false</geo-redirect-on-deny-enabled>
            <dmas />
        </geo-protection>
        <ip-access>
            <enabled>false</enabled>
            <allow-ips>false</allow-ips>
            <ip-list />
            <ip-redirect-on-deny-enabled>false</ip-redirect-on-deny-enabled>
        </ip-access>
        <referral-domain>
            <enabled>false</enabled>
            <allowed-domains />
            <referrer-redirect-on-deny-enabled>false
            </referrer-redirect-on-deny-enabled>
        </referral-domain>
    </content-targeting-feature>
    <player-verification-feature>
        <enabled>false</enabled>
        <support-player-enabled>false</support-player-enabled>
        <reset-support-player>false</reset-support-player>
        <time-left-for-support-player>0</time-left-for-support-player>
        <players />
    </player-verification-feature>
</security-policy>

Get a Policy

Get security policy for production and staging network

GET /config-media-security/v1/security/{policyID}

Example: /config-media-security/v1/security/1234

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<security-policies>
    <security-policy>
        <id>1234</id>
        <name>POLICY NAME</name>
        <description>Description for 'POLICY NAME'</description>
        <environment>Staging</environment>
        <token-auth-feature>
            <enabled>true</enabled>
            <password>RANDOMHEXVALUES</password>
            <enforce-on-initial-request>true</enforce-on-initial-request>
            <enforce-on-content-request>true</enforce-on-content-request>
        </token-auth-feature>
        <media-encryption-feature>
            <enabled>true</enabled>
            <percentage-coverage>100</percentage-coverage>
        </media-encryption-feature>
        <content-targeting-feature>
            <enabled>false</enabled>
            <geo-protection>
                <enabled>false</enabled>
                <allow-locations>true</allow-locations>
                <countries>
                    <country>
                        <country-code>US</country-code>
                    </country>
                </countries>
                <regions />
                <override-ips />
                <geo-redirect-on-deny-enabled>false</geo-redirect-on-deny-enabled>
                <dmas />
            </geo-protection>
            <ip-access>
                <enabled>false</enabled>
                <allow-ips>false</allow-ips>
                <ip-list />
                <ip-redirect-on-deny-enabled>false</ip-redirect-on-deny-enabled>
            </ip-access>
            <referral-domain>
                <enabled>false</enabled>
                <allowed-domains />
                <referrer-redirect-on-deny-enabled>false
                </referrer-redirect-on-deny-enabled>
            </referral-domain>
        </content-targeting-feature>
        <player-verification-feature>
            <enabled>false</enabled>
            <support-player-enabled>false</support-player-enabled>
            <reset-support-player>false</reset-support-player>
            <time-left-for-support-player>0</time-left-for-support-player>
            <players />
        </player-verification-feature>
    </security-policy>
    <security-policy>
        <security-policy>
            <id>1234</id>
            <name>POLICY NAME</name>
            <description>Description for 'POLICY NAME'</description>
            <environment>Production</environment>
            <token-auth-feature>
                <enabled>true</enabled>
                <password>RANDOMHEXVALUES</password>
                <enforce-on-initial-request>true</enforce-on-initial-request>
                <enforce-on-content-request>true</enforce-on-content-request>
            </token-auth-feature>
            <media-encryption-feature>
                <enabled>true</enabled>
                <percentage-coverage>100</percentage-coverage>
            </media-encryption-feature>
            <content-targeting-feature>
                <enabled>false</enabled>
                <geo-protection>
                    <enabled>false</enabled>
                    <allow-locations>true</allow-locations>
                    <countries>
                        <country>
                            <country-code>US</country-code>
                        </country>
                    </countries>
                    <regions />
                    <override-ips />
                    <geo-redirect-on-deny-enabled>false</geo-redirect-on-deny-enabled>
                    <dmas />
                </geo-protection>
                <ip-access>
                    <enabled>false</enabled>
                    <allow-ips>false</allow-ips>
                    <ip-list />
                    <ip-redirect-on-deny-enabled>false</ip-redirect-on-deny-enabled>
                </ip-access>
                <referral-domain>
                    <enabled>false</enabled>
                    <allowed-domains />
                    <referrer-redirect-on-deny-enabled>false
                    </referrer-redirect-on-deny-enabled>
                </referral-domain>
            </content-targeting-feature>
            <player-verification-feature>
                <enabled>false</enabled>
                <support-player-enabled>false</support-player-enabled>
                <reset-support-player>false</reset-support-player>
                <time-left-for-support-player>0</time-left-for-support-player>
                <players />
            </player-verification-feature>
        </security-policy>
    </security-policies>

Modify a Policy

Update security policy on Staging network.

PUT /config-media-security/v1/security/{policyID}

Example: /config-media-security/v1/security/1234

Content-Type: application/xml

Request:

<security-policy>
        <id>1234</id>
        <name>POLICY NAME</name>
        <description>Description for 'POLICY NAME'</description>
        <environment>Staging</environment>
        <token-auth-feature>
            <enabled>true</enabled>
            <password>RANDOMHEXVALUES</password>
            <enforce-on-initial-request>true</enforce-on-initial-request>
            <enforce-on-content-request>true</enforce-on-content-request>
        </token-auth-feature>
        <media-encryption-feature>
            <enabled>true</enabled>
            <percentage-coverage>100</percentage-coverage>
        </media-encryption-feature>
        <content-targeting-feature>
            <enabled>false</enabled>
            <geo-protection>
                <enabled>false</enabled>
                <allow-locations>true</allow-locations>
                <countries>
                    <country>
                        <country-code>US</country-code>
                    </country>
                </countries>
                <regions />
                <override-ips />
                <geo-redirect-on-deny-enabled>false</geo-redirect-on-deny-enabled>
                <dmas />
            </geo-protection>
            <ip-access>
                <enabled>false</enabled>
                <allow-ips>false</allow-ips>
                <ip-list />
                <ip-redirect-on-deny-enabled>false</ip-redirect-on-deny-enabled>
            </ip-access>
            <referral-domain>
                <enabled>false</enabled>
                <allowed-domains />
                <referrer-redirect-on-deny-enabled>false
                </referrer-redirect-on-deny-enabled>
            </referral-domain>
        </content-targeting-feature>
        <player-verification-feature>
            <enabled>false</enabled>
            <support-player-enabled>false</support-player-enabled>
            <reset-support-player>false</reset-support-player>
            <time-left-for-support-player>0</time-left-for-support-player>
            <players>
                <player>
                    <hash>SAMPLEHASH1</hash>
                    <description>Sample Player 2</description>
                    <enabled>true</enabled>
                </player>
                <player>
                    <hash>SAMPLEHASH1</hash>
                    <description>Sample Player</description>
                    <enabled>true</enabled>
                </player>
            </players>
        </player-verification-feature>
    </security-policy>

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8"?>
<Response>
   <message>Successfully updated policy: 1234</message>
</Response>

Mark a Policy for Deletion

Mark security policy for deletion on staging network

DELETE /config-media-security/v1/security/{policyID}

Example: /config-media-security/v1/security/1234

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<Response>
   <message>Successfully marked policy: 1234 as deleted</message>
</Response>

Get Policy per Environment

Get security policy for given environment (staging/production)

GET /config-media-security/v1/security/{policyID}/{environment}

Example: /config-media-security/v1/security/1234/Production

Parameter Type Sample Description
Required
environment Enumeration Production The environment. Possible values: Production, Staging.
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<security-policy>
    <id>1234</id>
    <name>POLICY NAME</name>
    <description>Description for 'POLICY NAME'</description>
    <environment>Production</environment>
    <token-auth-feature>
        <enabled>true</enabled>
        <password>RANDOMHEXVALUES</password>
        <enforce-on-initial-request>true</enforce-on-initial-request>
        <enforce-on-content-request>true</enforce-on-content-request>
    </token-auth-feature>
    <media-encryption-feature>
        <enabled>true</enabled>
        <percentage-coverage>100</percentage-coverage>
    </media-encryption-feature>
    <content-targeting-feature>
        <enabled>false</enabled>
        <geo-protection>
            <enabled>false</enabled>
            <allow-locations>true</allow-locations>
            <countries>
                <country>
                    <country-code>US</country-code>
                </country>
            </countries>
            <regions />
            <override-ips />
            <geo-redirect-on-deny-enabled>false</geo-redirect-on-deny-enabled>
            <dmas />
        </geo-protection>
        <ip-access>
            <enabled>false</enabled>
            <allow-ips>false</allow-ips>
            <ip-list />
            <ip-redirect-on-deny-enabled>false</ip-redirect-on-deny-enabled>
        </ip-access>
        <referral-domain>
            <enabled>false</enabled>
            <allowed-domains />
            <referrer-redirect-on-deny-enabled>false
            </referrer-redirect-on-deny-enabled>
        </referral-domain>
    </content-targeting-feature>
    <player-verification-feature>
        <enabled>false</enabled>
        <support-player-enabled>false</support-player-enabled>
        <reset-support-player>false</reset-support-player>
        <time-left-for-support-player>0</time-left-for-support-player>
        <players />
    </player-verification-feature>
</security-policy>

Clone a Policy

Clone security policy on staging network

POST /config-media-security/v1/security/{policyID}/clonePolicy

Example: /config-media-security/v1/security/1234/clonePolicy

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<security-policy>
    <id>1234</id>
    <name>POLICY NAME</name>
    <description>Description for 'POLICY NAME'</description>
    <environment>Staging</environment>
    <token-auth-feature>
        <enabled>true</enabled>
        <password>RANDOMHEXVALUES</password>
        <enforce-on-initial-request>true</enforce-on-initial-request>
        <enforce-on-content-request>true</enforce-on-content-request>
    </token-auth-feature>
    <media-encryption-feature>
        <enabled>true</enabled>
        <percentage-coverage>100</percentage-coverage>
    </media-encryption-feature>
    <content-targeting-feature>
        <enabled>false</enabled>
        <geo-protection>
            <enabled>false</enabled>
            <allow-locations>true</allow-locations>
            <countries>
                <country>
                    <country-code>US</country-code>
                </country>
            </countries>
            <regions />
            <override-ips />
            <geo-redirect-on-deny-enabled>false</geo-redirect-on-deny-enabled>
            <dmas />
        </geo-protection>
        <ip-access>
            <enabled>false</enabled>
            <allow-ips>false</allow-ips>
            <ip-list />
            <ip-redirect-on-deny-enabled>false</ip-redirect-on-deny-enabled>
        </ip-access>
        <referral-domain>
            <enabled>false</enabled>
            <allowed-domains />
            <referrer-redirect-on-deny-enabled>false
            </referrer-redirect-on-deny-enabled>
        </referral-domain>
    </content-targeting-feature>
    <player-verification-feature>
        <enabled>false</enabled>
        <support-player-enabled>false</support-player-enabled>
        <reset-support-player>false</reset-support-player>
        <time-left-for-support-player>0</time-left-for-support-player>
        <players>
            <player>
                <hash>SAMPLEHASH1</hash>
                <description>Sample Player 2</description>
                <enabled>true</enabled>
            </player>
            <player>
                <hash>SAMPLEHASH1</hash>
                <description>Sample Player</description>
                <enabled>true</enabled>
            </player>
        </players>
    </player-verification-feature>
</security-policy>

Promote a Policy

Promote security policy to production network

PUT /config-media-security/v1/security/{policyID}/promote

Example: /config-media-security/v1/security/1234/promote

Content-Type: application/xml

Request:

{}

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8"?>
<Response>
   <message>Successfully promoted policy: 1234</message>
</Response>

Remove a Policy

Delete policy from system (both staging and production network)

DELETE /config-media-security/v1/security/{policyID}/promoteDelete

Example: /config-media-security/v1/security/1234/promoteDelete

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8"?>
<Response>
   <message>Successfully deleted policy: 4510 from staging and production</message>
</Response>

Restore a Policy Deletion

Restore security policy on staging network

PUT /config-media-security/v1/security/{policyID}/revertDelete

Example: /config-media-security/v1/security/1234/revertDelete

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8"?>
<Response>
   <message>Successfully reverted policy: 1234 from staging</message>
</Response>

Restore a Policy Edit

Restore production copy of policy to staging network

PUT /config-media-security/v1/security/{policyID}/revertEdit

Example: /config-media-security/v1/security/1234/revertEdit

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<Response>
   <message>Successfully reverted policy: 1234 on staging network</message>
</Response>

Get an HD Config Policy

Get policy assignments for given hostname

GET /config-media-security/v1/security/live/{domain}/policy

Example: /config-media-security/v1/security/live/speedy.example.com/policy

Parameter Type Sample Description
Required
domain String speedy.example.com The fully qualified domain name for the host in question.

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<policy-assignments>
    <assignment>
        <environment>Staging</environment>
        <rules>
            <rule>
                <policy-name>POLICY NAME</policy-name>
                <policy-id>1234</policy-id>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
        </rules>
    </assignment>
    <assignment>
        <environment>Production</environment>
        <rules>
            <rule>
                <policy-name>POLICY NAME</policy-name>
                <policy-id>1234</policy-id>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
        </rules>
    </assignment>
</policy-assignments>

Modify an HD Config Policy

Update policy assignments for given hostname on staging network

PUT /config-media-security/v1/security/live/{domain}/policy

Example: /config-media-security/v1/security/live/speedy.example.com/policy

Content-Type: application/xml

Request:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assignment>
    <rules>
        <rule>
            <policy-name>POLICY NAME</policy-name>
            <policy-id>1234</policy-id>
            <path>/...</path>
            <start-time>*</start-time>
            <end-time>*</end-time>
        </rule>
        <rule>
            <policy-name>POLICY NAME2</policy-name>
            <policy-id>12345</policy-id>
            <path>/abc/...</path>
            <start-time>*</start-time>
            <end-time>*</end-time>
        </rule>
    </rules>
</assignment>

Parameter Type Sample Description
Required
domain String speedy.example.com The fully qualified domain name for the host in question.

Status 200 application/xml

Response:

<policy-assignments>
    <assignment>
        <environment>Staging</environment>
        <rules>
            <rule>
                <policy-name>POLICY NAME</policy-name>
                <policy-id>1234</policy-id>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
            <rule>
                <policy-name>POLICY NAME2</policy-name>
                <policy-id>12345</policy-id>
                <path>/abc/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
        </rules>
    </assignment>
    <assignment>
        <environment>Production</environment>
        <rules>
            <rule>
                <policy-name>POLICY NAME</policy-name>
                <policy-id>1234</policy-id>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
        </rules>
    </assignment>
</policy-assignments>

Get an HD Config Policy per Environment

Get policy assignment for network (staging/production)

GET /config-media-security/v1/security/live/{domain}/policy/{environment}

Example: /config-media-security/v1/security/live/speedy.example.com/policy/Production

Parameter Type Sample Description
Required
domain String speedy.example.com The fully qualified domain name for the host in question.
environment Enumeration Production The environment. Possible values: Production, Staging.

Status 200 application/xml

Response:

<assignment>
    <rules>
        <rule>
            <policy-name>POLICY NAME</policy-name>
            <policy-id>1234</policy-id>
            <path>/...</path>
            <start-time>*</start-time>
            <end-time>*</end-time>
        </rule>
        <rule>
            <policy-name>POLICY NAME2</policy-name>
            <policy-id>12345</policy-id>
            <path>/abc/...</path>
            <start-time>*</start-time>
            <end-time>*</end-time>
        </rule>
    </rules>
</assignment>

List Policy Assignments

Get policy assignment for given policyID for staging and production network

GET /config-media-security/v1/security/live/{policyID}/policyassignments

Example: /config-media-security/v1/security/live/1234/policyassignments

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<policy-assignments>
    <assignment>
        <environment>Staging</environment>
        <rules>
            <rule>
                <policy-id>-1</policy-id>
                <configuration-name>CONFIG-1</configuration-name>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
            <rule>
                <policy-id>-1</policy-id>
                <configuration-name>CONFIG-2</configuration-name>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
            <rule>
                <policy-id>-1</policy-id>
                <configuration-name>CONFIG-3</configuration-name>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
            <rule>
                <policy-id>-1</policy-id>
                <configuration-name>CONFIG-4</configuration-name>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
        </rules>
    </assignment>
    <assignment>
        <environment>Production</environment>
        <rules>
            <rule>
                <policy-id>-1</policy-id>
                <configuration-name>CONFIG-1</configuration-name>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
            <rule>
                <policy-id>-1</policy-id>
                <configuration-name>CONFIG-2</configuration-name>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
            <rule>
                <policy-id>-1</policy-id>
                <configuration-name>CONFIG-3</configuration-name>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
            <rule>
                <policy-id>-1</policy-id>
                <configuration-name>CONFIG-4</configuration-name>
                <path>/...</path>
                <start-time>*</start-time>
                <end-time>*</end-time>
            </rule>
        </rules>
    </assignment>
</policy-assignments>

Get a Policy Assignment

Get policy assignment for given policyID for given environment

GET /config-media-security/v1/security/live/{policyID}/policyassignments/{environment}

Example: /config-media-security/v1/security/live/1234/policyassignments/Production

Parameter Type Sample Description
Required
environment Enumeration Production The environment. Possible values: Production, Staging.
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<assignment>
    <rules>
        <rule>
            <policy-id>-1</policy-id>
            <configuration-name>CONFIG-1</configuration-name>
            <path>/...</path>
            <start-time>*</start-time>
            <end-time>*</end-time>
        </rule>
        <rule>
            <policy-id>-1</policy-id>
            <configuration-name>CONFIG-2</configuration-name>
            <path>/...</path>
            <start-time>*</start-time>
            <end-time>*</end-time>
        </rule>
        <rule>
            <policy-id>-1</policy-id>
            <configuration-name>CONFIG-3</configuration-name>
            <path>/...</path>
            <start-time>*</start-time>
            <end-time>*</end-time>
        </rule>
        <rule>
            <policy-id>-1</policy-id>
            <configuration-name>CONFIG-4</configuration-name>
            <path>/...</path>
            <start-time>*</start-time>
            <end-time>*</end-time>
        </rule>
    </rules>
</assignment>

Promote a Policy Assignment

Promote security policy assignment for policy on production network

PUT /config-media-security/v1/security/live/{policyID}/policyassignments/promote

Example: /config-media-security/v1/security/live/1234/policyassignments/promote

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<Response>
   <message>Successfully promoted policy assignment for policy ID : 1234</message>
</Response>

Revert a Policy Assignment Promotion

Revert policy assignment from production network to staging network

PUT /config-media-security/v1/security/live/{policyID}/policyassignments/revert

Example: /config-media-security/v1/security/live/1234/policyassignments/revert

Parameter Type Sample Description
Required
policyID Number 1234 The ID of the policy to fetch.

Status 200 application/xml

Response:

<Response>
   <message>Successfully reverted policy assignments for policy ID : 1234</message>
</Response>

List Countries

Get available countries for Content Targetting feature

GET /config-media-security/v1/security/countries

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8"?>
<geo-countries>
   <country>
      <country-code>AD</country-code>
      <country-name>Andorra</country-name>
      <continent-code>EU</continent-code>
   </country>
   <country>
      <country-code>AE</country-code>
      <country-name>United Arab Emirates</country-name>
      <continent-code>AS</continent-code>
   </country>
   <country>
      <country-code>AF</country-code>
      <country-name>Afghanistan</country-name>
      <continent-code>AS</continent-code>
   </country>
   <country>
      <country-code>AG</country-code>
      <country-name>Antigua and Barbuda</country-name>
      <continent-code>NA</continent-code>
   </country>
   <country>
      <country-code>AI</country-code>
      <country-name>Anguilla</country-name>
      <continent-code>NA</continent-code>
   </country>
   <country>
      <country-code>ZW</country-code>
      <country-name>Zimbabwe</country-name>
      <continent-code>AF</continent-code>
   </country>
</geo-countries>

List Designated Market Areas

Get available DMAs for Content Targetting feature

GET /config-media-security/v1/security/dmas

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<dmas>
    <dma>
        <dma-code>500</dma-code>
        <dma-name>Portland-Auburn::ME,NH</dma-name>
    </dma>
    <dma>
        <dma-code>501</dma-code>
        <dma-name>NewYork::CT,NJ,NY,PA</dma-name>
    </dma>
    <dma>
        <dma-code>502</dma-code>
        <dma-name>Binghamton::NY</dma-name>
    </dma>
    <dma>
        <dma-code>503</dma-code>
        <dma-name>Macon::GA</dma-name>
    </dma>
    <dma>
        <dma-code>504</dma-code>
        <dma-name>Philadelphia::DE,NJ,PA</dma-name>
    </dma>
    <dma>
        <dma-code>505</dma-code>
        <dma-name>Detroit::MI</dma-name>
    </dma>
    <dma>
        <dma-code>868</dma-code>
        <dma-name>Chico-Redding::CA</dma-name>
    </dma>
    <dma>
        <dma-code>881</dma-code>
        <dma-name>Spokane::ID,MT,OR,WA</dma-name>
    </dma>
</dmas>

List Regions

Get available Regions for Content Targetting feature

GET /config-media-security/v1/security/regions

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8"?>
<regions>
   <region>
      <country-code>AU</country-code>
      <region-code>ACT</region-code>
      <region-name>Australian Capital Territory</region-name>
   </region>
   <region>
      <country-code>AU</country-code>
      <region-code>NSW</region-code>
      <region-name>New South Wales</region-name>
   </region>
   <region>
      <country-code>AU</country-code>
      <region-code>NT</region-code>
      <region-name>Northern Territory</region-name>
   </region>
   <region>
      <country-code>AU</country-code>
      <region-code>QLD</region-code>
      <region-name>Queensland</region-name>
   </region>
   <region>
      <country-code>AU</country-code>
      <region-code>SA</region-code>
      <region-name>South Australia</region-name>
   </region>
   <region>
      <country-code>AU</country-code>
      <region-code>TAS</region-code>
      <region-name>Tasmania</region-name>
   </region>
   <region>
      <country-code>US</country-code>
      <region-code>WV</region-code>
      <region-name>West Virginia</region-name>
   </region>
   <region>
      <country-code>US</country-code>
      <region-code>WY</region-code>
      <region-name>Wyoming</region-name>
   </region>
</regions>

List Regions per Country

Get available Regions given country code for Content Targetting feature

GET /config-media-security/v1/security/regions/{countryCode}

Example: /config-media-security/v1/security/regions/US

Parameter Type Sample Description
Required
countryCode String US The country code.

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8"?>
<regions>
    <region>
      <country-code>US</country-code>
      <region-code>WA</region-code>
      <region-name>Washington</region-name>
   </region>
   <region>
      <country-code>US</country-code>
      <region-code>WV</region-code>
      <region-name>West Virginia</region-name>
   </region>
   <region>
      <country-code>US</country-code>
      <region-code>WY</region-code>
      <region-name>Wyoming</region-name>
   </region>
</regions>

List Access Control Groups

Get available acgs/subacgs for an account

GET /config-media-security/v1/security/acgs

Status 200 application/xml

Response:

<?xml version="1.0" encoding="UTF-8"?>
<acgs>
   <acg>ACG-1</acg>
   <acg>ACG-2</acg>
   <acg>ACG-1.1</acg>
</acgs>


Last modified: 12/12/2016