Skip to main content

Restore an EBS volume​

Restores the specified source EBS volume backup to the specified target destination. The source EBS volume must be one that was backup up by Clumio.

Query Parameters
  • embed string

    Embeds the details of each associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

    Embeddable LinkDescription
    read-taskEmbeds the associated task in the response. For example, ?embed=read-task
    For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.
Request Body required
  • source object required

    The EBS volume backup to be restored.

  • backup_id string required

    The Clumio-assigned ID of the EBS volume backup to be restored. Use the GET /backups/aws/ebs-volumes endpoint to fetch valid values.

  • target object required

    The configuration of the EBS volume to be restored.

  • aws_az string required

    The availability zone into which the EBS volume is restored. For example, us-west-2a. Use the GET /datasources/aws/environments endpoint to fetch valid values.

  • environment_id string required

    The Clumio-assigned ID of the AWS environment to be used as the restore destination. Use the GET /datasources/aws/environments endpoint to fetch valid values.

  • iops int64

    Iops of the volume to be restored. Iops field is only applicable if volume_type is gp3, io1, io2.

  • kms_key_native_id string

    The KMS encryption key ID used to encrypt the EBS volume data. The KMS encryption key ID is stored in the AWS cloud as part of your AWS account.

  • tags object[]

    The AWS tags to be applied to the restored volume. The tags are stored in the AWS cloud as part of your AWS account. An EBS volume can be have multiple tags. The target volume will not inherit any tags that were applied to the original volume. To find the tags that were applied to the original volume, use the GET /backups/aws/ebs-volumes endpoint to display the original volume's tag keys (tags.key) and tag values (tags.value).

  • key string required

    The AWS-assigned tag key.

  • value string

    The AWS-assigned tag value.

  • type string

    Type of the volume to restore as. Allowed Values: gp2, gp3, io1, io2, sc1, st1, standard.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • read-task Embeds the associated task of a resource in the response if requested using the `embed` query parameter.

    Embeds the associated task of a resource in the response if requested using the embed query parameter.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • read-task object

    A HATEOAS link to the task associated with this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • task_id string

    The Clumio-assigned ID of the task created by this restore request. The progress of the task can be monitored using the GET /tasks/{task_id} endpoint.

Loading...