Generate Backup

Generate Backup

This request generates a new backup. This operation requires administrative permissions and may take some time to complete.

Request
URI
POST
https://{api_host}//backups
COPY
Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services

Request Body
NewBackupRequest of type(s) application/json
Required 
{
    "password": "Pa$$w0rD!"
}
string
password
Optional

The password for the generated backup.

Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns ApiTask_of_BackupInfo of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8 
{
    "endTime": 1499929558827,
    "error": {
        "args": [],
        "code": "Forbidden",
        "msg": "Permission denied.",
        "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
    },
    "id": "f61d60d2-698a-46dc-a266-88df27644956",
    "lastUpdated": 1499929558827,
    "progress": 100,
    "result": {
        "generatedOn": "1464261608370L",
        "hash": "SHA-512:DE:AB:61:7A:E0:D8:7B:D1:8E:CC:F8:EB:80:2C:8F:8F:DE:00:D3:C3:FE:13:1A:F4:76:43:7A:AE:0E:4C:34:F7:36:14:28:30:6B:1C:57:27:6D:63:26:63:BB:37:3D:E6:D3:9D:94:1B:48:98:5E:66:02:DF:AD:E7:F5:92:55:23",
        "id": "b05d1e00-6338-48ff-86fb-ee0e55b8cd93"
    },
    "resultType": "string",
    "startTime": 1499929548951,
    "state": "string",
    "user": "root",
    "warnings": [],
    "workflowInfo": {}
}
integer As int64 As int64
endTime
Optional

Timestamp in msec of the completion time of the task. -1 means the task hasn't completed.

ApiError
error
Optional

error

string As uuid As uuid
id
Optional

The unique identifier of the long-running task. It is unique and can be used for monitoring.

integer As int64 As int64
lastUpdated
Optional

Timestamp in msec of the last task status update.

integer As int32 As int32
progress
Optional

Percentage-based progress of the task.

BackupInfo
result
Optional

result

string
resultType
Optional

Indicates the type of the task result. Populated only if the execution was successful.

integer As int64 As int64
startTime
Optional

Timestamp in msec of the creation time of the task.

Task_State
state
Optional

state

string
user
Optional

The user who started the task.

array of ResultWarning
warnings
Optional

Warnings, which occurred during the task execution.

ApiWorkflowInfo
workflowInfo
Optional

workflowInfo


401

The returned error codes include (but are not limited to): NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


500

The returned error codes include (but are not limited to): GeneralServerFailure

Returns ApiError of type(s) application/vnd.vmware.h4-v4.5+json;charset=UTF-8 
{
    "args": [],
    "code": "Forbidden",
    "msg": "Permission denied.",
    "stacktrace": "com.vmware.h4.api.error.exceptions.PermissionDeniedException: Permission denied."
}
array of string
args
Optional

Positional arguments.

string
code
Optional

Specific error code.

string
msg
Optional

Detailed error message.

string
stacktrace
Optional

Exception stacktrace.


On This Page
Backups Operations
DELETE
Delete Backup
GET
Download Backup
GET
Download Backup With Cookie
POST
Generate Backup
POST
Generate Backup Download Cookie
POST
Generate Backup With Id
GET
List Backups