Developer Documentation
Create Task Depots Offline
Released in v7.0.0Imports a new offline software depot. This will also import the metadata and payloads from this offline depot. The returned task will fail and no Offline Depot would be created if there are any issues during import. 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/offline?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. |
Request Body
Request Body
Contains
OfflineCreateSpec
of type application/json
(required)
{
"source_type": "enum"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | source_type | OfflineSourceType Enum |
Type of the source from which offline bundle is obtained. |
| optional | description | string |
Description of the depot. If unset, the description will be empty. |
| optional | file_id | string |
File identifier returned by the file upload endpoint after file is uploaded. This field is optional and it is only relevant when the value of Offline.CreateSpec.source-type is PUSH. |
| optional | location | string |
Location of the depot from which content should be retrieved. This field is optional and it is only relevant when the value of Offline.CreateSpec.source-type is PULL. |
Response
Response
Response BodyResponse Body
202 Accepted returns
string
of type application/json
Identifier of the imported depot as part of result structure.
Errors
| Code | Returns | Description |
|---|---|---|
| default | Error | Not available |
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : If an invalid pullLocation is provided. |
| 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 internal error. The accompanying error message will give more details about the failure. |
| 409 | Error | com.vmware.vapi.std.errors.already_exists : If the depot content of CreateSpec already exists. The value of the data field of Error will be a structure that contains existing depot content id as part of depot field defined in Offline.CreateResult. |
| 503 | Error | com.vmware.vapi.std.errors.service_unavailable : If the service is not available. |
On This Page
Depots Offline Operations
delete
