Updating backups

PUT /v3/{project_id}/backups/{backup_id}

Update settings in a backup.

Source: https://docs.openstack.org/api-ref/block-storage/v3/#update-a-backup

Request

Parameters

Name In Type Description
project_id path string The UUID of the project.
backup_id path string The UUID for a backup.
backup body object A backup object.
description (Optional) body string The backup description or null.
name (Optional) body string The name of the volume backup.
metadata (Optional) body object

The backup metadata key value pairs.

New in version 3.43

Example

# curl -ks -X PUT -H 'Content-Type: application/json' -H 'OpenStack-API-Version: volume 3.66' -H 'X-Auth-Token: gAAAAA<...>' -d '\
{
    "backup":{
        "name":"mybackup",
        "description": "My new backup"
    }
}' https://<node_IP_addr>:8776/v3/3046fb2c2a314a0fbb32607caa1e5277/backups/bcb8fc88-a0ba-4cd0-801a-e9face1eac88

Response

Parameters

Name In Type Description
backup body object A backup object.
id body string The UUID of the backup.
links body array Links for the backup.
name body string The backup name.
metadata (Optional) body object

The backup metadata key value pairs.

New in version 3.43

Status codes

Success

Code Reason
200 - OK Request was successful.

Error

Code Reason
400 - Bad Request

Some content in the request was invalid.

Example

{
  "backup": {
    "id": "bcb8fc88-a0ba-4cd0-801a-e9face1eac88",
    "name": "mybackup",
    "links": [
      {
        "rel": "self",
        "href": "https://<node_IP_addr>:8776/v3/3046fb2c2a314a0fbb32607caa1e5277/backups/bcb8fc88-a0ba-4cd0-801a-e9face1eac88"
      },
      {
        "rel": "bookmark",
        "href": "https://<node_IP_addr>:8776/3046fb2c2a314a0fbb32607caa1e5277/backups/bcb8fc88-a0ba-4cd0-801a-e9face1eac88"
      }
    ]
  }
}