REST API - cancel

appliance recovery restore job: cancel

Cancel the restore job

Request:

HTTP request

POST https://{server}/rest/appliance/recovery/restore/job/cancel
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "messages"[
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "id""string"
            },
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "id""string"
            }
        ],
        "status""FAIL"
    }
}

Response Type:

Name Type Description
bold = required
value return_result RestoreJobStatus Structure.
value.status string Check status

Defines the state of precheck Value is one of:
FAIL: Check failed
WARNING: Passed with warnings
OK: Check passed

value.messages localizable_message[] List of messages

value.messages[].id string id in message bundle

value.messages[].default_message string text in english

value.messages[].args string[] nested data

Errors:

HTTP Status Code Type Description
500 error Generic error