/create-dfc-key

post

https://api.akeyless.io/create-dfc-key

Body Params

alg

string

required

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

auto-rotate

string

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

certificate-common-name

string

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

certificate-country

string

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

certificate-digest-algo

string

Digest algorithm to be used for the certificate key signing.

certificate-format

string

certificate-locality

string

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

certificate-organization

string

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

certificate-province

string

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

certificate-ttl

int64

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

conf-file-data

string

The csr config data in base64 encoding

customer-frg-id

string

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_protection

string

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

description

string

Description of the object

expiration-event-in

array of strings

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

expiration-event-in

generate-self-signed-certificate

boolean

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

hash-algorithm

string

Defaults to SHA256

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

item-custom-fields

object

Additional custom fields to associate with the item

json

boolean

Defaults to false

Set output format to JSON

metadata

string

Deprecated - use description

name

string

required

DFCKey name

rotation-event-in

array of strings

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

rotation-event-in

rotation-interval

string

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

split-level

int64

Defaults to 3

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

tag

array of strings

List of the tags attached to this DFC key

tag

token

string

Authentication token (see /auth and /configure)

uid-token

string

The universal identity token, Required only for universal_identity authentication

Responses

200createDFCKeyResponse wraps response body.

defaulterrorResponse wraps any error to return it as a JSON object with one "error" field.