POST api/KeySeeds
Creates a new key seed.
Request Information
URI Parameters
None.
Body Parameters
Data to use for the new key seed.
NewKeySeed| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The ID of the key seed. If not specified, it will be generated. |
globally unique identifier |
None. |
| Name |
The name of the key seed. |
string |
Max length: 256 Min length: 1 |
| IsDefault |
Indicates whether the key seed must be treated as the default one. |
boolean |
None. |
Request Formats
application/json, text/json
{
"Id": "323c382b-7b07-4d9c-a400-3cb6b761c7dd",
"Name": "sample string 1",
"IsDefault": true
}
Response Information
Resource Description
KeySeed| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
The ID of the key seed. |
globally unique identifier |
Required |
| Name |
The name of the key seed. |
string |
Max length: 256 Min length: 1 |
| Created |
The date when the key seed was created (in the ISO 8601 format). |
date |
Required |
| Updated |
The date when the key seed was updated last time (in the ISO 8601 format). |
date |
None. |
| Generated |
Indicates whether the key seed was generated. If the key seed is not generated, then it was imported. |
boolean |
Required |
| MadeDefault |
The date when the key seed was made as the default one (in the ISO 8601 format). There may be multiple key seeds that were made as the default ones, but only one key seed will be treated as the default one. The default key seed is the last key seed that was made as the default one. If no key seeds were ever made as the default ones, the oldest key seed will be treated as the default one. |
date |
None. |
Status Codes
All HTTP status codes must be expected, but the following status codes are the most probable:
- Created (201) - The key seed is successfully added.
- BadRequest (400) - The data for a new key seed is invalid.
Response Formats
application/json, text/json
{
"Id": "8b30395e-e055-46d6-9c7e-a8c5419e69c9",
"Name": "sample string 2",
"Created": "2024-11-02T19:36:47.0111644+00:00",
"Updated": "2024-11-02T19:36:47.0111644+00:00",
"Generated": true,
"MadeDefault": "2024-11-02T19:36:47.0111644+00:00"
}