List restored files

Gets the list of active restored files for an asset.

Query Parameters

limit int64
Limits the size of the response on each page to the specified number of items.
start string
Sets the page token used to browse the collection. Leave this parameter empty to get the first page. Other pages can be traversed using HATEOAS links.

filter string required

Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

Field	Filter Condition	Description
asset_type	$eq	Required. The type of the asset within which to search for files. Possible values include `aws_ebs_volume`, `aws_ec2_instance`, `aws_ec2_instance` and `aws_dynamodb_table`.
asset_id	$eq	Required. The Clumio-assigned ID of the asset within which to search for files.

For more information about filtering, refer to the Filtering section of this guide.

Responses

200
default

Success

application/api.clumio.restored-files=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
access_methods object[]
The access options for this restored file. Users can access the restored file in one of two ways, depending on the option selected by the user who generated the restored file. The direct download (direct_download) option allows users to directly download the restored file from the Clumio UI. The email (email) option allows users to access the restored file using a downloadable link they receive by email.
direct_download object
The details used to access the restored file if it was shared by direct download. If the restored file was shared by email (and not by direct download), then this field has a value of null.
download_link string
The download link used to access the restored file through direct download.
retrieved_by string
The email address of the user who initiated the file level restore.
email object
The details used to access the restored file, if it was shared by email. If the restored file was shared by direct download (and not email), then this field has a value of null.
email_message string
The optional message that was sent as part of the email.
retrieved_by string
The email address of the user who initiated the file level restore.
retrieved_for string
The email address of the user who the file was retrieved for.
backup_id string
The Clumio-assigned ID of the backup associated with this restored file.
backup_timestamp string
The timestamp of the when the backup associated with this file started. Represented in RFC-3339 format.
expiration_timestamp string
The timestamp of when the restored file will expire. Represented in RFC-3339 format.
id string
The Clumio-assigned ID of the restored file.
name string
The Clumio-assigned name of the restored file.
size int64
The size of the restored file. Measured in bytes (B).
task_id string
The Clumio-assigned ID of the task which generated the restored file.
_links object
URLs to pages related to the resource.
_first object
The HATEOAS link to the first page of results.
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.
_last object
The HATEOAS link to the last page of results.
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.
_next object
The HATEOAS link to the next page of results.
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.
_prev object
The HATEOAS link to the previous page of results.
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.
_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.
current_count int64
The number of items listed on the current page.
limit int64
The maximum number of items displayed per page in the response.
start string
The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").
total_count int64
The total number of items, summed across all pages.
total_pages_count int64
The total number of pages of results.

{
  "_embedded": {
    "items": [
      {
        "access_methods": [
          {
            "direct_download": {
              "download_link": "string",
              "retrieved_by": "string"
            },
            "email": {
              "email_message": "string",
              "retrieved_by": "string",
              "retrieved_for": "string"
            }
          }
        ],
        "backup_id": "string",
        "backup_timestamp": "string",
        "expiration_timestamp": "string",
        "id": "string",
        "name": "string",
        "size": 0,
        "task_id": "string"
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_last": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_prev": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "limit": 0,
  "start": "string",
  "total_count": 0,
  "total_pages_count": 0
}

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/files

Authorization

Request

Click Edit to configure Base URL

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

Bearer Token

filter — query required

limit — query

start — query

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

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

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

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

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

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

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