REST API - list

cis tagging tag host: list

Returns information about the tags that can be attached to virtual machines. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

GET https://{server}/rest/cis/tagging/tag/host
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value"[
        {
            "category_name""string",
            "name""string",
            "description""string",
            "tag""obj-103"
        },
        {
            "category_name""string",
            "name""string",
            "description""string",
            "tag""obj-103"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value summary[] The list of tags that can be attached to hosts.
value[].tag string Identifier of the tag. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

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:HostSystem. 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:HostSystem.

value[].name string Name of the tag. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

value[].description string Description of the tag. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

value[].category_name string Name of the category of which this tag is part. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Errors:

None