Restore Files

Restores one or more files from the specified backup.

Query Parameters

embed string
Embeds the details of each associated resource. Set the parameter to one of the following embeddable links to include additional details associated with the resource.

Embeddable Link Description
read-task Embeds the associated task in the response. For example, ?embed=read-task
For more information about embedded links, refer to the Embedding Referenced Resources section of this guide.

Embeddable Link	Description
read-task	Embeds the associated task in the response. For example, `?embed=read-task`

application/json

Request Body required

source object required
The files to be restored and from which backup they are to be restored from.
backup_id string required
The Clumio-assigned ID of the backup containing the files you want to restore. Use GET /backups/files/search/{search_result_id}/versions to fetch the value.
files object[] required
The list of files to be restored.
filesystem_id string required
The Clumio-assigned ID of the filesystem within which to restore the file. Use GET /backups/files/search/{search_result_id}/versions to fetch the value.
path string required
The path of the file to be restored. Use GET /backups/files/search to fetch the value.
target object
The destination information for the file level restore, representing the access option for the restored file. Users can access the restored file by direct download or by email. 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. If a target is not specified, then target defaults to direct_download.
direct_download object
Specifies the Clumio UI as the restore target for direct download. Optionally set direct_download: {}. If a target is not specified, then target defaults to direct_download.
email object
Specifies a download link (accessible via email) as the restore target. If not specified, target defaults to direct_download. If you specify email, also send the user the passcode that gets generated from this request (see passcode in the response). After the user clicks the download link, they must enter the passcode to access the files.
email_address string
The email address of the user who will receive the download link to the restored file.
message string
The optional message sent as part of the email.

Responses

202
default

Success

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

Schema
Example (from schema)

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.
id string
The Clumio-assigned ID of the restored file.
passcode string
The passcode that the end-user must use to access the restored file, in the case the restored file was emailed to the end-user as part of transparent data access.
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.

{
  "_embedded": {},
  "_links": {
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "read-task": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "id": "string",
  "passcode": "string",
  "task_id": "string"
}

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"
    }
  ]
}

POST /restores/files

Authorization

Request

Click Edit to configure Base URL

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

Bearer Token

embed — query

Body required

{
  "source": {
    "backup_id": "string",
    "files": [
      {
        "filesystem_id": "string",
        "path": "string"
      }
    ]
  },
  "target": {
    "direct_download": {},
    "email": {
      "email_address": "string",
      "message": "string"
    }
  }
}

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "files": [
      {
        "filesystem_id": "string",
        "path": "string"
      }
    ]
  },
  "target": {
    "direct_download": {},
    "email": {
      "email_address": "string",
      "message": "string"
    }
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "files": [
      {
        "filesystem_id": "string",
        "path": "string"
      }
    ]
  },
  "target": {
    "direct_download": {},
    "email": {
      "email_address": "string",
      "message": "string"
    }
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "files": [
      {
        "filesystem_id": "string",
        "path": "string"
      }
    ]
  },
  "target": {
    "direct_download": {},
    "email": {
      "email_address": "string",
      "message": "string"
    }
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "files": [
      {
        "filesystem_id": "string",
        "path": "string"
      }
    ]
  },
  "target": {
    "direct_download": {},
    "email": {
      "email_address": "string",
      "message": "string"
    }
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "files": [
      {
        "filesystem_id": "string",
        "path": "string"
      }
    ]
  },
  "target": {
    "direct_download": {},
    "email": {
      "email_address": "string",
      "message": "string"
    }
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "files": [
      {
        "filesystem_id": "string",
        "path": "string"
      }
    ]
  },
  "target": {
    "direct_download": {},
    "email": {
      "email_address": "string",
      "message": "string"
    }
  }
}'

curl -L -X POST 'https://us-west-2.api.clumio.com/restores/files' \
-H 'Content-Type: application/json' \
-H 'Accept: application/api.clumio.restored-files=v1+json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "source": {
    "backup_id": "string",
    "files": [
      {
        "filesystem_id": "string",
        "path": "string"
      }
    ]
  },
  "target": {
    "direct_download": {},
    "email": {
      "email_address": "string",
      "message": "string"
    }
  }
}'

Restore Files​

Authorization

Request

Restore Files