Appliance Recovery Backup Schedules update

Appliance Recovery Backup Schedules update

Updates a schedule

This operation was added in vSphere API 6.7.

Request
URI
PATCH
https://{api_host}/api/appliance/recovery/backup/schedules/{schedule}
COPY
Path Parameters
string
schedule
Required

Identifier of the schedule

The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.

Request Body

UpdateSpec Structure

Appliance Recovery Backup Schedules UpdateSpec of type(s) application/json
Required 
{
    "parts": [
        "string"
    ],
    "backup_password": "string",
    "location": "string",
    "location_user": "string",
    "location_password": "string",
    "enable": false,
    "recurrence_info": {
        "minute": 0,
        "hour": 0,
        "days": [
            "string"
        ]
    },
    "retention_info": {
        "max_count": 0
    },
    "fast_backup": false
}
array of string
parts
Optional

List of optional parts. Use the GET /appliance/recovery/backup/parts operation to get information about the supported parts.

This property was added in vSphere API 6.7.

If missing or null the value will not be changed.

string As password As password
backup_password
Optional

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).

This property was added in vSphere API 6.7.

If missing or null the value will not be changed.

string As uri As uri
location
Optional

URL of the backup location.

This property was added in vSphere API 6.7.

If missing or null the value will not be changed.

string
location_user
Optional

Username for the given location.

This property was added in vSphere API 6.7.

If missing or null the value will not be changed.

string As password As password
location_password
Optional

Password for the given location.

This property was added in vSphere API 6.7.

If missing or null the value will not be changed.

boolean
enable
Optional

Enable or disable a schedule.

This property was added in vSphere API 6.7.

If missing or null the value will not be changed.

recurrence_info
Optional

Recurrence information for the schedule.

This property was added in vSphere API 6.7.

If missing or null the infomration will not be changed. See Appliance Recovery Backup Schedules RecurrenceInfo

retention_info
Optional

Retention information for the schedule.

This property was added in vSphere API 6.7.

If missing or null the information will not be changed. See Appliance Recovery Backup Schedules RetentionInfo

boolean
fast_backup
Optional

Option to enable Postgres DB/ VCDB fast backup

This property was added in vSphere API 6.7.

If missing or null backup will proceed at slow rate

Authentication
This operation uses the following authentication methods.
Responses
204

Success!

Operation doesn't return any data structure

400

if provided with invalid schedule specification.

Returns Vapi Std Errors InvalidArgument of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0 
"Vapi Std Errors InvalidArgument Object"

404

if schedule associated with id does not exist.

Returns Vapi Std Errors NotFound of type(s) application/json
This response body class contains all of the following: InlineVapi Std Errors NotFound0 
"Vapi Std Errors NotFound Object"

500

if any error occurs during the execution of the operation.

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Appliance Recovery Operations
GET
Appliance Recovery Backup Schedules list
POST
Appliance Recovery Backup Schedules create
POST
Appliance Recovery Backup Schedules run
GET
Appliance Recovery Backup Schedules get
DELETE
Appliance Recovery Backup Schedules delete
PATCH
Appliance Recovery Backup Schedules update