Update Tag

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

Authentication: Use a Service Account token (Personal Access Tokens are deprecated).
Permissions: Ensure your token has super admin or admin permission on the organization scope.

Step 1. Find the Tag UUID

Find the tag uuid.

You can retrieve it by running the TagsByCategory query.

Step 2: Execute the Mutation

Once you have retrieved the category tag uuid, use it to run the mutation.

mutation updateTag($uuid: ID!, $name: String, $description: String, $tagCategoryUuid: ID, $visibleToMembers: Boolean) {
  updateTag(input: { uuid: $uuid, name: $name, description: $description, tagCategoryUuid: $tagCategoryUuid, visibleToMembers: $visibleToMembers }) {
    name
    uuid
    description
    createdBy {
      uuid
    }
    taggedPipes {
      pipes {
        edges {
          node {
            name
          }
        }
      }
    }
    taggedResources {
      total
    }
    tagCategory {
      name
      uuid
    }
  }
}

Response Fields

uuid: UUID of the tag.
name: Name of the tag.
visibleToMembers: If the tag is visible to members
taggedPipes: All the pipes tagged with this tag.
taggedDatabases: All the databases tagged with this tag.

Example Response

{
  "data": {
    "updateTag": {
      "uuid": "uuid",
      "name": "tag",
      "visibleToMembers": false,
      "description": null,
      "taggedPipes": {
        "pipes": {
          "edges": []
        }
      }
    }
  }
}