GetBackupState

Will retrieve information on the locations that are backed up, the last time they were backed up and where the backups are kept.

Syntax

Method ID

#define WAAPI_MID_GET_BACKUP_STATE 1008

JSON Input Structure

{
  "input": {
    "method": 1008,
    "signature": number
  }
}

Input Properties

This method does not require any additional parameters beyond the method ID.

JSON Output Structure

{
  "result": {
    "method": 1008,
    "code": number,
    "timing": number,
    "timestamp": string,
    "last_backup_activity": string,
    "backup_active": boolean,
    "backups": [
      {
        "path": string,
        "time_started": string,
        "time_ended": string,
        "type": string,
        "device": string,
        "status": string,
        "destination": string
      },
      ...
    ]
  }
}

Output Properties

Property	Type	Description
`result.method`	number	The method ID that generated this result.
`result.code`	number	The result code. See Result Codes.
`result.timing`	number	The measured time for the method call in milliseconds.
`result.timestamp`	string	The timestamp in seconds of when the call was made.
`result.last_backup_activity`	string	The last backup time as time (GMT).
`result.backup_active`	boolean	(optional) Returns true if the backup mode is turned on.
`result.backups`	array<object>	An array of backup information.
`result.backups.path`	string	(optional) The path on the system that is being backed up.
`result.backups.time_started`	string	(optional) The start time of the backup in unix time (GMT).
`result.backups.time_ended`	string	(optional) The finish time of the backup in unix time (GMT).
`result.backups.type`	string	(optional) The type of backup that was performed: 'partial' or 'system'.
`result.backups.device`	string	(optional) The device type of the backup: 'local', 'network', 'cloud', 'tape', 'disc'.
`result.backups.status`	string	The state of the backup: 'success', 'in_progress', 'paused', 'failed', 'unknown'.
`result.backups.destination`	string	(optional) The path on the system or the address depending on the 'device'.

Result Codes

Code	Name	Description
0	`WAAPI_OK`	The operation completed successfully.

note

Other codes may be returned. See the full Result Codes reference for the complete list.

Remarks

Error Handling

The results of this function are determined by the error code returned by the call. If successful, WAAPI_OK or a special success code will be returned. Always check both the function return value and the result.code field in the output JSON.

Examples

Examples will be added here demonstrating the usage of this method.

Syntax​

Method ID​

JSON Input Structure​

Input Properties​

JSON Output Structure​

Output Properties​

Result Codes​

Remarks​

Error Handling​

Examples​

See Also​