Remove From Used By Tag
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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. |
Header Parameters
Header Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
Request Body
Request Body
Contains TaggingTagRemoveFromUsedByRequestBody
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. |
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
| Code | Returns | Description |
|---|---|---|
| default | ErrorRest | Not available |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to remove an entity from the TagModel.used-by field. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the tag for the given tagId does not exist in the system. |
On This Page
Tag Operations
get
post
get
patch
delete
post
post
