---
title: "Return backup transport events' status"
method: GET
path: "/backup_get_transport_status"
tags: ["Backups", "Backup or Restore"]
---

# Return backup transport events' status

`GET /backup_get_transport_status`

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

## Query parameters

- `state` 'completed' | 'failed' | 'pending' | 'running'
- `transport_id` string

## Response `200`

HTTP Request was successful.

- object
  - `data` object
    - `pages` integer — The number of pages that the backup transports contain. **Note:** This return's value depends on the [pagination variables](https://go.cpanel.net/paginationvariables) that you pass when you call the function.
    - `transport_status` object[] — A list of information about each transport event.
      - `date` string, ISO-8601 Date — The backup transport event's date.
      - `end_timestamp` string — The transport event's end time, in `YYYY-MM-DD HH:MM:SS` format.
      - `start_timestamp` string — The transport event's start time, in `YYYY-MM-DD HH:MM:SS` format.
      - `status` string — The transport event's status. * `completed` * `failed` * `pending` * `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.
      - `user` string — The user for whom the system transported the backup.
  - `metadata` object
    - `command` string — The method name called.
    - `reason` string — The reason the function failed when the `metadata.result` field is `0`. This field may include a success message when the function succeeds.
    - `result` 1 | 0 — - `1` — Success. - `0` — Failed. Check the `reason` field for more details.
    - `version` integer — The API version of the function.

---

[API](https://skmtc.net/cpanel/apis/whm-api.md) · [All operations](https://skmtc.net/cpanel/apis/whm-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cpanel/whm-api/revisions/3da41671c02c/schema)