Snapshots

Volume snapshot management

List snapshots

get

Lists all Block Storage snapshots

Authorizations
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/snapshots
GET /v3/v3/snapshots HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
200

OK

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

Create snapshot

post

Creates a volume snapshot

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Body
Responses
post
/v3/snapshots
POST /v3/v3/snapshots HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "snapshot": {
    "volume_id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "force": true,
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    }
  }
}
202

Accepted

{
  "snapshot": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "size": 1,
    "status": "text",
    "volume_id": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "created_at": "2025-11-28T20:20:03.639Z",
    "updated_at": "2025-11-28T20:20:03.639Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "os-extended-snapshot-attributes:project_id": "123e4567-e89b-12d3-a456-426614174000",
    "os-extended-snapshot-attributes:progress": "text",
    "group_snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
    "consumes_quota": true,
    "links": [
      {
        "href": "https://example.com",
        "rel": "text",
        "type": "text"
      }
    ]
  }
}

List snapshots with details

get

Lists all Block Storage snapshots with details

Authorizations
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/snapshots/detail
GET /v3/v3/snapshots/detail HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
200

OK

{
  "snapshots": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "description": "text",
      "size": 1,
      "status": "text",
      "volume_id": "123e4567-e89b-12d3-a456-426614174000",
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "created_at": "2025-11-28T20:20:03.639Z",
      "updated_at": "2025-11-28T20:20:03.639Z",
      "user_id": "123e4567-e89b-12d3-a456-426614174000",
      "os-extended-snapshot-attributes:project_id": "123e4567-e89b-12d3-a456-426614174000",
      "os-extended-snapshot-attributes:progress": "text",
      "group_snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
      "consumes_quota": true,
      "links": [
        {
          "href": "https://example.com",
          "rel": "text",
          "type": "text"
        }
      ]
    }
  ],
  "snapshots_links": [
    {
      "href": "https://example.com",
      "rel": "text",
      "type": "text"
    }
  ],
  "count": 1
}

Show snapshot details

get

Shows details for a snapshot

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
snapshot_idstring · uuidRequired

The UUID of the snapshot

Responses
200

OK

application/json
get
/v3/snapshots/{snapshot_id}
GET /v3/v3/snapshots/{snapshot_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
200

OK

{
  "snapshot": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "size": 1,
    "status": "text",
    "volume_id": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "created_at": "2025-11-28T20:20:03.639Z",
    "updated_at": "2025-11-28T20:20:03.639Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "os-extended-snapshot-attributes:project_id": "123e4567-e89b-12d3-a456-426614174000",
    "os-extended-snapshot-attributes:progress": "text",
    "group_snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
    "consumes_quota": true,
    "links": [
      {
        "href": "https://example.com",
        "rel": "text",
        "type": "text"
      }
    ]
  }
}

Update snapshot

put

Updates a snapshot

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
snapshot_idstring · uuidRequired

The UUID of the snapshot

Body
Responses
200

OK

application/json
put
/v3/snapshots/{snapshot_id}
PUT /v3/v3/snapshots/{snapshot_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "snapshot": {
    "name": "text",
    "description": "text"
  }
}
200

OK

{
  "snapshot": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "text",
    "description": "text",
    "size": 1,
    "status": "text",
    "volume_id": "123e4567-e89b-12d3-a456-426614174000",
    "metadata": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "created_at": "2025-11-28T20:20:03.639Z",
    "updated_at": "2025-11-28T20:20:03.639Z",
    "user_id": "123e4567-e89b-12d3-a456-426614174000",
    "os-extended-snapshot-attributes:project_id": "123e4567-e89b-12d3-a456-426614174000",
    "os-extended-snapshot-attributes:progress": "text",
    "group_snapshot_id": "123e4567-e89b-12d3-a456-426614174000",
    "consumes_quota": true,
    "links": [
      {
        "href": "https://example.com",
        "rel": "text",
        "type": "text"
      }
    ]
  }
}

Delete snapshot

delete

Deletes a snapshot

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
snapshot_idstring · uuidRequired

The UUID of the snapshot

Responses
delete
/v3/snapshots/{snapshot_id}
DELETE /v3/v3/snapshots/{snapshot_id} HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Accept: */*
202

Request is accepted, but processing may take some time

No content

Perform snapshot action

post

Performs various actions on a snapshot

Authorizations
X-Auth-TokenstringRequired

OpenStack authentication token

Path parameters
snapshot_idstring · uuidRequired

The UUID of the snapshot

Body
one ofOptional
or
or
Responses
post
/v3/snapshots/{snapshot_id}/action
POST /v3/v3/snapshots/{snapshot_id}/action HTTP/1.1
Host: example.com
X-Auth-Token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "os-reset_status": {
    "status": "text"
  }
}
202

Request is accepted, but processing may take some time

No content
PreviousVolumesNextAttachments

Last updated

Was this helpful?