REST API - cancel

appliance recovery backup job: cancel

Cancel the backup job.

Request:

HTTP request

POST https://{server}/rest/appliance/recovery/backup/job/{id}/cancel

Path Parameters

Name	Type	Description
Required
id	string	ID (ID of job).

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	BackupJobStatus Structure.
value.status	string	Status of the cancel operation. Defines the return type for the cancel operation. You specify the return status when you return the result of cancel job. See appliance.recovery.backup.job.return_result. Value is one of: FAIL: Cancel operation failed. WARNING: Cancel operation passed with warnings. OK: Cancel operation succeeded.
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
404	not_found	if backup associated with id does not exist.
500	error	if any error occurs during the execution of the operation.