This API has a deprecated equivalent from v7.0U1.
List Tags For Category Tag
Enumerates all tags for the given category. To invoke this operation, you need the read privilege on the given category and the individual tags in that category.
Request
URLURL
https://{api_host}/api/cis/tagging/tag?action=list-tags-for-category
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
TaggingTagListTagsForCategoryRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"category_id": "string"
}
string
category_id
Required
The identifier of the input category. The parameter must be an identifier for the resource type: com.vmware.cis.tagging.Category.
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 given input category. The result will contain identifiers for the resource type: com.vmware.cis.tagging.Tag.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to read the category.
404
com.vmware.vapi.std.errors.not_found : if the category for the given categoryId 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
$TaggingTagListTagsForCategoryRequestBody = Initialize-TaggingTagListTagsForCategoryRequestBody -CategoryId "MyCategoryId"
Invoke-ListTagsForCategory -TaggingTagListTagsForCategoryRequestBody $TaggingTagListTagsForCategoryRequestBody
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"category_id":"string"}' https://{api_host}/api/cis/tagging/tag?action=list-tags-for-category
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/id:{category_id}?~action=list-tags-for-category
x-vmw-doc-operation: list_tags_for_category
Availability
Added in 7.0U2
On This Page
Tag Operations
get
post
get
patch
delete
post
post
