REST API - attach

cis tagging tag association: attach

Attaches the given tag to the input object. The tag needs to meet the cardinality (cis.tagging.category_model.cardinality) and associability (cis.tagging.category_model.associable_types) criteria in order to be eligible for attachment. If the tag is already attached to the object, then this operation is a no-op and an error will not be thrown. To invoke this operation, you need the attach tag privilege on the tag and the read privilege on the object.

Request:

HTTP request

POST https://{server}/rest/com/vmware/cis/tagging/tag-association/id:{tag_id}?~action=attach

Path Parameters

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

Request Body Structure:

{
    "object_id"{
        "id""obj-103",
        "type""string"
    }
}

Request Body Parameters:

Name Type Description
bold = required
object_id dynamic_ID The identifier of the input object.
object_id.type string The type of resource being identified (for example com.acme.Person).

Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types.

object_id.id string The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type.

When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
404 not_found if the tag for the given tag_id does not exist in the system.
400 invalid_argument if the input tag is not eligible to be attached to this object or if the object_id is not valid.
403 unauthorized if you do not have the privilege to attach the tag or do not have the privilege to read the object.
401 unauthenticated if the user can not be authenticated.