REST API - scan-task
  1. Operations
  2. appliance
  3. vcenter
  4. settings
  5. v1
  6. config

appliance vcenter settings v1 config: scan-task

Scans all the components in the profiles against the applied profile. result of this operation can be queried by calling the api cis/tasks/{task-id} where the task-id is the response of this operation. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Request:

HTTP request

POST https://{server}/api/appliance/vcenter/settings/v1/config/{version}

?action=scan
&vmw-task=true

Path Parameters

Name Type Description
Required
version string version of the profile.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

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

Errors:

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 profile associated with profile in the system.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.