Backup management

getTask

Get information for the specified task

get/v2/backup-tasks/{id}

Request

Path parameters

idstring required

A backup task ID

Response

Successful retrieval of the information.

idstring

Task ID

accountstring

Account name

type'BACKUP' | 'RESTORE' | 'DEACTIVATEUSER' | 'DELETEACCOUNTDATA' | 'FINISHEDACK' | 'TERMINATE_MACHINE' | 'EXPORT' | 'MIGRATE' | 'DELETEINDEXDATA' | 'INDEX' | 'DELETEITEMS' | 'COMPARISON' | 'EXPORTACTIVITY' | 'PP_EXPORTACTIVITY'

Task type

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'

Service name

userIdstring

User ID

domainstring

Domain name (SimpleDB, DynamoDB)

status'ACTIVE' | 'NOTACTIVE' | 'IN_ANOTHER' | 'PENDING' | 'PAUSED' | 'ON_PREMISE' | 'SKIPPED' | 'DISPATCHED' | 'QUEUED' | 'INPROCESS' | 'ARCHIVED'

Task status

region'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'

Data center (SimpleDB, DynamoDB)

aliasstring

Friendly name

backupTaskIdstring

Backup task ID

indexboolean

Index flag

snapshotDateinteger

Snapshot date (yyyyMMddHHmmss)

lastBackupDatesobject

Last successful backup dates table per each sub-sourse (mail, calendar, tasks, etc.) (yyyyMMddHHmmss)

nextBackupstring

Schedule for the next backup

sizeinteger

Backup size (bytes)

createDatestring date-time

Date and time when this task was created.

numOfBilledEntitiesinteger

Number of billed entities

numOfEntitiesinteger

Total number of entities

multiEntitiesTaskboolean

Changes

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