Managing checkpoints and backup plans, performing restore operations, and more
Deletes all backup checkpoints that match the specified chain UUID
| project_id required | string Project identifier in UUID format |
| chain_id required | string Chain UUID to filter checkpoints for deletion |
{- "deleted": [
- {
- "checkpoint_items": [
- {
- "backup_created_at": "2019-08-24T14:15:22Z",
- "backup_id": "string",
- "chain_id": "string",
- "checkpoint_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "is_incremental": true,
- "resource": {
- "id": "string",
- "name": "string",
- "type": "OS::Cinder::Volume"
}, - "status": "protecting"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "plan_id": "string",
- "status": "protecting"
}
]
}Returns a paginated list of backup checkpoints for the specified project
| project_id required | string Project identifier in UUID format |
| limit | integer >= 1 Default: 1000 Specifies the maximum number of backup checkpoints to retrieve |
| marker | string or null Specifies the UUID of the last checkpoint retrieved in the previous request. Used for pagination |
| volume_name | string or null Filters the checkpoints by the specified volume name |
| plan_name | string or null Filters the checkpoints by the specified backup plan name |
{- "checkpoints": [
- {
- "checkpoint_items": [
- {
- "backup_created_at": "2019-08-24T14:15:22Z",
- "backup_id": "string",
- "chain_id": "string",
- "checkpoint_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "is_incremental": true,
- "resource": {
- "id": "string",
- "name": "string",
- "type": "OS::Cinder::Volume"
}, - "status": "protecting"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "plan_id": "string",
- "status": "protecting"
}
], - "total": 0
}Deletes the specified backup checkpoint
| project_id required | string Project identifier in UUID format |
| checkpoint_id required | string Unique identifier of the checkpoint to be deleted |
{- "id": "string",
- "status": "protecting"
}Returns detailed information about the specified backup checkpoint
| project_id required | string Project identifier in UUID format |
| checkpoint_id required | string Checkpoint unique identifier |
{- "checkpoint_items": [
- {
- "backup_created_at": "2019-08-24T14:15:22Z",
- "backup_id": "string",
- "chain_id": "string",
- "checkpoint_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "is_incremental": true,
- "resource": {
- "id": "string",
- "name": "string",
- "type": "OS::Cinder::Volume"
}, - "status": "protecting"
}
], - "created_at": "2019-08-24T14:15:22Z",
- "id": "string",
- "plan_id": "string",
- "status": "protecting"
}Returns a paginated list of all backup plans for the specified project
| project_id required | string Project identifier in UUID format |
| limit | integer >= 1 Default: 1000 Specifies the maximum number of backup plans to retrieve |
| marker | string or null Specifies the UUID of the last backup plan retrieved in the previous request. Used for pagination. |
| name | string or null Filters backup plans by the specified name |
| volume_name | string or null Filters backup plans by the specified volume name |
{- "plans": [
- {
- "backup_mode": "full",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "max_backups": 0,
- "name": "string",
- "resources": [
- {
- "id": "string",
- "name": "string",
- "type": "OS::Cinder::Volume"
}
], - "schedule_pattern": "string",
- "schedule_type": "calendar",
- "status": "started"
}
], - "total": 0
}Creates a backup plan to protect project resources using the provided configuration
| project_id required | string Project identifier in UUID format |
| backup_mode required | string (BackupMode) Enum: "full" "frequency" Backup mode used for this plan |
| description required | string Detailed plan description |
| max_backups required | integer Maximum number of backups to save in a full plan or full backups in a frequency plan |
| name required | string Human-readable name of the plan |
required | Array of objects (Resource) List of resources included in the plan |
| schedule_pattern required | string <cron> Backup scheduling pattern |
| schedule_type required | string (ScheduleType) Enum: "calendar" "crontab" Backup scheduling type |
{- "backup_mode": "full",
- "description": "string",
- "max_backups": 0,
- "name": "string",
- "resources": [
- {
- "id": "string",
- "name": "string",
- "type": "OS::Cinder::Volume"
}
], - "schedule_pattern": "string",
- "schedule_type": "calendar"
}{- "backup_mode": "full",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "max_backups": 0,
- "name": "string",
- "resources": [
- {
- "id": "string",
- "name": "string",
- "type": "OS::Cinder::Volume"
}
], - "schedule_pattern": "string",
- "schedule_type": "calendar",
- "status": "started"
}Deletes a backup plan by its unique identifier
| project_id required | string Project identifier in UUID format |
| plan_id required | string Unique identifier of the backup plan |
{- "code": "string",
- "details": { },
- "error_key": "string",
- "message": "string",
- "title": "string"
}Returns information about the specified backup plan.
| project_id required | string Project identifier in UUID format |
| plan_id required | string Unique identifier of the backup plan |
{- "backup_mode": "full",
- "created_at": "2019-08-24T14:15:22Z",
- "description": "string",
- "id": "string",
- "max_backups": 0,
- "name": "string",
- "resources": [
- {
- "id": "string",
- "name": "string",
- "type": "OS::Cinder::Volume"
}
], - "schedule_pattern": "string",
- "schedule_type": "calendar",
- "status": "started"
}Updates one or more attributes of the specified backup plan
| project_id required | string Project identifier in UUID format |
| plan_id required | string Unique identifier of the backup plan |
| description | string or null Detailed plan description |
| max_backups | integer or null Maximum number of backups to save in a full plan or full backups in a frequency plan |
| name | string or null Human-readable name of the plan |
Array of objects or null (Resource) List of resources included in the plan | |
| schedule_pattern | string or null <cron> A valid cron expression |
| schedule_type | string or null (ScheduleType) Enum: "calendar" "crontab" Backup scheduling type |
| status | string or null (PlanStatus) Enum: "started" "suspended" Status of the plan |
{- "description": "string",
- "max_backups": 0,
- "name": "string",
- "resources": [
- {
- "id": "string",
- "name": "string",
- "type": "OS::Cinder::Volume"
}
], - "schedule_pattern": "string",
- "schedule_type": "calendar",
- "status": "started"
}{- "description": "string",
- "max_backups": 0,
- "name": "string",
- "resources": [
- {
- "id": "string",
- "name": "string",
- "type": "OS::Cinder::Volume"
}
], - "schedule_pattern": "string",
- "schedule_type": "calendar",
- "status": "started"
}Creates a restore operation for recovering a resource from a backup checkpoint
| project_id required | string Project identifier |
| checkpoint_item_id required | string Checkpoint item identifier |
| restore_name required | string New name for restored resource |
{- "checkpoint_item_id": "string",
- "restore_name": "string"
}{- "checkpoint_id": "string",
- "checkpoint_item_id": "string",
- "id": "string",
- "project_id": "string",
- "resource_id": "string",
- "resource_type": "OS::Cinder::Volume",
- "status": "success"
}