Generate Backup Download Cookie

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

backupId

Header Parameters
string
operationID
Optional

Operation ID for correlating logs across multiple services


Authentication
This operation uses the following authentication methods.
Responses
202

Accepted

Returns DownloadCookie of type(s) application/json;charset=UTF-8
{
    "cookie": "string"
}
string
cookie
Optional

cookie


401

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

  • NotAuthenticated
Returns ApiError of type(s) application/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/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.