REST API - scan-task

esx settings clusters software drafts: scan-task

Scans all the hosts in the cluster against the software draft. 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.


HTTP request

POST https://{server}/api/esx/settings/clusters/{cluster}/software/drafts/{draft}


Path Parameters

Name Type Description
cluster string Identifier of the cluster.
draft string Identifier of the working copy of the document.


HTTP Status Code: 202

Response Body Structure:





Name Type Description
bold = required
- string Result of scan operation.


HTTP Status Code Type Description
500 error If there is unknown internal error. The accompanying error message will give more details about the failure.
404 not_found If there is no cluster associated with cluster or no draft associated with draft in the system.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.