Developer Documentation
Sync Task Depots
Released in v7.0.0Syncs the metadata from the currently configured online or umds depots. If any umds depot is set, then metadata is downloaded from that depot else metadata is downloaded from the online depots. The result of this operation can be queried by calling the cis/tasks/{task-id} where the task-id is the response of this operation.
Request
URLURL
https://{api_host}/api/esx/settings/depots?action=sync&vmw-task=true
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | vmw-task=true is set in order to call this as an async API. The return value then becomes the Task ID instead that is used to query the result from the Task API. |
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | Error | com.vmware.vapi.std.errors.error : if there is some unknown internal error. The accompanying error message will give more details about the failure. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : if the service is not available. |
| 504 | Error | com.vmware.vapi.std.errors.timed_out : if the service is timed out. |
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. |
