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, obtained by first calling Create Session API
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.
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
No error details were provided in the OpenAPI specification.
Availability
Added in 7.0U2
On This Page
Tag Operations
get
post
get
patch
delete
post
post
