Return backup transport events' status

This function retrieves the status of any backup transport events on the account.

SecurityBasicAuth

Request

query Parameters

state	string That transport's current state. If you do not specify this parameter, the function returns the status of all transports on the account. Example: state=running
transport_id or transport_name	string The transport's ID or the transport's name. If you do not specify this parameter, the function returns all transports on the account. Example: transport_id or transport_name=transportname

Responses

200

HTTP Request was successful.

Response Schema: application/json

	object
	object

get/backup_get_transport_status

Request samples

whmapi1 --output=jsonpretty \
  backup_get_transport_status

Response samples

application/json

{"data": {"pages": 3,
"transport_status": {"date": "2018-08-30T00:00:00.000Z",
"end_timestamp": "2018-08-30T02:04:06.000Z",
"start_timestamp": "2018-08-30T02:04:08.000Z",
"status": "running",
"transport": "transportname",
"user": "salem"
}
},
"metadata": {"command": "backup_get_transport_status",
"reason": "OK",
"result": 1,
"version": 1
}
}