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.

UpdatedKeySeed

Name	Description	Type	Additional information
Name	The name of the content key.	string	Max length: 256 Min length: 1
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.

Name

Description

Type

Additional information

Name

The name of the content key.

string

Max length: 256

Min length: 1

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

Sample:

{
  "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:

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

Sample:

{
  "Id": "4796161c-7250-4aa5-8960-42562ddc2e0c",
  "Name": "sample string 2",
  "Created": "2024-10-24T23:59:47.2630424+00:00",
  "Updated": "2024-10-24T23:59:47.2630424+00:00",
  "Generated": true,
  "MadeDefault": "2024-10-24T23:59:47.2630424+00:00"
}