Update Tags
Use the "/UpdateTag" API to update 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 "/UpdateTag" API:
- Manage Tags
Authorization Header
You are required to pass the in the HTTP authorization header.
Bearer Token
Request Method and Content Type
- To update tags inControl Compliance Suite, create aPOSTrequest.
- The content data that is sent in the HTTP request or response body is formatted asapplication/json.
API URL
The following table displays the "/UpdateTag" API description, and the API URL:
Operation Description | Request URL |
Use this API to update tags in Control Compliance Suite . | https://<hostname>:<port number>/ccs/api/v2/Tags/UpdateTag |
Sample of a "/UpdateTag" API request and response
Sample of a "/UpdateTag" API Request:
{ "Name" : "Sample Tag" , "NewName" : "New Sample Tag" , "CategoryName" : "Default" }
Where
- Name: This is the name of the existing tag.
- NewName: Provide a new name to the existing tag.
- 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 updated otherwise, no updates take place.
Sample of a "/UpdateTag" API Response:
"Tag updated successfully"