Skip to main content

Restore an S3 asset within a protection group.​

Restores the specified protection group S3 asset 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.

    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 parameters for initiating a protection group S3 asset restore or creation of an instant access endpoint from a backup.

  • backup_id string

    The Clumio-assigned ID of the protection group S3 asset backup to be restored. Use the GET /backups/protection-groups/s3-assets endpoint to fetch valid values.
    Note that only one of backup_id or pitr must be given.

  • object_filters object

    Search for or restore only objects that pass the source object filter.

  • etag string

    Filter for objects with this etag.

  • latest_version_only boolean required

    If set to true, filter for latest versions only. Otherwise, all versions will be returned.

  • max_object_size_bytes int64

    Filter for objects with at most this size in bytes.

  • min_object_size_bytes int64

    Filter for objects with at least this size in bytes.

  • object_key_contains string

    Filter for objects whose key contains this string.

  • object_key_matches string

    Filter for objects whose key matches this string.

  • object_key_prefix string

    Filter for objects that start with this key prefix.

  • object_key_suffix string

    Filter for objects that end with this key suffix.

  • storage_classes string[]

    Storage class to include in the restore. If not specified, then all objects across all storage classes will be restored. Valid values are: S3 Standard, S3 Standard-IA, S3 Intelligent-Tiering and S3 One Zone-IA.

  • version_id string

    Filter for objects with this version ID.

  • pitr object

    The parameters for initiating a point in time restore.
    Note that only one of backup_id or pitr must be given.

  • protection_group_s3_asset_id string required

    Clumio-assigned ID of protection group S3 asset, representing the bucket within the protection group to restore from. Use the GET /datasources/protection-groups/s3-assets endpoint to fetch valid values.

  • restore_end_timestamp string

    The ending time to be restored in RFC-3339 format. We will restore last objects modified before the given time.
    If restore_end_timestamp is given without restore_start_timestamp, it is the same as point in time restore.

  • restore_start_timestamp string

    The starting time to be restored in RFC-3339 format. We will restore objects modified since the given time.

  • 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.

  • default_object_checksum_algorithm string

    Possible values: [CRC32, CRC32C, CRC64NVME, SHA1, SHA256]

    Default value: CRC64NVME

    Default AWS checksum algorithm for restored object. Valid values are: CRC32, CRC32C, CRC64NVME, SHA1, and `SHA256.
    Note that this will be applied when backup didn't have checksum algorithm information.

  • 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/s3-assets

Authorization

Request

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

  "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_s3_asset_id": "string",

      "restore_end_timestamp": "string",

      "restore_start_timestamp": "string"

    }

  },

  "target": {

    "bucket_id": "string",

    "default_object_checksum_algorithm": "CRC64NVME",

    "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/s3-assets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-group-s3-assets=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_s3_asset_id": "string",
      "restore_end_timestamp": "string",
      "restore_start_timestamp": "string"
    }
  },
  "target": {
    "bucket_id": "string",
    "default_object_checksum_algorithm": "CRC64NVME",
    "environment_id": "string",
    "overwrite": false,
    "prefix": "string",
    "restore_original_storage_class": false,
    "storage_class": "S3 Standard",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}'