Listing backups for a project

GET /v3/{project_id}/backups

List backups to which the project has access.

Source: https://docs.openstack.org/api-ref/block-storage/v3/#list-backups-for-project

Request

Parameters

Name	In	Type	Description
project_id	path	string	The UUID of the project.
all_tenants (Optional)	query	string	Shows details for all project. Admin only.
sort (Optional)	query	string	Comma-separated list of sort keys and optional sort directions in the form of <key>[:<direction>]. A valid sort key value is name, status, container_format, disk_format, size, id, created_at, or updated_at. Default is created_at. A valid direction is asc (ascending) or desc (descending).
limit (Optional)	query	integer	Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.
offset (Optional)	query	integer	Used in conjunction with limit to return a slice of items. offset specifies where to start in the list.
marker (Optional)	query	string	The ID of the last-seen item. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.
with_count (Optional)	query	boolean	Whether to show count in the API response or not, default is False. New in version 3.45

Example

# curl -ks -H 'Content-Type: application/json' -H 'X-Auth-Token: gAAAAA<...>' \
https://<node_IP_addr>:8776/v3/3046fb2c2a314a0fbb32607caa1e5277/backups

Response

Parameters

Name	In	Type	Description
backups	body	array	A list of backup objects.
id	body	string	The UUID of the backup.
links	body	array	Links for the backup.
name	body	string	The backup name.
count (Optional)	body	integer	The total count of requested resource before pagination is applied. New in version 3.45
backup_links (Optional)	body	array	An array containing an object with the following fields: rel with the value next and href, whose value is a link to the next page of backups. Only appears when there are more backups than are listed in the current response.

Status codes

Success

Code	Reason
200 - OK	Request was successful.

Error

Code	Reason
400 - Bad Request	Some content in the request was invalid.

Example

{
  "backups": [
    {
      "id": "1e49d21e-44e1-401c-acc5-59115c12f0c4",
      "name": "vm2/cirros/Boot volume-2024-05-09T10:41:13",
      "links": [
        {
          "rel": "self",
          "href": "https://<node_IP_addr>:8776/v3/3046fb2c2a314a0fbb32607caa1e5277/backups/1e49d21e-44e1-401c-acc5-59115c12f0c4"
        },
        {
          "rel": "bookmark",
          "href": "https://<node_IP_addr>:8776/3046fb2c2a314a0fbb32607caa1e5277/backups/1e49d21e-44e1-401c-acc5-59115c12f0c4"
        }
      ]
    }
  ]
}