---
title: "Return backup storage locations"
method: GET
path: "/Restore/query_file_info"
tags: ["File Restoration"]
---

# Return backup storage locations

`GET /Restore/query_file_info`

This function lists all of an item's backup locations. An item can be a file, a directory, or a symlink.

**Important:**

When you disable the [File Storage role](https://go.cpanel.net/serverroles#roles), the system **disables** this function.

## Query parameters

- `path` string, path, required
- `exists` 1 | 0

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer — The version of the API.
  - `func` string — The name of the method called.
  - `module` string — The name of the module called.
  - `result` object
    - `data` object[] — An array of objects containing the item's details.
      - `backupDate` string, ISO-8601 Date — The date when the system created the backup.
      - `backupID` union — The backup's identification. * A date, in `YYYY-MM-DD` format. * `incremental` — An incremental daily backup. * The backup frequency (`weekly` or `monthly`) , a slash character (`/`), and the value `incremental`. * The backup frequency (`weekly` or `monthly`), a slash character (`/`), and the backup date, in `YYYY-MM-DD` format.
        - string, ISO-8601 Date — A daily backup file from a specified backup date.
        - 'incremental' — An incremental daily backup.
        - 'weekly/incremental' | 'monthly/incremental' — A weekly or monthly incremental backup.
        - string — A weekly or monthly backup from a specified backup date.
      - `backupType` 'compressed' | 'incremental' | 'uncompressed' — The backup type. * `compressed` — A compressed tar file. * `incremental` — A full tree of files and directories. * `uncompressed` — An uncompressed tar file.
      - `exists` 1 | 0 — Whether the item (a file, a directory, or a symlink) exists in the local disk or only in the backup. * `1` — The item exists in the local disk. * `0` — The item exists only in the backup. **Note:** This return appears **only** if you set the `exists` parameter to `1`.
      - `fileSize` integer — The size, in bytes, of the file in the backup. **Note:** The function returns this value **only** if the item is a file.
      - `mtime` integer — The file's last modification time.
      - `path` string, path — The identical file path value that the system passed in the function.
      - `type` 'dir' | 'file' | 'symlink' | 'unknown' — The item type stored in the backup. * `dir` — A directory. * `file` — A file. * `symlink` — A symlink. * `unknown` — An unknown file type.
    - `errors` string[], nullable — List of errors if the API failed.
    - `messages` string[], nullable — List of messages generated by the API.
    - `metadata` object
      - `transformed` 1 — Post-processing may have transformed the data.
    - `status` 1 | 0 — * `1` — Success. * `0` — Failed. Check the `errors` field for more details.
    - `warnings` string[], nullable — List of warnings generated by the API. Warnings describe non-critical failures or other problematic conditions noted while running a API.

---

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