Get Snapshots for Instance

GET 
https://core-pl.ocplanet.cloud/backend/api/openstack/images/get_snapshots_for_instance

Host: https://core.ocplanet.cloud

Retrieve snapshots associated with a specific instance.

Request

Query Parameters

instance_uuid stringrequired

Responses

200

application/json

Schema

Schema

objects object[]required
Array [
architecture nullstringrequired
assigned_to_flavor booleanrequired
cleanup_date nullrequired
client objectrequired
display stringrequired
id integerrequired
name stringrequired
container_format nullstringrequired
created_at stringrequired
deleted_at nullrequired
disk_format nullstringrequired
display_name stringrequired
hw_qemu_guest_agent booleanrequired
hypervisor_type nullstringrequired
id stringrequired
instance_uuid stringrequired
is_iso booleanrequired
min_disk integerrequired
min_ram integerrequired
name stringrequired
os_distro stringrequired
os_version stringrequired
properties objectrequired
backup_type string
base_image_ref stringrequired
boot_roles stringrequired
hw_cdrom_bus stringrequired
hw_disk_bus stringrequired
hw_input_bus stringrequired
hw_machine_type stringrequired
hw_pointer_model stringrequired
hw_qemu_guest_agent string
hw_video_model stringrequired
hw_vif_model stringrequired
image_location string
image_state string
image_type stringrequired
instance_uuid stringrequired
owner_id string
owner_project_name stringrequired
owner_specified.openstack.md5 string
owner_specified.openstack.object string
owner_specified.openstack.sha256 string
owner_user_name stringrequired
user_id stringrequired
protected booleanrequired
region stringrequired
related_instance object required
anyOf
MOD2
id stringrequired
name stringrequired
reseller_resources nullrequired
size nullintegerrequired
status stringrequired
tags arrayrequired
type stringrequired
updated_at stringrequired
used_by_resellers arrayrequired
visibility stringrequired
volume_snapshot_uuid nullrequired
]
volume_snapshots_count integerrequired

Example (from schema)

{
  "objects": [
    {
      "assigned_to_flavor": true,
      "client": {
        "display": "string",
        "id": 0,
        "name": "string"
      },
      "created_at": "string",
      "display_name": "string",
      "hw_qemu_guest_agent": true,
      "id": "string",
      "instance_uuid": "string",
      "is_iso": true,
      "min_disk": 0,
      "min_ram": 0,
      "name": "string",
      "os_distro": "string",
      "os_version": "string",
      "properties": {
        "backup_type": "string",
        "base_image_ref": "string",
        "boot_roles": "string",
        "hw_cdrom_bus": "string",
        "hw_disk_bus": "string",
        "hw_input_bus": "string",
        "hw_machine_type": "string",
        "hw_pointer_model": "string",
        "hw_qemu_guest_agent": "string",
        "hw_video_model": "string",
        "hw_vif_model": "string",
        "image_location": "string",
        "image_state": "string",
        "image_type": "string",
        "instance_uuid": "string",
        "owner_id": "string",
        "owner_project_name": "string",
        "owner_specified.openstack.md5": "string",
        "owner_specified.openstack.object": "string",
        "owner_specified.openstack.sha256": "string",
        "owner_user_name": "string",
        "user_id": "string"
      },
      "protected": true,
      "region": "string",
      "status": "string",
      "tags": [
        null
      ],
      "type": "string",
      "updated_at": "string",
      "used_by_resellers": [
        null
      ],
      "visibility": "string"
    }
  ],
  "volume_snapshots_count": 0
}

Example

{
  "objects": [
    {
      "id": "4747270d-61c9-4bb6-9b01-f6dd915f0560",
      "tags": [],
      "client": {
        "id": 933016,
        "name": "EN EN",
        "display": "EN EN #933016"
      },
      "properties": {
        "owner_specified.openstack.md5": "",
        "owner_specified.openstack.sha256": "",
        "owner_specified.openstack.object": "images/Centos-7",
        "hw_qemu_guest_agent": "yes",
        "base_image_ref": "2b979045-4e10-45c9-805c-c95be46a37b9",
        "owner_user_name": "admin",
        "owner_project_name": "933016",
        "boot_roles": "reader,member,load-balancer_member,_member_",
        "hw_machine_type": "pc",
        "hw_cdrom_bus": "ide",
        "hw_disk_bus": "virtio",
        "hw_input_bus": "usb",
        "hw_pointer_model": "usbtablet",
        "hw_video_model": "virtio",
        "hw_vif_model": "virtio",
        "instance_uuid": "81ddeb48-937b-4e54-8b37-091bfcabf18e",
        "user_id": "6b60b80afb7249c7b5f9d6e9b25ef1f6",
        "image_type": "backup",
        "backup_type": "manual",
        "image_location": "snapshot",
        "owner_id": "50caa053ebc847c39b9c3149c746f0fa",
        "image_state": "available"
      },
      "is_iso": false,
      "display_name": "u",
      "cleanup_date": "2024-04-03T07:52:50Z",
      "assigned_to_flavor": true,
      "related_instance": null,
      "name": "u",
      "type": "backup",
      "status": "active",
      "size": 10737418240,
      "created_at": "2024-03-20T07:52:50Z",
      "updated_at": "2024-03-20T09:08:42Z",
      "deleted_at": null,
      "os_distro": "centos",
      "hypervisor_type": null,
      "os_version": "7",
      "architecture": null,
      "min_disk": 10,
      "min_ram": 0,
      "protected": false,
      "visibility": "private",
      "container_format": "bare",
      "disk_format": "raw",
      "hw_qemu_guest_agent": true,
      "instance_uuid": "81ddeb48-937b-4e54-8b37-091bfcabf18e",
      "volume_snapshot_uuid": null,
      "region": "ua-central-1",
      "reseller_resources": null,
      "used_by_resellers": []
    }
  ],
  "volume_snapshots_count": 0
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Use 'OpenAPIToken {token}' as the value

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://core-pl.ocplanet.cloud/backend/api/openstack/images/get_snapshots_for_instance' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://core-pl.ocplanet.cloud

Auth

apikey header authorization

Parameters

instance_uuid — queryrequired

ResponseClear

Click the Send API Request button above and see the response here!