Add or remove tags from selected keys
Owner/Admin/Editor; active workspace/project required. Current membership is checked again after locks. At most 100 distinct versioned keys and 20 distinct tags. Any stale/archived key rolls back the whole operation.
POST /api/v1/workspaces/{workspaceId}/projects/{projectId}/branches/{branchId}/keys/tagsOperation: bulkKeyTags · Download OpenAPI
Access
Section titled “Access”Requires an authenticated Localisync panel session. The API checks current membership and permissions for workspace operations. See authentication and request rules.
sessionCookie
{ "type": "apiKey", "in": "cookie", "name": "__Host-localisync-session", "description": "Production Secure HttpOnly session. Explicit local HTTP uses localisync-session."}Parameters
Section titled “Parameters”| Name | Location | Required | Description |
|---|---|---|---|
workspaceId |
path | Yes | See constraints below. |
projectId |
path | Yes | See constraints below. |
branchId |
path | Yes | See constraints below. |
Origin |
header | Yes | Must equal the configured panel origin. |
X-CSRF-Token |
header | Yes | Session-bound token from auth/me. |
workspaceId
Section titled “workspaceId”{ "type": "string", "format": "uuid"}projectId
Section titled “projectId”{ "type": "string", "format": "uuid"}branchId
Section titled “branchId”{ "type": "string", "format": "uuid"}Origin
Section titled “Origin”{ "type": "string", "format": "uri"}X-CSRF-Token
Section titled “X-CSRF-Token”{ "type": "string"}Request body
Section titled “Request body”Required: Yes.
application/json
Section titled “application/json”Schema reference: BulkTags.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
keys |
Array of object | Yes | minItems: 1; maxItems: 100 |
tagIds |
Array of string | Yes | maxItems: 20 |
mode |
add, remove |
Yes | — |
{ "$ref": "#/components/schemas/BulkTags"}Responses
Section titled “Responses”Successful response. Queued jobs still require polling; completion is explicit.
Content type: application/json
Schema reference: Assigned.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
updated |
Array of string | Yes | — |
{ "$ref": "#/components/schemas/Assigned"}Invalid mapping, options or content.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | Yes | — |
details |
See schema | No | — |
{ "$ref": "#/components/schemas/Error"}Sign in required.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | Yes | — |
details |
See schema | No | — |
{ "$ref": "#/components/schemas/Error"}Current role cannot perform this operation.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | Yes | — |
details |
See schema | No | — |
{ "$ref": "#/components/schemas/Error"}Resource unavailable in this actor and project scope.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | Yes | — |
details |
See schema | No | — |
{ "$ref": "#/components/schemas/Error"}Stale revision, conflicting idempotency key or invalid job state.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | Yes | — |
details |
See schema | No | — |
{ "$ref": "#/components/schemas/Error"}Upload or body limit exceeded.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | Yes | — |
details |
See schema | No | — |
{ "$ref": "#/components/schemas/Error"}Request rate limit exceeded.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | Yes | — |
details |
See schema | No | — |
{ "$ref": "#/components/schemas/Error"}Dependency unavailable; no success is reported.
Content type: application/json
Schema reference: Error.
| Field | Type | Required | Constraints / description |
|---|---|---|---|
error |
string | Yes | — |
message |
string | Yes | — |
requestId |
string | Yes | — |
details |
See schema | No | — |
{ "$ref": "#/components/schemas/Error"}Related guidance
Section titled “Related guidance”Choose whether we remember appearance preferences and use Google Analytics on Localisync and its documentation. Optional storage stays off until you accept.
Read our cookie policy