Restore an EC2 instance
Restores the specified EC2 instance backup to the specified target destination.
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.
For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.Embeddable Link Description read-task Embeds the associated task in the response. For example, ?embed=read-task
- application/json
Request Body required
source object required
target object required
Responses
- 202
- default
Success
- application/api.clumio.restored-aws-ec2-instances=v1+json
- Schema
- Example (from schema)
Schema
_embedded object
_links object
- 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.
{
"_embedded": {},
"_links": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
},
"read-task": {
"href": "string",
"templated": true,
"type": "string"
}
},
"task_id": "string"
}
Error
- application/json
- Schema
- Example (from schema)
Schema
errors object[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
POST /restores/aws/ec2-instances
Authorization
Request
Request
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/ec2-instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string"
},
"target": {
"ami_restore_target": {
"description": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"instance_restore_target": {
"ami_native_id": "string",
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"iam_instance_profile_name": "string",
"key_pair_name": "string",
"network_interfaces": [
{
"device_index": 0,
"network_interface_native_id": "string",
"restore_default": true,
"restore_from_backup": true,
"security_group_native_ids": [
"string"
],
"subnet_native_id": "string"
}
],
"should_power_on": false,
"subnet_native_id": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"vpc_native_id": "string"
},
"volumes_restore_target": {
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"target_instance_native_id": "string"
}
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/ec2-instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string"
},
"target": {
"ami_restore_target": {
"description": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"instance_restore_target": {
"ami_native_id": "string",
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"iam_instance_profile_name": "string",
"key_pair_name": "string",
"network_interfaces": [
{
"device_index": 0,
"network_interface_native_id": "string",
"restore_default": true,
"restore_from_backup": true,
"security_group_native_ids": [
"string"
],
"subnet_native_id": "string"
}
],
"should_power_on": false,
"subnet_native_id": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"vpc_native_id": "string"
},
"volumes_restore_target": {
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"target_instance_native_id": "string"
}
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/ec2-instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string"
},
"target": {
"ami_restore_target": {
"description": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"instance_restore_target": {
"ami_native_id": "string",
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"iam_instance_profile_name": "string",
"key_pair_name": "string",
"network_interfaces": [
{
"device_index": 0,
"network_interface_native_id": "string",
"restore_default": true,
"restore_from_backup": true,
"security_group_native_ids": [
"string"
],
"subnet_native_id": "string"
}
],
"should_power_on": false,
"subnet_native_id": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"vpc_native_id": "string"
},
"volumes_restore_target": {
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"target_instance_native_id": "string"
}
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/ec2-instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string"
},
"target": {
"ami_restore_target": {
"description": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"instance_restore_target": {
"ami_native_id": "string",
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"iam_instance_profile_name": "string",
"key_pair_name": "string",
"network_interfaces": [
{
"device_index": 0,
"network_interface_native_id": "string",
"restore_default": true,
"restore_from_backup": true,
"security_group_native_ids": [
"string"
],
"subnet_native_id": "string"
}
],
"should_power_on": false,
"subnet_native_id": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"vpc_native_id": "string"
},
"volumes_restore_target": {
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"target_instance_native_id": "string"
}
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/ec2-instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string"
},
"target": {
"ami_restore_target": {
"description": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"instance_restore_target": {
"ami_native_id": "string",
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"iam_instance_profile_name": "string",
"key_pair_name": "string",
"network_interfaces": [
{
"device_index": 0,
"network_interface_native_id": "string",
"restore_default": true,
"restore_from_backup": true,
"security_group_native_ids": [
"string"
],
"subnet_native_id": "string"
}
],
"should_power_on": false,
"subnet_native_id": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"vpc_native_id": "string"
},
"volumes_restore_target": {
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"target_instance_native_id": "string"
}
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/ec2-instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string"
},
"target": {
"ami_restore_target": {
"description": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"instance_restore_target": {
"ami_native_id": "string",
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"iam_instance_profile_name": "string",
"key_pair_name": "string",
"network_interfaces": [
{
"device_index": 0,
"network_interface_native_id": "string",
"restore_default": true,
"restore_from_backup": true,
"security_group_native_ids": [
"string"
],
"subnet_native_id": "string"
}
],
"should_power_on": false,
"subnet_native_id": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"vpc_native_id": "string"
},
"volumes_restore_target": {
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"target_instance_native_id": "string"
}
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/ec2-instances' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-ec2-instances=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string"
},
"target": {
"ami_restore_target": {
"description": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"instance_restore_target": {
"ami_native_id": "string",
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"iam_instance_profile_name": "string",
"key_pair_name": "string",
"network_interfaces": [
{
"device_index": 0,
"network_interface_native_id": "string",
"restore_default": true,
"restore_from_backup": true,
"security_group_native_ids": [
"string"
],
"subnet_native_id": "string"
}
],
"should_power_on": false,
"subnet_native_id": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"vpc_native_id": "string"
},
"volumes_restore_target": {
"aws_az": "string",
"ebs_block_device_mappings": [
{
"kms_key_native_id": "string",
"name": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"volume_native_id": "string"
}
],
"environment_id": "string",
"target_instance_native_id": "string"
}
}
}'