Remove From Used By Tag
Removes the usedByEntity from the TagModel.used-by subscribers set. If the usedByEntity is not using this tag, then this becomes a no-op. To invoke this operation, you need modify TagModel.used-by privilege on the tag.
Request
URLURL
https://{api_host}/rest/com/vmware/cis/tagging/tag/id:{tag_id}?~action=remove-from-used-by
Parameters
Parameters
string
tag_id
Required
The identifier of the input tag.
The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Request Body
Request Body
TaggingTagRemoveFromUsedByRequestBody of type application/json (required){
"used_by_entity": "string"
}
string
used_by_entity
Required
The name of the user to be removed from the TagModel.used-by set.
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"used_by_entity":"string"}' https://{api_host}/rest/com/vmware/cis/tagging/tag/id:{tag_id}?~action=remove-from-used-by
Errors
401
com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to remove an entity from the TagModel.used-by field.
404
com.vmware.vapi.std.errors.not_found : if the tag for the given tagId does not exist in the system.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
On This Page
Tag Operations
get
post
get
patch
delete
post
post