This API has a deprecated equivalent from v7.0U1.
Get Tag
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}/api/cis/tagging/tag/{tag_id}
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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
TaggingTagModel
of type application/json
The TagModel that corresponds to tagId.
{
"category_id": "string",
"description": "string",
"id": "string",
"name": "string",
"used_by": [
"string"
]
}
string
category_id
Required
The identifier of the parent category in which this tag will be created. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Category. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Category.
string
description
Required
The description of the tag.
string
id
Required
The unique identifier of the tag. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.tagging.Tag. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.tagging.Tag.
string
name
Required
The display name of the tag.
array of
string
used_by
Required
The set of users that can use this tag. To add users to this, you need to have the edit privilege on the tag. Similarly, to unsubscribe from this tag, you need the edit privilege on the tag. You should not modify other users subscription from this set.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have the privilege to read the tag.
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
Invoke-GetTagId -TagId "MyTagId"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/cis/tagging/tag/{tag_id}
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/tagging/tag/id:{tag_id}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Tag Operations
get
post
get
patch
delete
post
post
