Skip to main content

Preview a protection group restore​

Preview a protection group restore.

Path Parameters
  • gcs_protection_group_id string required

    Performs the operation on the GCS Protection Group with the specified ID.

Request Body required
  • backup_id string

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

  • gcs_asset_ids string[]

    A list of Clumio-assigned IDs of GCS assets, representing the buckets within the protection group to restore from. Use the GET /datasources/gcp/gcs-assets 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.

  • 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 exactly equals this string.

  • object_key_prefix string

    Filter for objects that start with this key prefix.

  • object_key_regex_matches string

    Filter for objects whose key matches this RE2 regular expression as a full match. The backend wraps the pattern as ^(<pattern>)$, so you do not need to add anchors yourself.

  • 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: STANDARD, NEARLINE, COLDLINE, ARCHIVE.

  • version_id string

    Filter for objects with this version ID.

  • pitr object

    Time bounds shared by restore and preview endpoints. Restore endpoints embed this with a resource ID; preview endpoints use it as-is (the resource ID lives in the URL path).

  • restore_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 restore_end_timestamp is empty, Clumio searches for objects modified up to the current time of the restore request.

  • restore_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 restore_start_timestamp is empty, Clumio searches for objects from the beginning of the first backup.

Responses

Success (Async)

Schema
  • preview_id string

    The identifier for the requested preview which is used to fetch results of the preview.

  • 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.
    Note that this field is given only for async request.

Loading...