Backups
Backup or Restore
Return backup transport events' status
This function retrieves the status of any backup transport events on the account.
get/backup_get_transport_status
Query parameters
state'completed' | 'failed' | 'pending' | 'running'
Example:running
That transport's current state. If you do not specify this parameter, the function returns the status of all transports on the account.
- completed
- failed
- pending
- running
transport_idstring
Example:transportname
The transport's identification (ID). If you do not specify this parameter, the function returns all transports on the account.
Note:
You can use this parameter or the transport_name parameter.
Response
HTTP Request was successful.
Example response
{
"data": {
"pages": 3,
"transport_status": [
{
"date": "2019-08-30T00:00:00.000Z",
"end_timestamp": "2019-08-30T02:04:06.000Z",
"start_timestamp": "2019-08-30T02:04:08.000Z",
"status": "running",
"transport": "transportname",
"user": "username"
}
]
},
"metadata": {
"command": "backup_get_transport_status",
"reason": "OK",
"result": 1,
"version": 1
}
}