CreateKey

GET /?Action=CreateKey
Description

Creates a customer master key (CMK).
For example with OSC CLI:
osc-cli okms CreateKey \
  --Description DESCRIPTION \
  --Tags '[{"TagKey": "AAAA", "TagValue": "BBBB"}, {"TagKey": "CCCC", "TagValue": "DDDD"}]'

Body parameter

Required: false
Name: CreateKeyRequest

Name Description Required Schema Default Example

Description

A description for the CMK, between 0 and 8192 Unicode characters.

false

string

KeyUsage

The intended use of the CMK. By default, ENCRYPT_DECRYPT, which is the only valid value.

false

string

Origin

The source of the key material for the CMK. By default, OKMS, which is the only valid value.

false

string

Tags

One or more tags you want to associate with the CMK.
A tag key can contain between 1 and 128 characters.
A tag value can contain between 0 and 256 characters.

false

string
Responses
HTTP Code 200
HTTP Code Description Schema

200

CreateKeyResult

Response 200

Response 200

Name Description Required Schema Default Example

KeyMetadata

Information about the CMK.

false

KeyMetadata

requestId

The ID of the request.

false

string