# Return backup transport events' status

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

Endpoint: GET /backup_get_transport_status
Version: 11.134.0.5
Security: BasicAuth

## 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: "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: "transportname"

## Response 200 fields (application/json):

  - `data` (object)

  - `data.pages` (integer)
    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.
    Example: 3

  - `data.transport_status` (object)
    hash of information about each transport event. This hash contains the date,  end_timestamp , start_timestamp , status , transport , and user returns.

  - `data.transport_status.date` (string)
    The backup transport event's date. A date in YYYY-MM-DD format, where:- YYYY represents the year.
- MM represents the month.
- DD represents the day.
    Example: "2018-08-30T00:00:00.000Z"

  - `data.transport_status.end_timestamp` (string)
    The transport event's end time. 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.
    Example: "2018-08-30T02:04:06.000Z"

  - `data.transport_status.start_timestamp` (string)
    The transport event's start time. 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.
    Example: "2018-08-30T02:04:08.000Z"

  - `data.transport_status.status` (string)
    The transport event's status.
- completed
- failed
- pending
- running
    Example: "running"

  - `data.transport_status.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. A valid transport name.
    Example: "transportname"

  - `data.transport_status.user` (string)
    The user for whom the system transported the backup
 A valid username on the server.
    Example: "salem"

  - `metadata` (object)

  - `metadata.command` (string)
    The method name called.
    Example: "backup_get_transport_status"

  - `metadata.reason` (string)
    The reason the API function failed when the  field is 0. This field may display a success message when a function succeeds.
    Example: "OK"

  - `metadata.result` (integer)
    *  - Success
*  - Failed: Check the reason field for more details.
    Enum: 0, 1

  - `metadata.version` (integer)
    The version of the API function.
    Example: 1