POST api/ContentKeys
Creates a new content key.
Request Information
URI Parameters
None.
Body Parameters
Data to use for the new content key.
NewContentKey| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The ID of the content key. If not specified, it will be generated. |
globally unique identifier |
None. |
| Name |
The name of the content key. |
string |
Max length: 256 Min length: 1 |
| KeySeedId |
The ID of the key seed that will be used to generate the content key. If not specified, the cryptographically secure random number generator will be used to generate the content key. |
globally unique identifier |
None. |
Request Formats
application/json, text/json
{
"Id": "6b18dbea-9f8d-40b1-b66e-54c2c385c94e",
"Name": "sample string 1",
"KeySeedId": "a5adc4a5-98e6-474b-b840-97c0ce0810f0"
}
Response Information
Resource Description
ContentKey| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The ID of the content key. |
globally unique identifier |
Required |
| Name |
The name of the content key. |
string |
Max length: 256 Min length: 1 |
| Created |
The date when the content key was created (in the ISO 8601 format). |
date |
Required |
| Updated |
The date when the content key was updated last time (in the ISO 8601 format). |
date |
None. |
| CreationMethod |
The category of the log entry. Where: 0 is "Random"; 1 is "KeySeed"; 2 is "Import". |
byte |
Required |
Status Codes
All HTTP status codes must be expected, but the following status codes are the most probable:
- Created (201) - The content key is successfully added.
- BadRequest (400) - The data for a new content key is invalid.
Response Formats
application/json, text/json
{
"Id": "2b88b09e-ea5b-4f78-ad38-a33dac54c161",
"Name": "sample string 2",
"Created": "2024-10-21T01:06:09.8099201+00:00",
"Updated": "2024-10-21T01:06:09.8099201+00:00",
"CreationMethod": 64
}