Restore a protection group
Restores the specified protection group 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-protection-groups=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/protection-groups
Authorization
Request
Request
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string",
"object_filters": {
"etag": "string",
"latest_version_only": true,
"max_object_size_bytes": 0,
"min_object_size_bytes": 0,
"object_key_contains": "string",
"object_key_matches": "string",
"object_key_prefix": "string",
"object_key_suffix": "string",
"storage_classes": [
"string"
],
"version_id": "string"
},
"pitr": {
"protection_group_id": "string",
"restore_end_timestamp": "string",
"restore_start_timestamp": "string"
},
"protection_group_s3_asset_ids": [
"string"
]
},
"target": {
"bucket_id": "string",
"environment_id": "string",
"overwrite": false,
"prefix": "string",
"restore_original_storage_class": false,
"storage_class": "S3 Standard",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string",
"object_filters": {
"etag": "string",
"latest_version_only": true,
"max_object_size_bytes": 0,
"min_object_size_bytes": 0,
"object_key_contains": "string",
"object_key_matches": "string",
"object_key_prefix": "string",
"object_key_suffix": "string",
"storage_classes": [
"string"
],
"version_id": "string"
},
"pitr": {
"protection_group_id": "string",
"restore_end_timestamp": "string",
"restore_start_timestamp": "string"
},
"protection_group_s3_asset_ids": [
"string"
]
},
"target": {
"bucket_id": "string",
"environment_id": "string",
"overwrite": false,
"prefix": "string",
"restore_original_storage_class": false,
"storage_class": "S3 Standard",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string",
"object_filters": {
"etag": "string",
"latest_version_only": true,
"max_object_size_bytes": 0,
"min_object_size_bytes": 0,
"object_key_contains": "string",
"object_key_matches": "string",
"object_key_prefix": "string",
"object_key_suffix": "string",
"storage_classes": [
"string"
],
"version_id": "string"
},
"pitr": {
"protection_group_id": "string",
"restore_end_timestamp": "string",
"restore_start_timestamp": "string"
},
"protection_group_s3_asset_ids": [
"string"
]
},
"target": {
"bucket_id": "string",
"environment_id": "string",
"overwrite": false,
"prefix": "string",
"restore_original_storage_class": false,
"storage_class": "S3 Standard",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string",
"object_filters": {
"etag": "string",
"latest_version_only": true,
"max_object_size_bytes": 0,
"min_object_size_bytes": 0,
"object_key_contains": "string",
"object_key_matches": "string",
"object_key_prefix": "string",
"object_key_suffix": "string",
"storage_classes": [
"string"
],
"version_id": "string"
},
"pitr": {
"protection_group_id": "string",
"restore_end_timestamp": "string",
"restore_start_timestamp": "string"
},
"protection_group_s3_asset_ids": [
"string"
]
},
"target": {
"bucket_id": "string",
"environment_id": "string",
"overwrite": false,
"prefix": "string",
"restore_original_storage_class": false,
"storage_class": "S3 Standard",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string",
"object_filters": {
"etag": "string",
"latest_version_only": true,
"max_object_size_bytes": 0,
"min_object_size_bytes": 0,
"object_key_contains": "string",
"object_key_matches": "string",
"object_key_prefix": "string",
"object_key_suffix": "string",
"storage_classes": [
"string"
],
"version_id": "string"
},
"pitr": {
"protection_group_id": "string",
"restore_end_timestamp": "string",
"restore_start_timestamp": "string"
},
"protection_group_s3_asset_ids": [
"string"
]
},
"target": {
"bucket_id": "string",
"environment_id": "string",
"overwrite": false,
"prefix": "string",
"restore_original_storage_class": false,
"storage_class": "S3 Standard",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string",
"object_filters": {
"etag": "string",
"latest_version_only": true,
"max_object_size_bytes": 0,
"min_object_size_bytes": 0,
"object_key_contains": "string",
"object_key_matches": "string",
"object_key_prefix": "string",
"object_key_suffix": "string",
"storage_classes": [
"string"
],
"version_id": "string"
},
"pitr": {
"protection_group_id": "string",
"restore_end_timestamp": "string",
"restore_start_timestamp": "string"
},
"protection_group_s3_asset_ids": [
"string"
]
},
"target": {
"bucket_id": "string",
"environment_id": "string",
"overwrite": false,
"prefix": "string",
"restore_original_storage_class": false,
"storage_class": "S3 Standard",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/protection-groups' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
"source": {
"backup_id": "string",
"object_filters": {
"etag": "string",
"latest_version_only": true,
"max_object_size_bytes": 0,
"min_object_size_bytes": 0,
"object_key_contains": "string",
"object_key_matches": "string",
"object_key_prefix": "string",
"object_key_suffix": "string",
"storage_classes": [
"string"
],
"version_id": "string"
},
"pitr": {
"protection_group_id": "string",
"restore_end_timestamp": "string",
"restore_start_timestamp": "string"
},
"protection_group_s3_asset_ids": [
"string"
]
},
"target": {
"bucket_id": "string",
"environment_id": "string",
"overwrite": false,
"prefix": "string",
"restore_original_storage_class": false,
"storage_class": "S3 Standard",
"tags": [
{
"key": "string",
"value": "string"
}
]
}
}'