This API has a deprecated equivalent from v7.0U1.
List Used Tags Tag
Enumerates all tags for which the usedByEntity is part of the TagModel.used-by subscribers set. To invoke this operation, you need the read privilege on the individual tags.
Request
URLURL
https://{api_host}/api/cis/tagging/tag?action=list-used-tags
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
TaggingTagListUsedTagsRequestBody 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 field on which the results will be filtered.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
array of
string
of type application/json
The list of resource identifiers for the tags in the system that are used by usedByEntity. The result will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.
Errors
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
$TaggingTagListUsedTagsRequestBody = Initialize-TaggingTagListUsedTagsRequestBody -UsedByEntity "MyUsedByEntity"
Invoke-ListUsedTags -TaggingTagListUsedTagsRequestBody $TaggingTagListUsedTagsRequestBody
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?action=list-used-tags
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?~action=list-used-tags
x-vmw-doc-operation: list_used_tags
Availability
Added in 7.0U2
On This Page
Tag Operations
post
get
get
patch
delete
post
post
