Get Tag
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
Fetches the tag information for the given tag identifier. To invoke this operation, you need the read privilege on the tag in order to view the tag info.
Request
URLURL
https://{api_host}/rest/com/vmware/cis/tagging/tag/id:{tag_id}
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 |
Response
Response
Response BodyResponse Body
200 OK returns
TaggingTagGetResponseBody
of type application/json
The TagModel that corresponds to tagId.
{
"value": {
"category_id": "string",
"description": "string",
"id": "string",
"name": "string",
"used_by": [
"string"
]
}
}| Property Name | Type | Description |
|---|---|---|
| value | TaggingTagModel |
The TagModel that corresponds to tagId. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/com/vmware/cis/tagging/tag/id:{tag_id}
Errors
| Code | Returns | Description |
|---|---|---|
| default | ErrorRest | Not available |
| 401 | ErrorRest | com.vmware.vapi.std.errors.unauthorized : if the user does not have the privilege to read the tag. |
| 404 | ErrorRest | com.vmware.vapi.std.errors.not_found : if the tag for the given tagId does not exist in the system. |
Tag Operations
get
post
get
patch
delete
post
post
