PUT api/KeySeeds/{id}
Updates a key seed.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
The ID of the key seed to update. |
globally unique identifier |
Required |
Body Parameters
The new data for the key seed.
UpdatedKeySeedName | Description | Type | Additional information |
---|---|---|---|
Name |
The name of the key seed. |
string |
Max length: 256 Min length: 1 |
Data |
The key seed. |
Collection of byte |
Required Max length: 30 Min length: 30 |
IsDefault |
Indicates whether the key seed must be treated as the default one. If set to false, the previous default key seed will be treated as the default key seed. If previously there was no default key seed, the oldest key seed will be treated as the default one. |
boolean |
None. |
Request Formats
application/json, text/json
{ "Name": "sample string 1", "Data": "QEA=", "IsDefault": true }
Response Information
Resource Description
KeySeedName | 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 |
Data |
The key seed. |
Collection of byte |
Max length: 30 Min length: 30 |
IsSecured |
Indicates whether the key seed has been secured and won't be exposed. |
boolean |
None. |
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. |
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:
- OK (200) - The key seed is successfully updated.
- BadRequest (400) - The ID of the key seed or the updated data for the key seed is invalid.
- NotFound (404) - The key seed with the specified ID is not found.
Response Formats
application/json, text/json
{ "Id": "73c62849-be45-4481-9b73-3890dca14906", "Name": "sample string 2", "Data": "QEA=", "IsSecured": true, "Created": "2024-09-18T22:42:16.0504134+00:00", "Updated": "2024-09-18T22:42:16.0504134+00:00", "MadeDefault": "2024-09-18T22:42:16.0504134+00:00" }