Skip to main content

Estimate cost of a S3 instant access endpoint​

Estimates cost for creating and maintaining a S3 instant access endpoint with given parameters.

Request Body required
  • backup_id string

    The Clumio-assigned ID of the protection group S3 asset backup or protection group backup to be restored. Use the endpoints GET /backups/protection-groups/s3-assets for protection group S3 asset backup, and GET /backups/protection-groups for protection group backups to fetch valid values.
    Note that only one of either backup_id or pitr must be provided.

  • is_sync boolean

    Whether to wait for the operation to complete.

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

    The parameters to initiate a point-in-time creation of S3 instant access endpoint.
    Note that only one of either backup_id or pitr must be provided.

  • restore_end_timestamp string

    The end time of the period in which the objects must be restored in RFC-3339 format. Objects modified before this given time will be restored. If restore_end_timestamp is provided without restore_start_timestamp, then it is the same as a point-in-time restore.

  • restore_start_timestamp string

    The start time of the period in which the objects must be restored in RFC-3339 format. Objects modified since the given time will be restored.

  • protection_group_s3_asset_id string required

    Clumio-assigned ID of protection group S3 asset, representing the bucket 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.

  • estimated_cost double

    The estimated cost for instant access endpoint.

  • total_object_count int64

    The count of objects to be restored.

  • total_object_size int64

    The total size in bytes of objects to be restored.

POST /restores/protection-groups/instant-access-endpoints/cost-estimates

Authorization

Request

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

  "backup_id": "string",

  "is_sync": 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": {

    "restore_end_timestamp": "string",

    "restore_start_timestamp": "string"

  },

  "protection_group_s3_asset_id": "string"

}
Accept
curl -L -X POST 'https://us-west-2.api.clumio.com/restores/protection-groups/instant-access-endpoints/cost-estimates' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-protection-group-instant-access-endpoints=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "backup_id": "string",
  "is_sync": 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": {
    "restore_end_timestamp": "string",
    "restore_start_timestamp": "string"
  },
  "protection_group_s3_asset_id": "string"
}'