---
title: "Begin tracking progress for an extract run"
method: GET
path: "/ExtractInfo/start"
tags: ["ExtractInfo"]
---

# Begin tracking progress for an extract run

`GET /ExtractInfo/start`

Begins tracking an extract run for the given archive and destination directory (both must resolve within the current user's home directory). Computes the exact uncompressed byte size of the archive and snapshots the destination directory's current disk usage as a baseline, then writes a run-state marker. Returns immediately; no extraction happens in this function. Call before Fileman.fileop op=extract.

## Query parameters

- `archive` string, required
- `directory` string, required

## Response `200`

HTTP Request was successful.

- object
  - `apiversion` integer
  - `func` string
  - `module` string
  - `result` object
    - `data` object
      - `started` boolean — Always true on success.
    - `errors` string[]
    - `messages` string[]
    - `status` integer
    - `warnings` string[]

---

[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/versions/632e2f8e6d04/schema)