REST API - get

cis tagging tag: get

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:

HTTP request

GET 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.

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "category_id""obj-103",
        "name""string",
        "description""string",
        "id""obj-103",
        "used_by"[
            "string",
            "string"
        ]
    }
}

Response Type:

Name Type Description
bold = required
value tag_model The cis.tagging.tag_model that corresponds to tag_id.
value.id string 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.

value.category_id string 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.

value.name string The display name of the tag.

value.description string The description of the tag.

value.used_by string[] 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:

HTTP Status Code Type Description
404 not_found if the tag for the given tag_id does not exist in the system.
403 unauthorized if the user does not have the privilege to read the tag.