Get Depots Sync Schedule
Released in v7.0.0Returns the currently configured software depot sync schedule. if you do not have all of the privileges described as follows: - Operation execution requires VcIntegrity.lifecycleSettings.Read.
Request
URLURL
https://{api_host}/api/esx/settings/depots/sync-schedule
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Response
Response
Response BodyResponse Body
200 OK returns
SettingsDepotsSyncScheduleSpec
of type application/json
Currently configured sync schedule.
{
"email_addresses": [
"string"
],
"enabled": false,
"schedule": {
"day_of_month": 0,
"day_of_week": "enum",
"hour": 0,
"minute": 0,
"skip": 0,
"type": "enum"
}
}| Property Name | Type | Description |
|---|---|---|
| email_addresses | array of string |
Email addresses to which the notification will be sent. If empty, no notification is sent. |
| enabled | boolean |
Flag indicating whether automatic sync is enabled or not |
| schedule | SettingsDepotsSyncScheduleSchedule |
The schedule to check for new updates. If unset the schedule must be disabled. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/esx/settings/depots/sync-schedule
Errors
| Code | Returns | Description |
|---|---|---|
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. |
| 404 | Error | com.vmware.vapi.std.errors.error : If there is some unknown error. The accompanying error message will give more details about the failure. |
