CCKM Key Backup

This section describes how to create job configurations to add CCKM key backups for Azure clouds. A CCKM key backup job automatically detects the CCKM key backups based on the Azure Cloud connection and adds them to the CipherTrust Cloud Key Manager.

Creating CCKM Key Backup Job Configuration

Use the post /v1/scheduler/job-configs API to create a new add CCKM key backup job configuration.

Syntax

curl -k '<IP>/api/v1/scheduler/job-configs' -H 'Authorization: Bearer AUTHTOKEN' -H 'Content-Type: application/json' --data-binary $'{\n  "name": "<configuration name>",\n  "operation": "<operation>",\n  "description": "<description>",\n  "run_on": "<run on>",\n  "run_at": "<time when you want to run the job>"\n  "cckm_key_backup_params": {<CCKM key backup addition parameters>}\n}' --compressed

Request Parameters

Parameter	Type	Description
AUTHTOKEN	string	Authorization token.
name	string	Name of the job configuration.
operation	string	Type of operation that can be scheduled. For CCKM key backup addition, specify `cckm_key_backup_params`.
run_at	string	Time when a job will run. Specify this parameter using the cron expression format: `"* * * * *"`.
cckm_key_backup_params	JSON	Parameters required for configuring an add CCKM key backup job. Refer to Add CCKM key backup Parameters for details.
description	string	Description for the job configuration.
disabled	boolean	Flag to disable job configuration. Set to `true` to disable the job.
end_date	string	End date for a job configuration. The job becomes inactive at this time. Specify the value in the `RFC3339` format.
run_on	string	Node in a cluster on which the job configuration will run. Possible values are: • `any`: Runs the job configuration on any node. • `<specific node id>`: Runs the job configuration on the specified node.
start_date	string	Time to start a job configuration. The job becomes active at this time. Specify the value in the `RFC3339` format.

Add CCKM key backup Parameters

Parameter	Type	Description
cloud_name	string	Name of the cloud in which the key backup operation will be triggered. The only supported value is "AzureCloud".

Example Request

curl -k 'https://127.0.0.1/api/v1/scheduler/job-configs' -H 'Authorization: Bearer eyJhbGciOiJFUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiIzMDI4OWIwZS03NGQ0LTRmOTEtODIxZC03NjM3MzNhNmI3YTgiLCJzdWIiOiJsb2NhbHw5YmMzZTdlZC1lMzcxLTQzY2YtYThhYy1hOTE2MTI4NDc2MGQiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJjbGllbnRfaWQiOiI4MzdjODQwZC03NWRkLTRiNGYtYTMxOC03OWNiMTZjYTI0OGQiLCJjbGllbnRfbmFtZSI6ImFwaS1wbGF5Z3JvdW5kIiwiY2xpZW50X3R5cGUiOiJwdWJsaWMiLCJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiODM3Yzg0MGQtNzVkZC00YjRmLWEzMTgtNzljYjE2Y2EyNDhkIiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6IjIzN2EyNmNjLWM2ZGItNDUwYi04N2RmLWM1ZDE2ZjViYzM0NyIsImlhdCI6MTcxODE4ODY5NCwiZXhwIjoxNzE4MTg4OTk0fQ.dyg1Z3XgHdBt3TvjmG_se16aGC84qF4tPdF3Nk-OF2WgV-94BHNGft6zo_7WpslHBIQ1fjs8-MQ2tMcteX-88g' -H 'Content-Type: application/json' -H 'accept: application/json' --data-binary $'{\n  "name": "add cckm key backup",\n  "operation": "cckm_key_backup",\n  "description": "This is to rotate AES keys",\n  "run_on": "any",\n  "run_at": "0 1 * * *",\n  "cckm_key_backup_params": {\n        "cloud_name": "AzureCloud"\n  }\n}' --compressed

Example Response

{
    "id": "71ec2e33-8669-4e8e-8f1d-23079b6c5e23",
    "uri": "kylo:kylo:scheduler:job_configs:71ec2e33-8669-4e8e-8f1d-23079b6c5e23",
    "account": "kylo:kylo:admin:accounts:kylo",
    "application": "ncryptify:gemalto:admin:apps:kylo",
    "devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
    "createdAt": "2023-07-26T07:22:11.356276061Z",
    "name": "add_cckm_key_backups",
    "updatedAt": "2023-07-26T07:22:11.356276061Z",
    "description": "This is to add CCKM key backups",
    "operation": "cckm_key_backup_params",
    "run_at": "30 * * * *",
    "run_on": "any",
    "disabled": false,
    "cloud_name": "AzureCloud",
}

The sample output shows that a job configuration is created and a unique ID (71ec2e33-8669-4e8e-8f1d-23079b6c5e23) for the job configuration is returned.

Response Codes

Response Code	Description
2xx	Success
4xx	Client errors
5xx	Server errors

Refer to HTTP status codes for details.

Suggest A Change