Generate Backup Download Cookie

This request generates a one-time cookie used to download the specified backup without providing a valid API key.

Request

URI

POST

https://{api_host}//backups/cookie/{backupId}

COPY

Path Parameters

string

backupId

Required

UUID of the backup

backupId example

d5210087-e81e-4cbc-80a2-178f7313a772

Header Parameters

string

operationID

Optional

Operation ID for correlating logs across multiple services

Authentication

This operation uses the following authentication methods.

VMware_Cloud_Director_Availability_vApp_Replication_Manager_cookie

Responses

202

Accepted

Returns DownloadCookie of type(s) application/vnd.vmware.h4-v4.2+json;charset=UTF-8

{
    "cookie": "KqT+e0RCQTq86xZTjl8D5t2nAhs="
}

string

Optional

The generated cookie.

401

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

NotAuthenticated

Returns ApiError of type(s) application/vnd.vmware.h4-v4.2+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.2+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.