This API has a deprecated equivalent from v7.0U1.
Update Tag
Updates an existing tag. To invoke this operation, you need the edit privilege on the tag.
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"
Request Body
Request Body
{
"description": "string",
"name": "string"
}
string
description
Optional
The description of the tag. If unset the description will not be modified.
string
name
Optional
The display name of the tag. If unset the name will not be modified.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.already_exists : if the Tag.UpdateSpec.name provided in the updateSpec is the name of an already existing tag in the same category. | com.vmware.vapi.std.errors.invalid_argument : if any of the input information in the updateSpec is invalid.
403
com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to update 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
$TaggingTagUpdateSpec = Initialize-TaggingTagUpdateSpec -Name "MyName" -Description "MyDescription"
Invoke-UpdateTagId -TagId "MyTagId" -TaggingTagUpdateSpec $TaggingTagUpdateSpec
cURL Command
curl -X PATCH -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"description":"string","name":"string"}' 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: patch
x-vmw-doc-deprecated-path: /rest/com/vmware/cis/tagging/tag/id:{tag_id}
x-vmw-doc-operation: update
Availability
Added in 7.0U2
On This Page
Tag Operations
get
post
get
patch
delete
post
post
