API v1 ReferenceShared Tags

Applies a batch tag operation to all entities of the specified type in the workspace.

<Check title="Required Permissions" icon="key">The user must be an admin or have `workspace-manage-config:write` permissions.</Check>

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

operationstringRequired

Request

This endpoint expects an object.
tagNameslist of strings or nullOptional

The tag names used by delete and update-color operations.

sourceTagNameslist of strings or nullOptional
The source tag names used by merge operations.
targetTagobjectOptional
colorstring or nullOptional

The color used by update-color operations.

Response

Multi-Status

okobject

A collection of requested tag names that share the same batch-operation status.

notFoundobject

A collection of requested tag names that share the same batch-operation status.

badRequestobject

A collection of requested tag names that share the same batch-operation status.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error