List Used Tags Tag
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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}/rest/com/vmware/cis/tagging/tag?~action=list-used-tags
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 TaggingTagListUsedTagsRequestBody
of type application/json
(required)
{
"used_by_entity": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | used_by_entity | string |
The field on which the results will be filtered. |
Response
Response
Response BodyResponse Body
200 OK returns
TaggingTagListUsedTagsResponseBody
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.
{
"value": [
"string"
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of string |
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. |
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?~action=list-used-tags
Errors
| Code | Returns | Description |
|---|---|---|
| default | ErrorRest | Not available |
On This Page
Tag Operations
get
post
get
patch
delete
post
post
