Developer Documentation
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
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | The identifier of the input tag. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Tag. |
Request Body
Request Body
Contains
RemoveFromUsedByRequestBody
of type application/json
(required)
{
"used_by_entity": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | used_by_entity | string |
The name of the user to be removed from the TagModel.used-by set. |
Errors
| Code | Returns | Description |
|---|---|---|
| 404 | Error | com.vmware.vapi.std.errors.not_found : if the tag for the given tagId does not exist in the system. |
| default | Error | Not available |
| 401 | Error | com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to remove an entity from the TagModel.used-by field. |
On This Page
Tag Operations
get
post
get
patch
delete
post
post
