DELETE /compliancePolicies
Use this method to delete one or more compliance policies.
Important
Only compliance policies that are not in the
Assignedstate are deleted.
Authentication
Authentication with username and password is required.
Request URL
DELETE https://{management_server_IP}/compliancePolicies
Query parameters
| Parameters | Required / Optional | Description |
|---|---|---|
| policyName={name} | String | Name of one or more compliance policies to be deleted, separated by a comma |
| removePackage={boolean} | String | Identifies whether to delete the firmware-update packages that are associated with the specified compliance policies if the packages are not associated with another compliance policy. This can be one of the following values.
Note All package files (payload, metadata, readme and history) are deleted. |
The following example deletes four compliance policies and deletes the associated firmware-update packages.
POST https://192.0.2.0/compliancePolicies?policyName=policy1,policy2,policy3,policy4&removePackage=true
Request body
None
Response codes
| Code | Description | Comments |
|---|---|---|
| 200 | OK | The request completed successfully. |
| 400 | Bad Request | A query parameter or request attribute is missing or not valid, or the operation is not supported. A descriptive error message is returned in the response body. |
| 403 | Forbidden | The orchestrator server was prevented from fulfilling the request. A descriptive error message is returned in the response body. Ensure that you have privileges to perform the request. |
| 409 | Conflict | There is a conflict with the current state of the resource. A descriptive error message is returned in the response body. |
| 500 | Internal Server Error | An internal error occurred. A descriptive error message is returned in the response body. |
Response body
| Attributes | Type | Description | ||
|---|---|---|---|---|
| success | String | Results of the request. This can be one of the following values.
| ||
| messages | Array | Information about one or more messages | ||
| explanation | String | Additional information to clarify the reason for the message | ||
| id | String | Message identifier of a returned message | ||
| recovery | Array | Recovery information | ||
| text | String | User actions that can be taken to recover from the event | ||
| URL | String | Link to the help system for more information, if available | ||
| text | String | Message text associated with the message identifier | ||
The following example is returned if the request is successful.
{
"message":[],
"success":"success"
}
Give documentation feedback