This API has a deprecated equivalent from v7.0U1.
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}/api/cis/tagging/tag/{tag_id}?action=remove-from-used-by
Path Parameters
Path 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 mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"used_by_entity": "string"
}
string
used_by_entity
Required
The name of the user to be removed from the TagModel.used-by set.
Authentication
This operation uses the following authentication methods.
Errors
Errors
403
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.
Code Samples
PowerCLI Client SDK Example
$TaggingTagRemoveFromUsedByRequestBody = Initialize-TaggingTagRemoveFromUsedByRequestBody -UsedByEntity "MyUsedByEntity"
Invoke-RemoveFromUsedByTagId -TagId "MyTagId" -TaggingTagRemoveFromUsedByRequestBody $TaggingTagRemoveFromUsedByRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"used_by_entity":"string"}' https://{api_host}/api/cis/tagging/tag/{tag_id}?action=remove-from-used-by
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/tagging/tag/id:{tag_id}?~action=remove-from-used-by
x-vmw-doc-operation: remove_from_used_by
Availability
Added in 7.0U2
On This Page
Tag Operations
post
get
get
patch
delete
post
post
