Skip to main content

Restore S3 objects in a protection group​

Restores the specified list of S3 objects to the specified target destination.

Path Parameters
  • protection_group_id string required

    Performs the operation on the ProtectionGroup with the specified ID.

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

    Objects to restore. These objects must belong to a single bucket.

  • bucket string required

    Bucket the object belongs to

  • etag string required

    Etag of the contents of the object.

  • last_backup_time string

    Last time the object was backed up as an RFC3339 string.

  • last_modified_time string

    Last modified time of the object as an RFC3339 string.

  • object_key string required

    Object key

  • protection_group_asset_id string

    The Clumio-assigned ID of a protection group S3 asset, which represents the bucket within the protection group to restore from.

  • region string

    region of the backup object

  • restore_cookie string required

    Encrypted metadata for the object to be restored
    You can get restore_cookie via POST /restores/protection-groups/{protection_group_id}/previews

  • size_in_bytes int64 required

    Size in Bytes

  • storage_class string required

    Possible values: [S3 Standard, S3 Standard-IA, S3 Intelligent-Tiering, S3 One Zone-IA]

    Storage class. Valid values are: S3 Standard, S3 Standard-IA, S3 Intelligent-Tiering, and S3 One Zone-IA.

  • version_id string required

    Version ID

  • target object required

    The destination where the protection group will be restored.

  • bucket_id string required

    The Clumio-assigned ID of the bucket to which the backup must be restored. Use the GET /datasources/aws/s3-buckets 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/s3-buckets/{bucket_id} endpoint to fetch the environment ID for a bucket.

  • overwrite boolean

    Default value: false

    If overwrite is set to true, we will overwrite an object if it exists. If it's set to false, then we will fail the restore if an object already exists.

  • prefix string

    Prefix to restore the objects under. If more than one bucket is restored, the bucket name will be appended to the prefix.

  • restore_original_storage_class boolean

    Default value: false

    Whether to restore objects with their original storage class or not.
    If it is true, storage_class must be empty. Otherwise, storage_class must be given.

  • storage_class string

    Possible values: [S3 Standard, S3 Standard-IA, S3 Intelligent-Tiering, S3 One Zone-IA]

    Storage class for restored objects. Valid values are: S3 Standard, S3 Standard-IA, S3 Intelligent-Tiering and S3 One Zone-IA.
    Note that this must be given unless restore_original_storage_class is true.

  • tags object[]

    The AWS tags to be applied to the restored objects. The restored objects will not have any tags applied if this is specified as null.

  • key string required

    The AWS-assigned tag key.

  • value string

    The AWS-assigned tag value.

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.

POST /restores/protection-groups/:protection_group_id/s3-objects

Authorization

Request

Click Edit to configure Base URL
https://us-west-2.api.clumio.com
Bearer Token
protection_group_id — path required
embed — query
Body required
{

  "source": [

    {

      "bucket": "string",

      "etag": "string",

      "last_backup_time": "string",

      "last_modified_time": "string",

      "object_key": "string",

      "protection_group_asset_id": "string",

      "region": "string",

      "restore_cookie": "string",

      "size_in_bytes": 0,

      "storage_class": "S3 Standard",

      "version_id": "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/:protection_group_id/s3-objects' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": [
    {
      "bucket": "string",
      "etag": "string",
      "last_backup_time": "string",
      "last_modified_time": "string",
      "object_key": "string",
      "protection_group_asset_id": "string",
      "region": "string",
      "restore_cookie": "string",
      "size_in_bytes": 0,
      "storage_class": "S3 Standard",
      "version_id": "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"
      }
    ]
  }
}'