Delete Tags

Use the "/DeleteTag" API to delete tags in
Control Compliance Suite
.

Authentication

To grant access to users to view or execute RESTful APIs, you must generate an authentication token. To know more about this, refer to this topic - Using token-based authentication for
Control Compliance Suite
RESTful APIs
.

Authorization Requirements

You must have the following permission to execute and use the "/DeleteTag" API:
  • Manage Tags

Authorization Header

You are required to pass the
Bearer Token
in the HTTP authorization header.

Request Method and Content Type

  • To delete tags in
    Control Compliance Suite
    , create a
    POST
    request.
  • The content data that is sent in the HTTP request or response body is formatted as
    application/json
    .

API URL

The following table displays the "/DeleteTag" API description, and the API URL:
Operation Description
Request URL
Use this API to delete tags in
Control Compliance Suite
.
https://<hostname>:<port number>/ccs/api/v2/Tags/DeleteTag

Sample of a "/DeleteTag" API request and response

Sample of a "/DeleteTag" API Request:
{ "Name" : "New Sample Tag" , "CategoryName" : "Default" }
Where
  • Name: This is the name of the tag that should be deleted.
  • CategoryName: Specify the category to which this tag belongs. If "CategoryName" is not provided, the tag is searched under the "Default" category. If found, it gets deleted otherwise, not.
Sample of a "/DeleteTag" API Response:
"Tag deleted successfully"