v1

latestOpenAPI 3.0.02026-07-246171,3332.1 MB
v2

post/create-dfc-key

Request body

algstring required

DFCKey type; options: [AES128GCM, AES256GCM, AES128SIV, AES256SIV, AES128CBC, AES256CBC, RSA1024, RSA2048, RSA3072, RSA4096]

auto-rotatestring

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

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

customer-frg-idstring

The customer fragment ID that will be used to create the DFC key (if empty, the key will be created independently of a customer fragment)

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.

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

metadatastring

Deprecated - use description

namestring required

DFCKey name

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 (7-365)

split-levelinteger

The number of fragments that the item will be split into (not includes customer fragment)

tagstring[]

List of the tags attached to this DFC key

tokenstring

Authentication token (see /auth and /configure)

uid-tokenstring

The universal identity token, Required only for universal_identity authentication

Response

createDFCKeyResponse wraps response body.

fragment_resultsDuration[]