v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/create-classic-key

Request body

algstring required

Classic Key type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, RSA1024, RSA2048, RSA3072, RSA4096, EC256, EC384, GPG]

auto-rotatestring

Whether to automatically rotate every rotation_interval days, or disable existing automatic rotation [true/false]

cert-file-datastring

Certificate in a PEM format.

certificate-common-namestring

Common name for the generated certificate. Relevant only for generate-self-signed-certificate.

certificate-countrystring

Country name for the generated certificate. Relevant only for generate-self-signed-certificate.

certificate-digest-algostring

Digest algorithm to be used for the certificate key signing.

certificate-formatstring
certificate-localitystring

Locality for the generated certificate. Relevant only for generate-self-signed-certificate.

certificate-organizationstring

Organization name for the generated certificate. Relevant only for generate-self-signed-certificate.

certificate-provincestring

Province name for the generated certificate. Relevant only for generate-self-signed-certificate.

certificate-ttlinteger

TTL in days for the generated certificate. Required only for generate-self-signed-certificate.

conf-file-datastring

The csr config data in base64 encoding

delete_protectionstring

Protection from accidental deletion of this object [true/false]

descriptionstring

Description of the object

expiration-event-instring[]

How many days before the expiration of the certificate would you like to be notified.

generate-self-signed-certificateboolean

Whether to generate a self signed certificate with the key. If set, --certificate-ttl must be provided.

gpg-algstring

gpg alg: Relevant only if GPG key type selected; options: [RSA1024, RSA2048, RSA3072, RSA4096, Ed25519]

hash-algorithmstring

Specifies the hash algorithm used for the encryption key's operations, available options: [SHA256, SHA384, SHA512]

item-custom-fieldsobject

Additional custom fields to associate with the item

jsonboolean

Set output format to JSON

key-datastring

Base64-encoded classic key value

metadatastring

Deprecated - use description

namestring required

ClassicKey name

protection-key-namestring

The name of a key that used to encrypt the secret value (if empty, the account default protectionKey key will be used)

rotation-event-instring[]

How many days before the rotation of the item would you like to be notified

rotation-intervalstring

The number of days to wait between every automatic rotation (1-365)

tagsstring[]

Add tags attached to this object

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

Response

CreateClassicKeyResponse wraps response body.

classic_key_idstring
classic_key_namestring
classic_key_typestring
public_keystring