CPcpanel
ExtractInfo

Return archive extraction progress

Changed on

This function returns progress information for an archive extraction that the ExtractInfo::start function began.

Note: When no run is active, the state return value is none and the other return values are 0 or null.

get/ExtractInfo/progress

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "progress",
  "module": "ExtractInfo",
  "result": {
    "data": {
      "currentBytes": 104857600,
      "elapsedSeconds": 42,
      "percent": 33.3,
      "startedAtEpoch": 1750636800,
      "state": "inprogress",
      "totalBytes": 314572800
    },
    "status": 1
  }
}

Changes

  • 99adb57e7a5dRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • warning

      added the new 0.00 enum value to the / response property for the response status

    • warning

      added the new 1.00 enum value to the / response property for the response status

    • info

      api operation id progress removed and replaced with ExtractInfo-progress

    • info

      added the optional property / to the response with the status