REST - Recovery points

Listing recovery points

Request

GET /v2/recovery-points

Returns an array with a list of existing recovery points.

Response

{  
  "success":true,
  "recovery_points": [
     {
        "id": "$image_id",
        "label": "$image_label",
        "size": $image_size,
        "cost_per_hour": $image_cost,
        "owner": {
           "id": "$owner_id",
           "name": "$owner_name"
        },
        "storage_volume": {
            "id": "$volume_id",
            "size": "$volume_size",
            "label": "$volume_label",
            "type": "$volume_type",
            "system_disk": $volume_system,

            // jeśli shared_disk jest równy false to
            // pole 'virtual_machine' będzie istniało jeżeli
            // dysk jest podłączony do wirtualnej maszyny
            "shared_disk": $shared_disk,
            "virtual_machine": {
               "id": "$vm_id",
               "label": "$vm_label",
               "attach_time": "$attach_time"
            }

            // jeśli shared_disk jest równy true to
            // pole 'virtual_machines' będzie istniało jeżeli dysk
            // jest podłączony do co najmniej jednej wirtualnej maszyny
            "shared_disk": $shared_disk, //jesli = true
            "virtual_machines": [{
                  "id": "$vm_id",
                  "label": "$vm_label",
                  "attach_time": "$attach_time",
                },
                { ... },
                {
                  "id": "$vm_id",
                  "label": "$vm_label",
                  "attach_time": "$attach_time"
               }
            ]
        }
     }
  ]
}

Returned Information

• $image_id (string) - UUID of the recovery point
• $image_label (string) - name of the recovery point
• $image_size (int) - size of the image (in GB)
• $cost_per_hour (float) - cost of the image per hour
• $owner_id (string) - UUID of the image owner
• $owner_name (string) - name of the image owner
• $volume_id (string) - UUID of the virtual disk
• $volume_label (string) - name of the virtual disk
• $volume_size (int) - size of the disk (in GB)
• $shared_disk (bool) - specifies whether the disk is a shared disk or not
• $volume_system (int) - specifies whether the disk is a system disk
• $volume_type (string) - specifies the type of disk HDD/SSD
• $vm_id (string) - UUID of the virtual machine to which the disk is connected
• $vm_label (string) - name of the virtual machine to which the disk is connected
• $attach_time (datetime) - date and time of disk connection to the virtual server

Creating a recovery point

Request

PUT /v2/recovery-points

Request content

{
   "storage_volume_id": $volume_id,
   "label": $image_label
}

Parameter description

• $volume_id (string) - UUID of the disk
• $image_label (string) - name of the image

Response

{  
  "success":true,
  "recovery_point": {
      "id": $image_id
  }
}

Returned Information

• $image_id (string) - UUID of the new recovery point

Deleting a Recovery Point

Request

DELETE /v2/recovery-points/$IMAGE_ID

Deletes the recovery point with $IMAGE_ID.

Response

{  
  "success":true
}

Updated on 05 Sep 2023