Skip to main content
API docs by Redocly

Scheduled Backup API (v2.0)

Managing checkpoints and backup plans, performing restore operations, and more

Checkpoints

View and delete checkpoints

Delete backup checkpoints

Deletes all backup checkpoints that match the specified chain UUID

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string

Project identifier in UUID format

query Parameters
chain_id
required
string

Chain UUID to filter checkpoints for deletion

Responses

Response samples

Content type
application/json
{
  • "deleted": [
    ]
}

List backup checkpoints

Returns a paginated list of backup checkpoints for the specified project

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string

Project identifier in UUID format

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "checkpoints": [
    ],
  • "total": 0
}

Delete backup checkpoint

Deletes the specified backup checkpoint

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string

Project identifier in UUID format

checkpoint_id
required
string

Unique identifier of the checkpoint to be deleted

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "status": "protecting"
}

Get backup checkpoint

Returns detailed information about the specified backup checkpoint

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string

Project identifier in UUID format

checkpoint_id
required
string

Checkpoint unique identifier

Responses

Response samples

Content type
application/json
{
  • "checkpoint_items": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "id": "string",
  • "plan_id": "string",
  • "status": "protecting"
}

Plans

Create, update, and delete backup plans

List backup plans

Returns a paginated list of all backup plans for the specified project

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string

Project identifier in UUID format

query Parameters
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

Responses

Response samples

Content type
application/json
{
  • "plans": [
    ],
  • "total": 0
}

Create backup plan

Creates a backup plan to protect project resources using the provided configuration

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string

Project identifier in UUID format

Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "backup_mode": "full",
  • "description": "string",
  • "max_backups": 0,
  • "name": "string",
  • "resources": [
    ],
  • "schedule_pattern": "string",
  • "schedule_type": "calendar"
}

Response samples

Content type
application/json
{
  • "backup_mode": "full",
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "max_backups": 0,
  • "name": "string",
  • "resources": [
    ],
  • "schedule_pattern": "string",
  • "schedule_type": "calendar",
  • "status": "started"
}

Delete backup plan

Deletes a backup plan by its unique identifier

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string

Project identifier in UUID format

plan_id
required
string

Unique identifier of the backup plan

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "details": { },
  • "error_key": "string",
  • "message": "string",
  • "title": "string"
}

Get backup plan

Returns information about the specified backup plan.

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string

Project identifier in UUID format

plan_id
required
string

Unique identifier of the backup plan

Responses

Response samples

Content type
application/json
{
  • "backup_mode": "full",
  • "created_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "id": "string",
  • "max_backups": 0,
  • "name": "string",
  • "resources": [
    ],
  • "schedule_pattern": "string",
  • "schedule_type": "calendar",
  • "status": "started"
}

Update backup plan

Updates one or more attributes of the specified backup plan

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string

Project identifier in UUID format

plan_id
required
string

Unique identifier of the backup plan

Request Body schema: application/json
required
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

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "max_backups": 0,
  • "name": "string",
  • "resources": [
    ],
  • "schedule_pattern": "string",
  • "schedule_type": "calendar",
  • "status": "started"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "max_backups": 0,
  • "name": "string",
  • "resources": [
    ],
  • "schedule_pattern": "string",
  • "schedule_type": "calendar",
  • "status": "started"
}

Restorations

Perform restore operations

Create restore operation

Creates a restore operation for recovering a resource from a backup checkpoint

Authorizations:
iam_token_project_scoped
path Parameters
project_id
required
string

Project identifier

Request Body schema: application/json
required
checkpoint_item_id
required
string

Checkpoint item identifier

restore_name
required
string

New name for restored resource

Responses

Request samples

Content type
application/json
{
  • "checkpoint_item_id": "string",
  • "restore_name": "string"
}

Response samples

Content type
application/json
{
  • "checkpoint_id": "string",
  • "checkpoint_item_id": "string",
  • "id": "string",
  • "project_id": "string",
  • "resource_id": "string",
  • "resource_type": "OS::Cinder::Volume",
  • "status": "success"
}