POST api/Harmonic/v2

The V2 implementation of the Harmonic CPIX protocol. This adds multi-key and key rotation support, and utilizes the V2 Key Override algorithm. This is the recommended endpoint to use.

Request Information

URI Parameters

None.

Body Parameters

None.

Request Formats

application/cpix+xml

Sample:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<cpix:CPIX xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" contentId="test_content">
  <cpix:ContentKeyList>
    <cpix:ContentKey kid="4eedd18e-69fd-11eb-9439-0242ac130002"/>
    <cpix:ContentKey kid="a58f1b10-ebad-498f-a3f5-135b4a59b937"/>
  </cpix:ContentKeyList>
  <cpix:DRMSystemList>
    <cpix:DRMSystem kid="4eedd18e-69fd-11eb-9439-0242ac130002" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"/>
    <cpix:DRMSystem kid="a58f1b10-ebad-498f-a3f5-135b4a59b937" systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2"/>
  </cpix:DRMSystemList>
  <cpix:ContentKeyPeriodList>
    <cpix:ContentKeyPeriod id="keyPeriod_9c786af2-f23f-37d2-a7f9-c94aaf3c94fe" index="1609335911"/>
  </cpix:ContentKeyPeriodList>
  <cpix:ContentKeyUsageRuleList>
    <cpix:ContentKeyUsageRule intendedTrackType="SD" kid="4eedd18e-69fd-11eb-9439-0242ac130002">
      <cpix:KeyPeriodFilter periodId="keyPeriod_9c786af2-f23f-37d2-a7f9-c94aaf3c94fe"/>
    </cpix:ContentKeyUsageRule>
    <cpix:ContentKeyUsageRule intendedTrackType="HD" kid="a58f1b10-ebad-498f-a3f5-135b4a59b937">
      <cpix:KeyPeriodFilter periodId="keyPeriod_9c786af2-f23f-37d2-a7f9-c94aaf3c94fe"/>
    </cpix:ContentKeyUsageRule>
  </cpix:ContentKeyUsageRuleList>
</cpix:CPIX>

Response Information

Resource Description

None.

Status Codes

All HTTP status codes must be expected, but the following status codes are the most probable:

OK (200) - CPIX response was successfully generated.
BadRequest (400) - CPIX response generation failed due to invalid input.

Response Formats

application/cpix+xml

Sample:

<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<cpix:CPIX xmlns:cpix="urn:dashif:org:cpix" xmlns:pskc="urn:ietf:params:xml:ns:keyprov:pskc" contentId="test_content">
    <cpix:ContentKeyList>
        <cpix:ContentKey kid="cce98949-f5fc-3282-51b0-1809b6b70e0d" explicitIV="el0rqgfWg4XA1G+M1GM+bw==">
            <cpix:Data>
                <pskc:Secret>
                    <pskc:PlainValue>cBuUOmHGmuqyxi7/cx5INg==</pskc:PlainValue>
                </pskc:Secret>
            </cpix:Data>
        </cpix:ContentKey>
        <cpix:ContentKey kid="131783ca-166a-61d6-81f9-e2d79c185cf9" explicitIV="UDNYdrqJ7o1Vb7IdLvdeCQ==">
            <cpix:Data>
                <pskc:Secret>
                    <pskc:PlainValue>NZPcPV6htM5SqCKuJ9mOAw==</pskc:PlainValue>
                </pskc:Secret>
            </cpix:Data>
        </cpix:ContentKey>
    </cpix:ContentKeyList>
    <cpix:DRMSystemList>
        <cpix:DRMSystem systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2" kid="cce98949-f5fc-3282-51b0-1809b6b70e0d">
            <cpix:HLSSignalingData playlist="master">I0VYVC1YLVNFU1NJT04tS0VZOk1FVEhPRD1TQU1QTEUtQUVTLFVSST0ic2tkOi8vY2NlOTg5NDktZjVmYy0zMjgyLTUxYjAtMTgwOWI2YjcwZTBkOjdBNUQyQkFBMDdENjgzODVDMEQ0NkY4Q0Q0NjMzRTZGIixLRVlGT1JNQVQ9ImNvbS5hcHBsZS5zdHJlYW1pbmdrZXlkZWxpdmVyeSIsS0VZRk9STUFUVkVSU0lPTlM9IjEi</cpix:HLSSignalingData>
            <cpix:HLSSignalingData playlist="media">I0VYVC1YLUtFWTpNRVRIT0Q9U0FNUExFLUFFUyxVUkk9InNrZDovL2NjZTk4OTQ5LWY1ZmMtMzI4Mi01MWIwLTE4MDliNmI3MGUwZDo3QTVEMkJBQTA3RDY4Mzg1QzBENDZGOENENDYzM0U2RiIsS0VZRk9STUFUPSJjb20uYXBwbGUuc3RyZWFtaW5na2V5ZGVsaXZlcnkiLEtFWUZPUk1BVFZFUlNJT05TPSIxIg==</cpix:HLSSignalingData>
        </cpix:DRMSystem>
        <cpix:DRMSystem systemId="94ce86fb-07ff-4f43-adb8-93d2fa968ca2" kid="131783ca-166a-61d6-81f9-e2d79c185cf9">
            <cpix:HLSSignalingData playlist="master">I0VYVC1YLVNFU1NJT04tS0VZOk1FVEhPRD1TQU1QTEUtQUVTLFVSST0ic2tkOi8vMTMxNzgzY2EtMTY2YS02MWQ2LTgxZjktZTJkNzljMTg1Y2Y5OjUwMzM1ODc2QkE4OUVFOEQ1NTZGQjIxRDJFRjc1RTA5IixLRVlGT1JNQVQ9ImNvbS5hcHBsZS5zdHJlYW1pbmdrZXlkZWxpdmVyeSIsS0VZRk9STUFUVkVSU0lPTlM9IjEi</cpix:HLSSignalingData>
            <cpix:HLSSignalingData playlist="media">I0VYVC1YLUtFWTpNRVRIT0Q9U0FNUExFLUFFUyxVUkk9InNrZDovLzEzMTc4M2NhLTE2NmEtNjFkNi04MWY5LWUyZDc5YzE4NWNmOTo1MDMzNTg3NkJBODlFRThENTU2RkIyMUQyRUY3NUUwOSIsS0VZRk9STUFUPSJjb20uYXBwbGUuc3RyZWFtaW5na2V5ZGVsaXZlcnkiLEtFWUZPUk1BVFZFUlNJT05TPSIxIg==</cpix:HLSSignalingData>
        </cpix:DRMSystem>
    </cpix:DRMSystemList>
    <cpix:ContentKeyPeriodList>
        <cpix:ContentKeyPeriod id="keyPeriod_9c786af2-f23f-37d2-a7f9-c94aaf3c94fe" index="1609335911" />
    </cpix:ContentKeyPeriodList>
    <cpix:ContentKeyUsageRuleList>
        <cpix:ContentKeyUsageRule kid="cce98949-f5fc-3282-51b0-1809b6b70e0d" intendedTrackType="SD">
            <cpix:KeyPeriodFilter periodId="keyPeriod_9c786af2-f23f-37d2-a7f9-c94aaf3c94fe" />
        </cpix:ContentKeyUsageRule>
        <cpix:ContentKeyUsageRule kid="131783ca-166a-61d6-81f9-e2d79c185cf9" intendedTrackType="HD">
            <cpix:KeyPeriodFilter periodId="keyPeriod_9c786af2-f23f-37d2-a7f9-c94aaf3c94fe" />
        </cpix:ContentKeyUsageRule>
    </cpix:ContentKeyUsageRuleList>
</cpix:CPIX>