REST API - scan-task
  1. Operations
  2. appliance
  3. configuration
  4. desired state

appliance configuration desired state: scan-task

Scans all the components in the profiles against the applied profile. 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. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/api/appliance/configuration/desiredstate/{profile}

?action=scan
&vmw-task=true

Path Parameters

Name Type Description
Required
profile string Identifier of the profile to be scanned.

Response:

HTTP Status Code: 202

Response Body Structure:

"obj-103"

Headers:

None

Type:

Name Type Description
bold = required
- string Result of 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 version associated with version in the system.
503 service_unavailable If the service is not available.
401 unauthenticated If the caller is not authenticated.