CPcpanel
BackupInfo

Remove backup progress record

Changed on

This function clears the authoritative run-state record, so that the BackupInfo::progress function stops reporting a complete state that persists across polls.

Note: After a reset, the BackupInfo::progress function reflects only live state. It reports inprogress while a run is genuinely active and none otherwise. This function is idempotent and succeeds whether or not a record exists.

get/BackupInfo/reset

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": "reset",
  "module": "BackupInfo",
  "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 reset removed and replaced with BackupInfo-reset

    • info

      added the optional property / to the response with the status