This API has a deprecated equivalent from v7.0U1.
Start Import History
DescriptionCreates and starts task for importing vCenter historical data.
Request
URLURL
https://{api_host}/api/vcenter/deployment/history?action=start
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
DeploymentImportHistoryCreateSpec of mimetype application/json
Optional
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
{
"description": "string",
"name": "string"
}
string
description
Required
Description of the vCenter history import task.
string
name
Required
Name of the vCenter history import task
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
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.
403
com.vmware.vapi.std.errors.unauthorized : if the caller is not authorized to perform the operation.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$DeploymentImportHistoryCreateSpec = Initialize-DeploymentImportHistoryCreateSpec -Name "MyName" -Description "MyDescription"
Invoke-StartDeploymentHistory -DeploymentImportHistoryCreateSpec $DeploymentImportHistoryCreateSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"description":"string","name":"string"}' https://{api_host}/api/vcenter/deployment/history?action=start
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/deployment/history?action=start
x-vmw-doc-operation: start
Availability
Added in 7.0U2
On This Page
Import History Operations
post
post
