REST API - get
  1. Operations
  2. appliance
  3. recovery
  4. backup
  5. schedules

appliance recovery backup schedules: get

Returns an existing schedule information based on id. This operation was added in vSphere API 6.7.

Request:

HTTP request

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

Path Parameters

Name Type Description
Required
schedule string Identifier of the schedule.

Response:

HTTP Status Code: 200

Representation:

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

Response Type:

Name Type Description
bold = required
value info Info Structure.
value.parts string[] List of optional parts that will be included in backups based on this schedule details. Use the list operation to get information about the supported parts. This attribute was added in vSphere API 6.7.
value.location URI URL of the backup location. This attribute was added in vSphere API 6.7.
value.location_user string Username for the given location. This attribute was added in vSphere API 6.7.

Optional. If unset location user will not be used.
value.enable boolean Enable or disable a schedule, by default when created a schedule will be enabled. This attribute was added in vSphere API 6.7.
value.recurrence_info recurrence_info Recurrence information for the schedule. This attribute was added in vSphere API 6.7.

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

value.recurrence_info.minute long Minute when backup should run. This attribute was added in vSphere API 6.7.
value.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.
value.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.
value.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 are retained forever. See appliance.recovery.backup.schedules.retention_info.

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

Errors:

HTTP Status Code Type Description
404 not_found if schedule associated with id does not exist.
500 error if any error occurs during the execution of the operation.