REST API - get

esx settings depots sync schedule: get

Returns the currently configured software depot sync schedule.

Request:

HTTP request

GET https://{server}/api/esx/settings/depots/sync-schedule

Response:

HTTP Status Code: 200

Response Body Structure:

{
    "schedule" : {
        "hour" : 1,
        "skip" : 1,
        "type" : "HOURLY",
        "day_of_month" : 1,
        "minute" : 1,
        "day_of_week" : "SUNDAY"
    },
    "email_addresses" : [
        "string",
        "string"
    ],
    "enabled" : true
}

Headers:

None

Type:

Name	Type	Description
bold = required
-	spec	Currently configured sync schedule.
-.enabled	boolean	Flag indicating whether automatic sync is enabled or not
-.schedule	schedule	The schedule to check for new updates. Optional. If unset the schedule must be disabled.
-.schedule.type	string	Frequency of the schedule. Contains the supported values for how often to sync from online or UMDS depots. Value is one of: HOURLY: Hourly. DAILY: Daily. WEEKLY: Weekly. MONTHLY_BY_DAY: Monthly by day.
-.schedule.skip	long	This determines the units of `recurrence` to skip before the scheduled task runs again. For example, value of 1 for HOURLY type means the scheduled task runs every 2 hours. The value must be within the range 0 to 998. Optional. It is only relevant when type has value [HOURLY, DAILY, WEEKLY, MONTHLY_BY_DAY]. If unset, no unit is skipped.
-.schedule.minute	long	Minute at which schedule should be run. The value must be within the range 0 to 59. Optional. It is only relevant when type has value [HOURLY, DAILY, WEEKLY, MONTHLY_BY_DAY]. This field is optional and it is only relevant when the value of `type` is one of HOURLY, DAILY, WEEKLY, or MONTHLY_BY_DAY.
-.schedule.hour	long	Hour at which schedule should be run. The value must be within the range 0 to 23. Optional. It is only relevant when type has value [DAILY, WEEKLY, MONTHLY_BY_DAY]. This field is optional and it is only relevant when the value of `type` is one of DAILY, WEEKLY, or MONTHLY_BY_DAY.
-.schedule.day_of_month	long	Day at which schedule should be run. The value must be within the range 1 to 31. If the value exceeds the total number of days in the month, the schedule will run on the last day of the month. Optional. It is only relevant when type has value [MONTHLY_BY_DAY]. This field is optional and it is only relevant when the value of `type` is MONTHLY_BY_DAY.
-.schedule.day_of_week	string	Day of the week when schedule should be run Contains the supported days of the week. Value is one of: SUNDAY: Sunday. MONDAY: Monday. TUESDAY: Tuesday. WEDNESDAY: Wednesday. THURSDAY: Thursday. FRIDAY: Friday. SATURDAY: Saturday.Optional. It is only relevant when type has value [WEEKLY]. This field is optional and it is only relevant when the value of `type` is WEEKLY.
-.email_addresses	string[]	Email addresses to which the notification will be sent. If empty, no notification is sent.

Errors:

HTTP Status Code	Type	Description
401	unauthenticated	if the caller is not authenticated.
503	service_unavailable	If the service is not available.
500	error	If there is some unknown error. The accompanying error message will give more details about the failure.