Create, Add, Remove Tag

Create, apply, and remove Veza tags

New in 2022.3.2: Tagging operations are now available as part of the v1/ API set.

Methods

Create Veza Tag

Post {VezaURL}/api/v1/graph/tags

Define a new tag that can be applied to any discovered entity, as a key:value pair. The tag value is optional.

{
    "tag": {
        "key": "note",
        "value": "tags_can_be_used_as_searchable_properties,_or_add_extended_notes"
    }
}

Parameter	In	Description
tag	body	Contains a single key:value pair
key	body	Max length 255 characters (alphanumeric and _)
value	body	Max length 4096 characters (alphanumeric, _ and ,).

A successful response will be empty ({}).

Add Veza Tag

Post {VezaURL}/api/v1/graph/nodes/tags

Apply one or more tags to an entity by providing an entity ID. A new Tag will be created if one doesn't already exist.

{
    "node_id": "080551dc-aef9-46e4-9654-a6362d7baeee",
    "tags": [
        {
            "key": "PII",
            "value": "GRPC"
        }
        {
            "key": "environment",
            "value": "production"
        }
    ]
}

Parameter	In	Description
node_id	body	Veza entity ID
tags	body	Array of tags to add

To retrieve an entity ID, you can use the Query Builder API, or browse the Identity Data Entities catalog.

Remove Veza Tag

Post {VezaURL}/api/v1/graph/nodes/tags:remove

Remove a tag from an entity.

Parameter	In	Description
node_id	body	ID of the entity to modify
tag_key	body	Must contain a single tag to remove

{
	"node_id": "080551dc-aef9-46e4-9654-a6362d7baeee",
	"tag_key": "environment"
}

A successful response will be empty ({}).