Sign in
Restore & Download

createExport

Download a backup.

post/v1/recovery/export

Request body

taskIdstring required

Backup task ID

accountstring required

Account to restore

source'GMAIL' | 'GDOC' | 'GDRIVETEAM' | 'SFC' | 'GOOGLEAPPS' | 'GCALENDAR' | 'GTASK' | 'GCONTACTS' | 'YMAIL' | 'GACCOUNTS' | 'GSITES' | 'SDB' | 'O365MAIL' | 'O365CONTACTS' | 'DDB' | 'MS365' | 'O365CALENDAR' | 'O365TASKS' | 'SHAREPOINT' | 'SHAREPOINT_MULTI' | 'ONEDRIVE' | 'IMAP' | 'BOX' | 'PUBLICWORDPRESS' | 'DROPBOX' | 'MS365GROUPS' | 'MS365GROUP_CONVERSATIONS' | 'MS365GROUP_CALENDAR' | 'MS365GROUP_SITE' | 'MS365GROUP_META' | 'O365NOTES' | 'MS365TEAM_CHANNELS' | 'MS365TEAM_APPS' | 'MSTEAMS' | 'MSGROUPS' | 'INTERNAL' | 'DYNAMICS365' | 'ENTRAID' required

Service to restore

dateinteger required

Backup date

includeDeletedboolean

Include deleted items

includeLegalHoldboolean

Include files with the legal hold

extidstring

External id of entity (for multiple entities tasks)

downloadToPstboolean

Download in PST format (splits large files into chunks)

preferSinglePSTboolean

Download in PST format (single file)

storageType'CLOUDALLY_S3' | 'AMAZON_S3' | 'AZURE' | 'GOOGLE_CLOUD_PLATFORM' | 'AMAZON_S3_COMPATIBLE'

Optional, default value is CLOUDALLY_S3, use this field if you wish to download data to your own cloud storage

storageBucketNamestring

AWS/GCP bucket name or Azure blob container name, used with AMAZON_S3, AMAZON_S3_COMPATIBLE, GOOGLE_CLOUD_PLATFORM or AZURE storage type

storageKeystring

AWS/GCP Key or Azure account name, used with AMAZON_S3, AMAZON_S3_COMPATIBLE, GOOGLE_CLOUD_PLATFORM or AZURE storage type

storageSecretKeystring

AWS/GCP secret key or Azure access key, used with AMAZON_S3, AMAZON_S3_COMPATIBLE, GOOGLE_CLOUD_PLATFORM or AZURE storage type

storageRegion'US_EST' | 'US_EST_OHIO' | 'US_WEST_OREGON' | 'US_WEST_CAL' | 'EU' | 'EU_FRANKFURT' | 'ASIA_HONG_KONG' | 'ASIA_MUMBAI' | 'ASIA_SEOUL' | 'ASIA_SINGAPORE' | 'ASIA_SIDNEY' | 'ASIA_TOKYO' | 'SOUTH_AMERICA' | 'AFRICA_CAPE_TOWN' | 'ASIA_CHINA' | 'CANADA' | 'LONDON' | 'EU_PARIS' | 'EU_STOCKHOLM' | 'EU_ZURICH'

AWS/GCP storage Region, used with AMAZON_S3, AMAZON_S3_COMPATILE or GOOGLE_CLOUD_PLATFORM storage type

storageEndPointstring

Storage endpoint URL, used with AMAZON_S3_COMPATIBLE

Response

Successful retrieval of the information.

Changes

No recorded changes to this endpoint across all 1 revision of this API.