Creating Azure Bulk Job
Use the post /v1/cckm/azure/bulkjobs API to create the Azure bulk job.
Syntax
curl -k '<IP>/api/v1/cckm/azure/bulkjobs' -X POST -H 'Authorization: Bearer AUTHTOKEN' --compressed
Request Parameter
| Parameter | Type | Description |
|---|---|---|
| AUTHTOKEN | string | Authorization token. |
| operation | string | Operation to be performed in the bulk job. Option is delete-key-backups |
| delete_key_backups_param (optional) | string | It contains the parameters of Azure delete key backups. The parameters are backup, created_after, and created_before. |
| backups (optional) | string | ID of the key backup on which the operation to be performed. |
| created_after (optional) | string | All the key backup created after this will be deleted. If created_before and created_after are given , all the key backup within this range will be deleted. |
| created_before (optional) | string | All the key backup created before this will be deleted. |
| key_id (optional) | string | ID of the Azure key for which backup should be deleted. |
| keys (optional) | string | ID of the Azure keys on which the operation to be performed. key_id, keys, and vault_id are mutually exclusive. |
| vault_id (optional) | string | ID of the Azure vault on which the operation to be performed. The cloud key backup of all the keys available in the provided vault will be deleted. key_id, keys, and vault_id are mutually exclusive. |
Example Request
curl -k 'https://54.175.71.61/api/v1/cckm/azure/bulkjobs' -X POST -H 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOiI1NjlmZTIyMy0zZGM2LTRhZDctYjE5YS1lYjFlZTY4MDBlMzUiLCJzdWIiOiJsb2NhbHxjNjc2ZGM1Zi1iMjNjLTQ4ODgtYTZmYi05MjMwNWU3MDdkNDMiLCJpc3MiOiJreWxvIiwiYWNjIjoia3lsbyIsInByZWZlcnJlZF91c2VybmFtZSI6ImFkbWluIiwiY3VzdCI6eyJkb21haW5faWQiOiIwMDAwMDAwMC0wMDAwLTAwMDAtMDAwMC0wMDAwMDAwMDAwMDAiLCJncm91cHMiOlsiYWRtaW4iXSwic2lkIjoiYTlhZmY2ZGMtYTdjYy00NmJiLThiYTUtMDg3OWViZGRiZTA1Iiwiem9uZV9pZCI6IjAwMDAwMDAwLTAwMDAtMDAwMC0wMDAwLTAwMDAwMDAwMDAwMCJ9LCJqd3RpZCI6ImQ3MDY1MDhiLTllYWYtNDQ0Mi04MGY4LWM4NTA2ODBlOWUyZCIsImlhdCI6MTYwMzEwNDA4NCwiZXhwIjoxNjAzMTA0Mzg0fQ.Kp-X2Y9cb_PSJtIasz_krM6wip4s8_LTu7ozPJZ_2Hs' --compressed
Example Response
{
"id": "ee4482eb-0b97-4702-8ef6-7e86df66eaa5",
"uri": "kylo:kylo:cckm:azure-bulkjob:ee4482eb-0b97-4702-8ef6-7e86df66eaa5",
"account": "kylo:kylo:admin:accounts:kylo",
"createdAt": "2024-02-06T09:22:54.517569Z",
"updatedAt": "2024-02-06T09:22:54.516554Z",
"overall_status": "in_progress",
"abort": false,
"cloud": "AzureCloud",
"operation": "delete-key-backups"
}
The sample output shows that the Azure bulk job (with ID ee4482eb-0b97-4702-8ef6-7e86df66eaa5) is created.
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.
