POST api/KeySeeds

Creates a new key seed.

Request Information

URI Parameters

None.

Body Parameters

Data to use for the new key seed.

NewKeySeed
NameDescriptionTypeAdditional 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

Data

The key seed. If not specified, it will be generated.

Collection of byte

Max length: 30

Min length: 30

IsDefault

Indicates whether the key seed must be treated as the default one.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "abb82396-fac3-41f2-a922-baa305a39a99",
  "Name": "sample string 1",
  "Data": "QEA=",
  "IsDefault": true
}

Response Information

Resource Description

KeySeed
NameDescriptionTypeAdditional 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:

  • 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

Sample:
{
  "Id": "3d80565d-e117-42c8-b476-e150172fec6b",
  "Name": "sample string 2",
  "Data": "QEA=",
  "IsSecured": true,
  "Created": "2024-09-24T02:28:32.7789945+00:00",
  "Updated": "2024-09-24T02:28:32.7789945+00:00",
  "MadeDefault": "2024-09-24T02:28:32.7789945+00:00"
}