Update Tag
Updates an existing tag. To invoke this operation, you need the edit privilege on the tag.
Request
URLURL
Path Parameters
Path Parameters
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 session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
{
"description": "string",
"name": "string"
}
The description of the tag. If unset the description will not be modified.
The display name of the tag. If unset the name will not be modified.
Authentication
Errors
Errors
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.
com.vmware.vapi.std.errors.unauthorized : if you do not have the privilege to update the tag.
com.vmware.vapi.std.errors.not_found : if the tag for the given tagId does not exist in the system.
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
cURL Command
Vendor Extensions
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