Skip to content

Openstack Snapshots

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openstack-snapshots/ List snapshots
GET /api/openstack-snapshots/{uuid}/ Get snapshot details
POST /api/openstack-snapshots/{uuid}/pull/ Synchronize resource state
POST /api/openstack-snapshots/{uuid}/unlink/ Unlink resource
PUT /api/openstack-snapshots/{uuid}/ Update snapshot
PATCH /api/openstack-snapshots/{uuid}/ Partially update snapshot
DELETE /api/openstack-snapshots/{uuid}/ Delete snapshot
Other Actions
GET /api/openstack-snapshots/{uuid}/restorations/ List snapshot restorations
POST /api/openstack-snapshots/{uuid}/restore/ Restore volume from snapshot

Core CRUD

List snapshots

Get a list of snapshots.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-snapshots/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_list.sync(client=client)

for item in response:
    print(item)
  1. API Source: openstack_snapshots_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { openstackSnapshotsList } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Description
backend_id string Backend ID
backup string Backup URL
backup_uuid string (uuid) Backup UUID
can_manage boolean Can manage
customer string (uuid) Customer UUID
customer_abbreviation string Customer abbreviation
customer_name string Customer name
customer_native_name string Customer native name
customer_uuid string (uuid) Customer UUID
description string Description
external_ip string External IP
field array
name string Name
name_exact string Name (exact)
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.
project string (uuid) Project UUID
project_name string Project name
project_uuid string (uuid) Project UUID
runtime_state string
service_settings_name string Service settings name
service_settings_uuid string (uuid) Service settings UUID
source_volume string Source volume URL
source_volume_uuid string (uuid) Source volume UUID
state array State
tenant string Tenant URL
tenant_uuid string (uuid) Tenant UUID
uuid string (uuid) UUID

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Snapshot ID in the OpenStack backend
access_url string
source_volume string (uri) Volume from which this snapshot was created
size integer Size in MiB
metadata any
runtime_state string
source_volume_name string
source_volume_marketplace_uuid string (uuid)
action string
action_details any
restorations array of objects
restorations.uuid string (uuid)
restorations.created string (date-time)
restorations.description string New volume description.
restorations.volume string (uri) Volume that is being restored from the snapshot
restorations.volume_name string
restorations.volume_state string
restorations.volume_runtime_state string
restorations.volume_size integer Size in MiB
restorations.volume_device string Name of volume as instance device e.g. /dev/vdb.
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Get snapshot details

Retrieve details of a specific snapshot.

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_snapshots_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsRetrieve } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type
field array

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Snapshot ID in the OpenStack backend
access_url string
source_volume string (uri) Volume from which this snapshot was created
size integer Size in MiB
metadata any
runtime_state string
source_volume_name string
source_volume_marketplace_uuid string (uuid)
action string
action_details any
restorations array of objects
restorations.uuid string (uuid)
restorations.created string (date-time)
restorations.description string New volume description.
restorations.volume string (uri) Volume that is being restored from the snapshot
restorations.volume_name string
restorations.volume_state string
restorations.volume_runtime_state string
restorations.volume_size integer Size in MiB
restorations.volume_device string Name of volume as instance device e.g. /dev/vdb.
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Synchronize resource state

Schedule an asynchronous pull operation to synchronize resource state from the backend. Returns 202 if the pull was scheduled successfully, or 409 if the pull operation is not implemented for this resource type.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/pull/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_pull # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_pull.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_snapshots_pull
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsPull } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsPull({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

202 - No response body

409 - No response body

Delete resource from the database without scheduling operations on backend and without checking current state of the resource. It is intended to be used for removing resource stuck in transitioning state.

1
2
3
4
http \
  POST \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/unlink/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_unlink # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_unlink.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_snapshots_unlink
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsUnlink } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsUnlink({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Update snapshot

Update an existing snapshot.

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-snapshot"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_snapshot_request import OpenStackSnapshotRequest # (1)
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackSnapshotRequest(
    name="my-awesome-openstack-snapshot"
)
response = openstack_snapshots_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackSnapshotRequest
  2. API Source: openstack_snapshots_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackSnapshotsUpdate } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-snapshot"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓
description string
metadata any
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Snapshot ID in the OpenStack backend
access_url string
source_volume string (uri) Volume from which this snapshot was created
size integer Size in MiB
metadata any
runtime_state string
source_volume_name string
source_volume_marketplace_uuid string (uuid)
action string
action_details any
restorations array of objects
restorations.uuid string (uuid)
restorations.created string (date-time)
restorations.description string New volume description.
restorations.volume string (uri) Volume that is being restored from the snapshot
restorations.volume_name string
restorations.volume_state string
restorations.volume_runtime_state string
restorations.volume_size integer Size in MiB
restorations.volume_device string Name of volume as instance device e.g. /dev/vdb.
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Partially update snapshot

Update specific fields of a snapshot.

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_open_stack_snapshot_request import PatchedOpenStackSnapshotRequest # (1)
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedOpenStackSnapshotRequest()
response = openstack_snapshots_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: PatchedOpenStackSnapshotRequest
  2. API Source: openstack_snapshots_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsPartialUpdate } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string
description string
metadata any
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Snapshot ID in the OpenStack backend
access_url string
source_volume string (uri) Volume from which this snapshot was created
size integer Size in MiB
metadata any
runtime_state string
source_volume_name string
source_volume_marketplace_uuid string (uuid)
action string
action_details any
restorations array of objects
restorations.uuid string (uuid)
restorations.created string (date-time)
restorations.description string New volume description.
restorations.volume string (uri) Volume that is being restored from the snapshot
restorations.volume_name string
restorations.volume_state string
restorations.volume_runtime_state string
restorations.volume_size integer Size in MiB
restorations.volume_device string Name of volume as instance device e.g. /dev/vdb.
kept_until string (date-time) Guaranteed time of snapshot retention. If null - keep forever.
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean

Delete snapshot

Delete a snapshot.

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_destroy.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: openstack_snapshots_destroy
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsDestroy } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

