REST API - start
  1. Operations
  2. vcenter
  3. deployment
  4. import history

vcenter deployment import history: start

Creates and starts task for importing vCenter historical data. This operation was added in vSphere API 6.7.

Request:

HTTP request

POST https://{server}/rest/vcenter/deployment/history?action=start

Request Body Structure:

{
    "spec" : {
        "name" : "string",
        "description" : "string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
spec create_spec Optional. An optional create_spec info that can be passed for creating a new historical data import task and starts it.
spec.name string Name of the vCenter history import task. This attribute was added in vSphere API 6.7.
spec.description string Description of the vCenter history import task. This attribute was added in vSphere API 6.7.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
401 unauthenticated if the caller is not authenticated.
403 unauthorized if the caller is not authorized to perform the operation.
400 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
400 already_in_desired_state if vCenter historical data import task has already being started.
500 error Generic error