POST api/HarmonicConfiguration
Creates or updates the Harmonic configuration.
Request Information
URI Parameters
None.
Body Parameters
The Harmonic configuration.
NewHarmonicConfiguration| Name | Description | Type | Additional information |
|---|---|---|---|
| EncryptContentKeys |
Indicates whether content keys in response CPIX documents must be encrypted. This can only be enabled together with the RequireSignatures option. If true, then content keys will be encrypted with the public key of the signing certificate in the request CPIX. Default is false. |
boolean |
None. |
| RequireSignatures |
Indicates whether both request and response CPIX documents must be signed. If true, then request CPIX documents are required to have a valid signature and be signed by a white-listed certificate; and response CPIX documents will be signed by the Key Service certificate. To white-list certificates, contact Axinom. Default is false. Note: if this option is false, but a signed CPIX is provided, then the signature will still be validated, but trust will not be checked. |
boolean |
None. |
Request Formats
application/json, text/json
{
"EncryptContentKeys": true,
"RequireSignatures": true
}
Response Information
Resource Description
HarmonicConfiguration| Name | Description | Type | Additional information |
|---|---|---|---|
| EncryptContentKeys |
Indicates whether content keys in response CPIX documents must be encrypted. This can only be enabled together with the RequireSignatures option. If true, then content keys will be encrypted with the public key of the signing certificate in the request CPIX. Default is false. |
boolean |
None. |
| RequireSignatures |
Indicates whether both request and response CPIX documents must be signed. If true, then request CPIX documents are required to have a valid signature and be signed by a white-listed certificate; and response CPIX documents will be signed by the Key Service certificate. To white-list certificates, contact Axinom. Default is false. Note: if this option is false, but a signed CPIX is provided, then the signature will still be validated, but trust will not be checked. |
boolean |
None. |
| Created |
The date-time (in the ISO 8601 format) when the Harmonic configuration was first created. |
date |
None. |
| Updated |
The date-time (in the ISO 8601 format) when the Harmonic configuration was last updated. |
date |
None. |
Status Codes
All HTTP status codes must be expected, but the following status codes are the most probable:
- OK (200) - The provided Harmonic configuration is successfully set.
- BadRequest (400) - The provided Harmonic configuration is invalid.
Response Formats
application/json, text/json
{
"EncryptContentKeys": true,
"RequireSignatures": true,
"Created": "2024-09-24T02:21:18.2906465+00:00",
"Updated": "2024-09-24T02:21:18.2906465+00:00"
}