204 - No response body

Other Actions

List snapshot restorations

Get a list of snapshot restorations

1
2
3
4
http \
  GET \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restorations/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_restorations_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = openstack_snapshots_restorations_list.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

for item in response:
    print(item)
  1. API Source: openstack_snapshots_restorations_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { openstackSnapshotsRestorationsList } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsRestorationsList({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Name Type Description
page integer A page number within the paginated result set.
page_size integer Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field Type Description
uuid string (uuid)
created string (date-time)
description string New volume description.
volume string (uri) Volume that is being restored from the snapshot
volume_name string
volume_state string
volume_runtime_state string
volume_size integer Size in MiB
volume_device string Name of volume as instance device e.g. /dev/vdb.

Restore volume from snapshot

Restore volume from snapshot

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openstack-snapshots/a1b2c3d4-e5f6-7890-abcd-ef1234567890/restore/ \
  Authorization:"Token YOUR_API_TOKEN" \
  name="my-awesome-openstack-snapshot"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.open_stack_snapshot_restoration_request import OpenStackSnapshotRestorationRequest # (1)
from waldur_api_client.api.openstack_snapshots import openstack_snapshots_restore # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = OpenStackSnapshotRestorationRequest(
    name="my-awesome-openstack-snapshot"
)
response = openstack_snapshots_restore.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: OpenStackSnapshotRestorationRequest
  2. API Source: openstack_snapshots_restore
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { openstackSnapshotsRestore } from 'waldur-js-client';

try {
  const response = await openstackSnapshotsRestore({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "name": "my-awesome-openstack-snapshot"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
name string ✓ New volume name.
Constraints: write-only
description string New volume description.

200 -

Field Type Description
url string (uri)
uuid string (uuid)
name string
description string
service_name string
service_settings string (uri)
service_settings_uuid string (uuid)
service_settings_state string
service_settings_error_message string
project string (uri)
project_name string
project_uuid string (uuid)
customer string (uri)
customer_uuid string (uuid)
customer_name string
customer_native_name string
customer_abbreviation string
error_message string
error_traceback string
resource_type string
state any
created string (date-time)
modified string (date-time)
backend_id string Volume ID in the OpenStack backend
access_url string
source_snapshot string (uri) Snapshot that this volume was created from, if any
size integer Size in MiB
bootable boolean Indicates if this volume can be used to boot an instance
metadata any
image string (uri) Image that this volume was created from, if any
image_metadata string Metadata of the image this volume was created from
image_name string Name of the image this volume was created from
type string (uri) Type of the volume (e.g. SSD, HDD)
type_name string
runtime_state string
availability_zone string (uri) Availability zone where this volume is located
availability_zone_name string
device string Name of volume as instance device e.g. /dev/vdb.
action string
action_details any
instance string (uri) Instance that this volume is attached to, if any
instance_name string
instance_marketplace_uuid string (uuid)
tenant string (uri)
tenant_uuid string (uuid)
extend_enabled boolean
marketplace_offering_uuid string
marketplace_offering_name string
marketplace_offering_plugin_options object (free-form)
marketplace_category_uuid string
marketplace_category_name string
marketplace_resource_uuid string
marketplace_plan_uuid string
marketplace_resource_state string
is_usage_based boolean
is_limit_based boolean