Skip to main content

Restore objects in a protection group​

Restores the specified list of objects to the specified target destination.

Path Parameters
  • gcs_protection_group_id string required

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

Request Body required
  • source object[] required

    Objects to restore. These are supposed to come from the preview result.

  • bucket string required

    Bucket the object belongs to

  • gcs_asset_id string

    The Clumio-assigned ID of a GCS asset, which represents the bucket within the protection group to restore from.

  • last_modified_time string

    Last modified time of the object as an RFC3339 string.

  • object_key string required

    Object key

  • restore_cookie string required

    Encrypted metadata for the object to be restored
    You can get restore_cookie via POST /restores/gcp/protection-groups/{gcs_protection_group_id}/previews

  • size_in_bytes int64 required

    Size in Bytes

  • storage_class string required

    Possible values: [STANDARD, NEARLINE, COLDLINE, ARCHIVE]

    Storage class

  • version_id string required

    Version ID

  • target object required

    The destination where the GCS 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/gcp/cloud-storage-buckets endpoint to fetch valid values.

  • default_object_checksum_algorithm string

    Possible values: [CRC32C, MD5]

    Default value: CRC32C

    Default GCS checksum algorithm for restored object. Valid values are: CRC32C, MD5.
    Note that this will be applied when backup didn't have checksum algorithm information.

  • labels object[]

    The GCP labels to be applied to the restored objects. The restored objects will not have any labels applied if this is specified as null.

  • key string required

    The GCP-assigned label key.

  • value string

    The GCP-assigned label value.

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

  • project_id string required

    The Clumio-assigned ID of the GCP project to be used as the restore destination. Use the GET /datasources/gcp/cloud-storage-buckets/{bucket_id} endpoint to fetch the project ID for a bucket.

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

    Storage class for restored objects. Valid values are: STANDARD, NEARLINE, COLDLINE, ARCHIVE.
    Note that this must be given unless restore_original_storage_class is true.

Responses

Success

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

Loading...