Skip to main content

Preview a protection group restore​

Preview a protection group restore.

Path Parameters
  • protection_group_id string required

    Performs the operation on the ProtectionGroup with the specified ID.

Request Body required
  • backup_id string

    The Clumio-assigned ID of the protection group backup to be restored. Use the GET /backups/protection-groups endpoint to fetch valid values.

  • is_sync_preview boolean

    Whether to wait for the preview task.

  • 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_end_timestamp string

    The end timestamp of the period within which objects are to be restored, in RFC-3339 format. Clumio searches for objects modified before the given time. If pitr_end_timestamp is empty, Clumio searches for objects modified up to the current time of the restore request.
    If pitr_end_timestamp is given without pitr_start_timestamp, it is the same as point in time preview.

  • pitr_start_timestamp string

    The start timestamp of the period within which objects are to be restored, in RFC-3339 format. Clumio searches for objects modified since the given time. If pitr_start_timestamp is empty, Clumio searches for objects from the beginning of the first backup.

  • protection_group_s3_asset_ids string[]

    A list of Clumio-assigned IDs of protection group S3 assets, representing the buckets within the protection group to restore from. Use the GET /datasources/protection-groups/s3-assets endpoint to fetch valid values.

Responses

Success (Sync)

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

  • objects object[]

    The fetched objects as a result of the preview.
    Note that this field is given only for sync request.

  • bucket string

    Bucket the object belongs to

  • etag string

    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

    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

    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

    Size in Bytes

  • storage_class string

    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

    Version ID

POST /restores/protection-groups/:protection_group_id/previews

Authorization

Request

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

  "backup_id": "string",

  "is_sync_preview": true,

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

  "pitr_start_timestamp": "string",

  "protection_group_s3_asset_ids": [

    "string"

  ]

}
Accept
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/protection-groups/:protection_group_id/previews' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-groups=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "backup_id": "string",
  "is_sync_preview": true,
  "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_end_timestamp": "string",
  "pitr_start_timestamp": "string",
  "protection_group_s3_asset_ids": [
    "string"
  ]
}'