Remove Tags from a Resource

Before You Begin

🔗 Use the GraphQL Playground to execute the queries in this guide.

➡️ New to GraphQL? Learn how to navigate the Playground with our Playground Basics Guide.

Prerequisites

1. Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
2. Permissions: Ensure your token has manage permission on the target resource (pipe or database).
3. Resource Type: You must specify the type of resource (pipe or database).
4. Resource UUID: You must have the UUID of the pipe or database you want to untag.
5. Tag UUIDs: A list of tag UUIDs that you want to remove.

Step 1: Identify the Resource and Tag UUIDs

The resource and tag UUIDs are not displayed in the UI and must be retrieved through GraphQL queries.

• To learn how to retrieve the resource UUID, visit our Get resource IDs page.
• To learn how to retrieve the tag UUID, refer to our Tags by Category on Resource use case page.

Step 2: Execute the Mutation

mutation {
  removeTagsFromResource(
    input: {
      resourceType: pipe
      resourceUuid: "pipe-uuid-example"
      tagsUuids: ["tag-uuid-1", "tag-uuid-2"]
    }
  ) {
    success
    errors
    tags {
      uuid
      name
    }
  }
}

• resourceType: Must be pipe or database.
• resourceUuid: UUID of the target pipe or database.
• tagsUuids: List of UUIDs of the tags you want to remove.

Response Fields

• success: Returns true if all tags were successfully removed.
• errors: A list of validation errors, if any.
• tags: An array of tags that were successfully removed. Each tag includes:
  • uuid: Unique identifier of the tag.
  • name: Tag name.

Response Example

{
  "data": {
    "removeTagsFromResource": {
      "success": true,
      "errors": [],
      "tags": [
        {
          "uuid": "1e7e7a02-261e-456c-bde3-0ffd6d4b15d4",
          "name": "Tag number 1"
        },
        {
          "uuid": "e642b5f4-4fab-4de7-943f-25e92f5ef256",
          "name": "Tag number 2"
        }
      ]
    }
  }
}

The tags array lists only the tags that were successfully removed. If the UUID is not found, that tag is skipped and an error is added to errors.

Key Notes

• Partial success: If some tag UUIDs are invalid or not found, the mutation still removes the valid ones and returns success: false with the relevant errors listed.
• Permission errors: If your token does not have manage permission on the resource, the request returns a Permission denied error.
• Tag not on resource: Attempting to remove a tag that is not associated with the resource is silently ignored — it does not cause an error.
• Adding tags: To add tags to a resource, use the addTagsToResource mutation.