CPcpanel
ExtractInfo

Remove extract progress record

Changed on

This function clears the run-state marker that the ExtractInfo::start function wrote.

Note: After it runs, the ExtractInfo::progress function reports the state none. This function is idempotent and succeeds whether or not a marker exists. Call it after the Fileman::fileop function with op=extract finishes, whether that operation succeeded or failed.

get/ExtractInfo/finish

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": "finish",
  "module": "ExtractInfo",
  "result": {
    "data": {
      "cleared": true
    },
    "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 finish removed and replaced with ExtractInfo-finish

    • info

      added the optional property / to the response with the status