Enabling Key for Backup Job
Use the post /v1/cckm/azure/keys/{id}/enable-backup-job API to enable the Azure key for backup job.
Syntax
curl -k '<IP>/api/v1/cckm/azure/keys/{id}/enable-backup-job' -X POST -H 'Authorization: Bearer AUTHTOKEN' --compressed
Here, {id} represents the key ID.
Request Parameter
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
| backup_job_config_id | string | ID of the scheduler job that will perform the key backups. |
Example Request
curl -k 'https://54.175.71.61/api/v1/cckm/azure/keys/158dcbc7-bf59-4365-a11d-eb7d7fa9ef23/enable-backup-job' -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1NjlmZTIyMy0zZGM2LTRhZDctYjE5YS1lYjFlZTY4MDBlMzUiLCJzdWIiOiJsb2NhbHxjNjc2ZGM1Zi1iMjNjLTQ4ODgtYTZmYi05MjMwNWU3MDdkNDMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYTlhZmY2ZGMtYTdjYy00NmJiLThiYTUtMDg3OWViZGRiZTA1Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImQ3MDY1MDhiLTllYWYtNDQ0Mi04MGY4LWM4NTA2ODBlOWUyZCIsImlhdCI6MTYwMzEwNDA4NCwiZXhwIjoxNjAzMTA0Mzg0fQ.Kp-X2Y9cb_PSJtIasz_krM6wip4s8_LTu7ozPJZ_2Hs' --compressed
Example Response
{
"id": "158dcbc7-bf59-4365-a11d-eb7d7fa9ef23",
"uri": "kylo:kylo:cckm:azure-key:158dcbc7-bf59-4365-a11d-eb7d7fa9ef23",
"account": "kylo:kylo:admin:accounts:kylo",
"application": "ncryptify:gemalto:admin:apps:kylo",
"devAccount": "ncryptify:gemalto:admin:accounts:gemalto",
"createdAt": "2024-01-04T12:24:24.693066Z",
"updatedAt": "2024-01-04T12:24:24.692165Z",
"key_vault": "pkv-softkeys::260ecbe7-777b-4d3c-84ea-887620498863",
"key_vault_id": "0ef76428-50e6-4630-8b79-783a1f7eb231",
"region": "northcentralus",
"deleted": false,
"backup_at": "2024-01-04T12:24:24.687456Z",
"soft_delete_enabled": true,
"key_soft_deleted_in_azure": false,
"status": "AVAILABLE",
"operation": "",
"syncedAt": "2024-01-04T06:54:22Z",
"created_by": "a8f38993-aa49-4281-888c-52afd80af6b1",
"modified_by": "a8f38993-aa49-4281-888c-52afd80af6b1",
"version": "d65b4c80aad14f6c92531da96b752619",
"key_size": 4096,
"backup": "7095425a78e9431ba581c570a611c3ebc016a372bd6e45e2bc904da238bc92b1",
"key_name": "TestKey4thJan2024",
"key_source": "native",
"cloud_name": "AzureCloud",
"azure_param": {
"key": {
"kid": "https://pkv-softkeys.vault.azure.net/keys/TestKey4thJan2024/d65b4c80aad14f6c92531da96b752619",
"kty": "RSA",
"key_ops": [
"encrypt",
"decrypt",
"sign",
"verify",
"wrapKey",
"unwrapKey"
],
"n": "zYKyFzheeypCsDLZF3Yf2HYJRfJzSLXrtyuMVCNJjBd1Z9FYlhq_QcbNeKx12mxf4r1puClHmL6PinoWJFZtAM_nwJL2Q7EEIe9rzZCfmBVWGaFDIDZwAtXErDuUPpnfmXu4Kf8XcE-9T78NOhXEz6DfC1DxZZEZWYQv02EOlb_nGlRJy9Dy3F9V8Lc13P0gqxWpsBiarxk9kcsa_vgLvLdf8_wSAYZGKWpU3AfBRgtlPyvHg1tM8brwpigF75TPIw5-f66ikdcwo7cThMPTwep1SszotnZDfOku7oeYlNYBXGuHouxqUXYsLRX7qZpeH6N-8SwvvoQkY8bUIKiBcAxrI4CIQxWpIXD4i1Y-k9dgJuFKLD_SRIaJZLG6hoLXvasgCdhwX3d_Dcs0Gcl5MLZVxZCSNUYKuxTCDT9ZG6Yw6asUvNl_Vt7RErlRc6DWSW0YECmFjijb9lLHxKtexXu6SstK_r-rgGLNgGyPNnRBC_xfR2edwwSi_Jh6KrU85s7-rmDol12ngq4pLoMOH5VZUH9GOIZ0LkNLEIItnG_QZSYU5GAbjFcXSi-c-f-vgw6hRFaBTR4Kid5jiAv-8o6ejSdWRi_JN6qIe1qUzd8NcUmua98jAG3c_BqiZN_GladotlesT-jzLw-THsSy18sucyZ1TT2xQf48rx03DxU",
"e": "AQAB"
},
"attributes": {
"recoveryLevel": "CustomizedRecoverable+Purgeable",
"enabled": true,
"created": 1704351262,
"updated": 1704351262
}
},
"azure_created_at": "2024-01-04T06:54:22Z",
"azure_updated_at": "2024-01-04T06:54:22Z",
"tenant": "d27d849e-e487-4b0e-a54c-a71e67687d10",
"labels": {
"auto_rotate_enable_key": false,
"auto_rotate_key_size": 2048,
"auto_rotate_key_source": "ciphertrust",
"auto_rotate_key_type": "RSA",
"job_config_id": "6d520954-388b-4d47-b450-85d41e40210e"
},
"key_material_origin": "native",
"gone": false,
"backup_config": {
"backup_job_config_id": "f0358220-86db-4a0a-a2cf-171a51618f57"
},
"version_count": 1
}
The sample output shows that the key (with ID 158dcbc7-bf59-4365-a11d-eb7d7fa9ef23) is enabled for the backup job.
To know more about response parameters, refer to Response Parameters of Key Life Cycle Management APIs.
Response Codes
| Response Code | Description |
|---|---|
| 2xx | Success |
| 4xx | Client errors |
| 5xx | Server errors |
Refer to HTTP status codes for details.
