REST API - update

cis tagging tag: update

Updates an existing tag. To invoke this operation, you need the edit privilege on the tag.

Request:

HTTP request

PATCH https://{server}/rest/com/vmware/cis/tagging/tag/id:{tag_id}

Path Parameters

Name Type Description
Required
tag_id string The identifier of the input tag.

Request Body Structure:

{
    "update_spec"{
        "name""string",
        "description""string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
update_spec update_spec Specification to update the tag.
update_spec.name string The display name of the tag.

Optional. If unset the name will not be modified.

update_spec.description string The description of the tag.

Optional. If unset the description will not be modified.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
400 already_exists if the cis.tagging.tag.update_spec.name provided in the update_spec is the name of an already existing tag in the same category.
400 invalid_argument if any of the input information in the update_spec is invalid.
404 not_found if the tag for the given tag_id does not exist in the system.
403 unauthorized if you do not have the privilege to update the tag.