Skip to main content

Restore an S3 bucket whose Clumio Backtrack is enabled​

Restores the specified S3 bucket to the specified target destination using Clumio Backtrack.

Request Body required
  • source object required

    The parameters for initiating an S3 bucket restore.

  • bucket_id string required

    The Clumio-assigned ID of the bucket to be restored. Use the GET /datasources/aws/s3-buckets endpoint to fetch valid values.

  • object_filters object

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

  • etag string

    Filter for objects with this etag.

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

  • point_in_time_recovery object

    This field is required when the request type is 'Rollback'. The parameters for initiating a point in time restore.

  • restore_end_timestamp string

    The end timestamp to be restored in RFC-3339 format. Clumio restores objects modified before the given timestamp.

  • undo_delete_marker_options object

    This field is required when the request type is 'Undo delete marker'.

  • start_timestamp string

    The start timestamp for undo delete marker in RFC-3339 format. Clumio undoes the delete markers created after the given timestamp.

  • target object required

    The destination where the S3 bucket will be restored.

  • bucket_name string required

    The name of the destination bucket.

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

  • prefix string

    Prefix to restore the objects under.

  • 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.
    If not given or empty, objects are restored with their original storage classes.

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

  • type string

    Possible values: [Rollback, Undo delete marker]

    Type to be used during restore. If not specified, the default value is "Rollback". "Rollback" and "Undo delete marker" values will be deprecated. Use "rollback" and "undo_delete_marker" respectively. The default value will be changed when old values are deprecated.

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/aws/s3-buckets

Authorization

Request

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

  "source": {

    "bucket_id": "string",

    "object_filters": {

      "etag": "string",

      "is_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"

    },

    "point_in_time_recovery": {

      "restore_end_timestamp": "string"

    },

    "undo_delete_marker_options": {

      "start_timestamp": "string"

    }

  },

  "target": {

    "bucket_name": "string",

    "environment_id": "string",

    "prefix": "string",

    "storage_class": "S3 Standard",

    "tags": [

      {

        "key": "string",

        "value": "string"

      }

    ]

  },

  "type": "Rollback"

}

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/aws/s3-buckets' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-aws-s3-buckets=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "bucket_id": "string",
    "object_filters": {
      "etag": "string",
      "is_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"
    },
    "point_in_time_recovery": {
      "restore_end_timestamp": "string"
    },
    "undo_delete_marker_options": {
      "start_timestamp": "string"
    }
  },
  "target": {
    "bucket_name": "string",
    "environment_id": "string",
    "prefix": "string",
    "storage_class": "S3 Standard",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  },
  "type": "Rollback"
}'