Details of an S3 bucket restore preview

Details of an S3 bucket restore preview task, started by PreviewS3Bucket API.

Path Parameters

bucket_id string required
Preview bucket ID
preview_id string required
Preview ID

Responses

200
default

Success

application/api.clumio.restored-aws-s3-buckets=v1+json

Schema
Example (from schema)

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.
bucket string
Bucket the object belongs to
etag string
Etag of the contents of the object.
last_backup_timestamp string
Last time the object was backed up as an RFC3339 string.
last_modified_timestamp 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

{
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "objects": [
    {
      "bucket": "string",
      "etag": "string",
      "last_backup_timestamp": "string",
      "last_modified_timestamp": "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"
    }
  ]
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

GET /restores/aws/s3-buckets/:bucket_id/previews/:preview_id

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

bucket_id — path required

preview_id — path required

curl -L -X GET 'https://us-west-2.api.clumio.com/restores/aws/s3-buckets/:bucket_id/previews/:preview_id' \
-H 'Accept: application/api.clumio.restored-aws-s3-buckets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/restores/aws/s3-buckets/:bucket_id/previews/:preview_id' \
-H 'Accept: application/api.clumio.restored-aws-s3-buckets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/restores/aws/s3-buckets/:bucket_id/previews/:preview_id' \
-H 'Accept: application/api.clumio.restored-aws-s3-buckets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/restores/aws/s3-buckets/:bucket_id/previews/:preview_id' \
-H 'Accept: application/api.clumio.restored-aws-s3-buckets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/restores/aws/s3-buckets/:bucket_id/previews/:preview_id' \
-H 'Accept: application/api.clumio.restored-aws-s3-buckets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/restores/aws/s3-buckets/:bucket_id/previews/:preview_id' \
-H 'Accept: application/api.clumio.restored-aws-s3-buckets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/restores/aws/s3-buckets/:bucket_id/previews/:preview_id' \
-H 'Accept: application/api.clumio.restored-aws-s3-buckets=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

Details of an S3 bucket restore preview​

Authorization

Request

Details of an S3 bucket restore preview