Backups

Volume backup management

List backups

get

Lists all Block Storage backups

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Query parameters

all_tenantsstringOptional

Shows details for all project. Admin only.

sortstringOptional

Comma-separated list of sort keys and optional sort directions

sort_keystringOptional

Sorts by an attribute

sort_dirstring · enumOptional

Sorts by direction (asc or desc)

Possible values:

limitinteger · min: 1Optional

Requests a page size of items

offsetintegerOptional

Used in conjunction with limit to return items starting from the offset position

markerstringOptional

The ID of the last-seen item

with_countbooleanOptional

Whether to show count in response (microversion 3.45+)

Responses

200

OK

application/json

get

/v3/backups

HTTPcURLJavaScriptPython

GET /v3/v3/backups HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "backups": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "links": [
        {
          "href": "https://example.com",
          "rel": "text",
          "type": "text"
        }
      ]
    }
  ],
  "backups_links": [
    {
      "href": "https://example.com",
      "rel": "text",
      "type": "text"
    }
  ],
  "count": 1
}

Create backup

post

Creates a volume backup

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Body

application/json

Responses

202

Accepted

application/json

post

/v3/backups

HTTPcURLJavaScriptPython

POST /v3/v3/backups HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 229

{
  "backup": {
    "volume_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "container": "text",
    "incremental": true,
    "force": true,
    "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
    "availability_zone": "text"
  }
}

202

Accepted

{
  "backup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "volume_id": "123e4567-e89b-12d3-a456-426614174000",
    "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "text",
    "size": 1,
    "object_count": 1,
    "container": "text",
    "availability_zone": "text",
    "created_at": "2025-11-28T20:27:01.722Z",
    "updated_at": "2025-11-28T20:27:01.722Z",
    "data_timestamp": "2025-11-28T20:27:01.722Z",
    "has_dependent_backups": true,
    "is_incremental": true,
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "encryption_key_id": "123e4567-e89b-12d3-a456-426614174000",
    "links": [
      {
        "href": "https://example.com",
        "rel": "text",
        "type": "text"
      }
    ]
  }
}

Perform backup action

post

Performs various actions on a backup

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters

backup_idstring · uuidRequired

The UUID of the backup

Body

application/json

one ofOptional

or

or

or

Responses

200

OK (for export operations)

application/json

Responseobject

202

Request is accepted, but processing may take some time

post

/v3/backups/{backup_id}/action

HTTPcURLJavaScriptPython

POST /v3/v3/backups/{backup_id}/action HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 78

{
  "restore": {
    "volume_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text"
  }
}

{}

List backups with details

get

Lists all Block Storage backups with details

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Query parameters

all_tenantsstringOptional

Shows details for all project. Admin only.

sortstringOptional

Comma-separated list of sort keys and optional sort directions

sort_keystringOptional

Sorts by an attribute

sort_dirstring · enumOptional

Sorts by direction (asc or desc)

Possible values:

limitinteger · min: 1Optional

Requests a page size of items

offsetintegerOptional

Used in conjunction with limit to return items starting from the offset position

markerstringOptional

The ID of the last-seen item

with_countbooleanOptional

Whether to show count in response (microversion 3.45+)

Responses

200

OK

application/json

get

/v3/backups/detail

HTTPcURLJavaScriptPython

GET /v3/v3/backups/detail HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "backups": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "volume_id": "123e4567-e89b-12d3-a456-426614174000",
      "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
      "status": "text",
      "size": 1,
      "object_count": 1,
      "container": "text",
      "availability_zone": "text",
      "created_at": "2025-11-28T20:27:01.722Z",
      "updated_at": "2025-11-28T20:27:01.722Z",
      "data_timestamp": "2025-11-28T20:27:01.722Z",
      "has_dependent_backups": true,
      "is_incremental": true,
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "project_id": "123e4567-e89b-12d3-a456-426614174000",
      "encryption_key_id": "123e4567-e89b-12d3-a456-426614174000",
      "links": [
        {
          "href": "https://example.com",
          "rel": "text",
          "type": "text"
        }
      ]
    }
  ],
  "backups_links": [
    {
      "href": "https://example.com",
      "rel": "text",
      "type": "text"
    }
  ],
  "count": 1
}

Show backup details

get

Shows details for a backup

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters

backup_idstring · uuidRequired

The UUID of the backup

Responses

200

OK

application/json

get

/v3/backups/{backup_id}

HTTPcURLJavaScriptPython

GET /v3/v3/backups/{backup_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*

200

OK

{
  "backup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "volume_id": "123e4567-e89b-12d3-a456-426614174000",
    "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "text",
    "size": 1,
    "object_count": 1,
    "container": "text",
    "availability_zone": "text",
    "created_at": "2025-11-28T20:27:01.722Z",
    "updated_at": "2025-11-28T20:27:01.722Z",
    "data_timestamp": "2025-11-28T20:27:01.722Z",
    "has_dependent_backups": true,
    "is_incremental": true,
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "encryption_key_id": "123e4567-e89b-12d3-a456-426614174000",
    "links": [
      {
        "href": "https://example.com",
        "rel": "text",
        "type": "text"
      }
    ]
  }
}

Update backup

put

Updates a backup

Authorizations

ApiKeyAuthBearerAuth

X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters

backup_idstring · uuidRequired

The UUID of the backup

Body

application/json

Responses

200

OK

application/json

put

/v3/backups/{backup_id}

HTTPcURLJavaScriptPython

PUT /v3/v3/backups/{backup_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 47

{
  "backup": {
    "name": "text",
    "description": "text"
  }
}

200

OK

{
  "backup": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "volume_id": "123e4567-e89b-12d3-a456-426614174000",
    "snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
    "status": "text",
    "size": 1,
    "object_count": 1,
    "container": "text",
    "availability_zone": "text",
    "created_at": "2025-11-28T20:27:01.722Z",
    "updated_at": "2025-11-28T20:27:01.722Z",
    "data_timestamp": "2025-11-28T20:27:01.722Z",
    "has_dependent_backups": true,
    "is_incremental": true,
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "project_id": "123e4567-e89b-12d3-a456-426614174000",
    "encryption_key_id": "123e4567-e89b-12d3-a456-426614174000",
    "links": [
      {
        "href": "https://example.com",
        "rel": "text",
        "type": "text"
      }
    ]
  }
}