Create a backup on a disk (mounted or fix disk) on the controller.The method is asynchronous. The current state of the backup are sent as events. The response contains a location header which can be subscribed on to get the events.
Backup may affect RAPID execution and can cause system stops.

URL

/ctrl/backup

Method

POST

URL Params

action=backup Required

See Common URL parameters

Data Params

backup= path where the backup shall be stored. Destination path must be part of the controller file system. Required

Environment variables such as $TEMP, $SYSTEM shall be possible to have in the path. But $HOME directory cannot be used as backup path. Example: backup=/fileservice/$syspar/tempfolder

archive=TRUE | FALSE

Success Response

ACCEPTED(202)
Location header: /progress/{id}

see HTTP Status codes

Example Response

No content

Error Response

UNAUTHORIZED(401), FORBIDDEN(403), BAD_REQUEST(400), CONFLICT(409)

See Robot controller return codes

Sample Call

curl --digest -u "Default User":robotics -d "backup=/fileservice/$syspar/tempfolder" -X POST "http://localhost/ctrl/backup?action=backup"

Notes

Requires UAS grant UAS_BACKUP.
It is not possible to create backup with the same path and name as an environment variable directory (SYSTEM, HOME, SYSPAR etc).
It is not possible create backup under HOME directory.
Since backup is an asynchronous task, the location header can be subscribed on to get information about the status of the task.
Not supported in bootserver mode