Developer Documentation
Child pages
  • WHM API 1 Functions - backup_get_transport_status
Skip to end of metadata
Go to start of metadata

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI


 cPanel Analytics

participate_in_analytics


Description

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

Examples 

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


Notes:

  • Unless otherwise noted, you must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.

  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)
{
    "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.

Note:

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.

Note:

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

Function information

API Version:

WHM API 1

Available in:

WHM 78+

Methods:

GET, POST

Required Parameters:

(none)

Return Formats:

JSON


About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions



cPanel, WebHost Manager, and WHM are registered trademarks of cPanel, L.L.C. for providing its computer software that facilitates the management and configuration of Internet web servers. ®2019 All rights reserved.