Description

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


Examples 




https://hostname.example.com:2087/cpsess##########/json-api/backup_get_transport_status?api.version=1&transport_name=transportname&status=running




whmapi1 backup_get_transport_status transport_name=transportname status=running



{
    "data": {
        'pages' : 3
        'transport_status': {
          'date': 2018-08-30,
          'end_timestamp': 2018-08-30 02:04:59,
		  'start_timestamp': 2018-08-30 02:04:58
		  'status': running
		  'transport': transportname
		  'user': salem
             }
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "backup_get_transfer_status"
    }
}




Parameters

ParameterTypeDescriptionPossible valuesExample
transport_id or transport_namestring

The transport's ID or the transport's name.

If you do not specify this parameter, the function returns all transports on the account.

A valid transport ID or a valid transport name.transportname
statestring

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
running

Returns

ReturnTypeDescriptionPossible valuesExample
pagesinteger

The number of pages that the backup transports contain.

This return's value depends on the pagination variables that you pass when you call the function.


An integer value.3
transport_statushashA hash of information about each transport event.This hash contains the date, end_timestamp, start_timestamp, status, transport, and user returns.

date

string

The backup transport event's date.

The function returns this value in the transport_status hash.

A date in YYYY-MM-DD format, where:

  • YYYY represents the year.
  • MM represents the month.
  • DD represents the day.
2018-08-30

end_timestamp

string

The transport event's end time.

The function returns this value in the transport_status hash.

A date and time in YYYY-MM-DD HH:MM:SS format, where:

  • YYYY represents the year.
  • MM represents the month.
  • DD represents the day.
  • HH represents the hour.
  • MM represents the minute.
  • SS represents the second.
2018-08-30 02:04:06

start_timestamp

string

The transport event's start time.

The function returns this value in the transport_status hash.

A date and time in YYYY-MM-DD HH:MM:SS format, where:

  • YYYY represents the year.
  • MM represents the month.
  • DD represents the day.
  • HH represents the hour.
  • MM represents the minute.
  • SS represents the second.
2018-08-30 02:04:08

status

string

The transport event's status.

The function returns this value in the transport_status hash.

  • completed
  • failed
  • pending
  • running
running

transport

string

The transport event's name.

If multiple transports use the same name, the system returns the first instance of the transport with that name.

The function returns this value in the transport_status hash.

A valid transport name.

transportname

user

string

The user for whom the system transported the backup

The function returns this value in the transport_status hash.

A valid username on the server.salem