1. Operations
  2. appliance
  3. recovery
  4. backup
  5. schedules

appliance recovery backup schedules: create

Creates a schedule. This operation was added in vSphere API 6.7

Request:

HTTP request

POST https://{server}/rest/appliance/recovery/backup/schedules/{schedule}

Path Parameters

Name Type Description
Required
schedule string Identifier of the schedule.

Request Body Structure:

{
    "spec": {
        "backup_password": "secret string",
        "enable": true,
        "location": "http://myurl.com",
        "location_password": "secret string",
        "location_user": "string",
        "parts": [
            "string",
            "string"
        ],
        "recurrence_info": {
            "days": [
                "MONDAY",
                "MONDAY"
            ],
            "hour": 1,
            "minute": 1
        },
        "retention_info": {
            "max_count": 1
        }
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec create_spec CreateSpec Structure.
spec.parts string[] List of optional parts to be backed up. Use the list operation to get information about the supported parts. This attribute was added in vSphere API 6.7

Optional. If unset all the optional parts will not be backed up.
spec.backup_password secret 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 attribute was added in vSphere API 6.7

Optional. If unset the backup piece will not be encrypted.
spec.location URI URL of the backup location. This attribute was added in vSphere API 6.7
spec.location_user string Username for the given location. This attribute was added in vSphere API 6.7

Optional. If unset authentication will not be used for the specified location.
spec.location_password secret Password for the given location. This attribute was added in vSphere API 6.7

Optional. If unset authentication will not be used for the specified location.
spec.enable boolean Enable or disable a schedule. This attribute was added in vSphere API 6.7

Optional. If unset the schedule will be enabled.
spec.recurrence_info recurrence_info Recurrence information for the schedule. This attribute was added in vSphere API 6.7

Optional. If unset backup job will not be scheduled. See appliance.recovery.backup.schedules.recurrence_info.

spec.recurrence_info.minute long Minute when backup should run. This attribute was added in vSphere API 6.7
spec.recurrence_info.hour long Hour when backup should run. The hour should be specified in 24-hour clock format. This attribute was added in vSphere API 6.7
spec.recurrence_info.days string[] Day of week when the backup should be run. Days can be specified as list of days. This attribute was added in vSphere API 6.7

Optional. If unset the backup will be run everyday.
spec.retention_info retention_info Retention information for the schedule. This attribute was added in vSphere API 6.7

Optional. If unset all the completed backup jobs will be retained forever. See appliance.recovery.backup.schedules.retention_info.

spec.retention_info.max_count long Number of backups which should be retained. If retention is not set, all the backups will be retained forever. This attribute was added in vSphere API 6.7

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
400 invalid_argument if provided with invalid schedule specification.
400 already_exists if the schedule with the given id already exists.
500 error if any error occurs during the execution of the operation.