Start Import History
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Creates and starts task for importing vCenter historical data.
Request
URLURL
https://{api_host}/rest/vcenter/deployment/history?action=start
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains DeploymentImportHistoryStartRequestBody
of type application/json
(required)
{
"spec": {
"description": "string",
"name": "string"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| optional | spec | DeploymentImportHistoryCreateSpec |
An optional ImportHistory.CreateSpec info that can be passed for creating a new historical data import task and starts it. If unset, default value will be: - name : vcenter.deployment.history.import - description : vCenter Server history import |
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"description":"string","name":"string"}}' https://{api_host}/rest/vcenter/deployment/history?action=start
Errors
| Code | Returns | Description |
|---|---|---|
| 409 | ErrorRest | com.vmware.vapi.std.errors.not_allowed_in_current_state : if vCenter historical data import task cannot be started at this time. This can happen in the following cases: - If historical data import has already been canceled because a canceled task cannot be re-started - If historical data import has already been completed because a completed task cannot be re-started - If historical data import has already been paused because a paused task can only be resumed or canceled | com.vmware.vapi.std.errors.already_in_desired_state : if vCenter historical data import task has already being started. |
| default | ErrorRest | Not available |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. | com.vmware.vapi.std.errors.unauthorized : if the caller is not authorized to perform the operation. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.error : Generic error |
On This Page
Import History Operations
post
post
