REST API - create

appliance recovery backup job: create

Initiate backup.

Request:

HTTP request

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

Request Body Structure:

JSON
XML

{
    "piece": {
        "backup_password": "secret string",
        "comment": "string",
        "location": "string",
        "location_password": "secret string",
        "location_type": "FTPS",
        "location_user": "string",
        "parts": [
            "string",
            "string"
        ]
    }
}

Request Body Parameters:

Name	Type	Description
bold = required
piece	backup_request	BackupRequest Structure.
piece.parts	string[]	a list of optional parts. Run backup parts APIs to get list of optional parts and description
piece.backup_password	secret	a password for a backup piece The backupPassword must adhere to the following password requirements: At least 8 characters, cannot be more than 20 characters in length. At least 1 uppercase letter. At least 1 lowercase letter. At least 1 numeric digit. At least 1 special character (i.e. any character not in [0-9,a-z,A-Z]). Only visible ASCII characters (for example, no space). Optional. backupPassword If no password then the piece will not be encrypted.
piece.location_type	string	a type of location Defines type of all locations for backup/restore Value is one of: FTPS: Destination is FTPS server HTTP: Destination is HTTP server SCP: Destination is SSH server HTTPS: Destination is HTTPS server FTP: Destination is FTP server
piece.location	string	path or url
piece.location_user	string	username for location Optional. locationUser User name for this location if login is required.
piece.location_password	secret	password for location Optional. locationPassword Password for the specified user if login is required at this location.
piece.comment	string	Custom comment Optional. comment an optional comment.

Response:

HTTP Status Code: 200

{
    "value": {
        "end_time": "2015-01-01T22:13:05.651Z",
        "id": "string",
        "messages": [
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            },
            {
                "args": [
                    "string",
                    "string"
                ],
                "default_message": "string",
                "id": "string"
            }
        ],
        "progress": 1,
        "start_time": "2015-01-01T22:13:05.651Z",
        "state": "FAILED"
    }
}

Response Type:

Name	Type	Description
bold = required
value	backup_job_status	BackupJobStatus Structure.
value.id	string	TimeStamp based ID
value.state	string	process state Defines state of backup/restore process Value is one of: FAILED: Failed INPROGRESS: In progress NONE: Not started SUCCEEDED: Completed successfully
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
value.progress	long	percentage complete
value.start_time	date_time	Time when this backup was started.
value.end_time	date_time	Time when this backup was finished. Optional. endTime End time is None till backup is finished.

Errors:

HTTP Status Code	Type	Description
400	feature_in_use	A backup or restore is already in progress
500	error	Generic error