addTags

Create new tags in the system with optional metadata.

Examples

GraphQL

mutation AddTags($input: AddTagInput!) {
  addTags(input: $input) {
    tags {
      tagId
      name
      displayName
      tagType
      createdBy
      createdAt
      updatedAt
      tagCategory
      deploymentModel
      purpose
      email
    }
  }
}

Variables

This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.

{
  "input": {
    "tagsInput": [
      {
        "name": "Custom Tag",
        "displayName": "Custom Tag"
      }
    ]
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "mutation AddTags($input: AddTagInput!) { addTags(input: $input) { tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } } }",
 "variables": {
    "input": {
      "tagsInput": [
        {
          "name": "Custom Tag",
          "displayName": "Custom Tag"
        }
      ]
    }
  }
}'

Node.js

const query = 'mutation AddTags($input: AddTagInput!) { addTags(input: $input) { tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } } }';

fetch("https://api.cloud.ox.security/api/apollo-gateway", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  body: JSON.stringify({
    query: query,
    // This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    variables: {
      input: {
        tagsInput: [
          {
            name: "Custom Tag",
            displayName: "Custom Tag"
          }
        ]
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'mutation AddTags($input: AddTagInput!) { addTags(input: $input) { tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } } }'

response = requests.post(
  "https://api.cloud.ox.security/api/apollo-gateway",
  headers={
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_TOKEN"
  },
  json={
    "query": query,
    # This is an example input showing all available input fields. Only fields marked as required in the schema are mandatory.
    "variables": {
      "input": {
        "tagsInput": [
          {
            "name": "Custom Tag",
            "displayName": "Custom Tag"
          }
        ]
      }
    }
  }
)

if response.status_code == 200:
    result = response.json()
    print(result)
else:
    print(f"Error: {response.status_code}")
    print(response.text)

Arguments

You can use the following argument(s) to customize your addTags mutation.

Argument	Description	Supported fields
input AddTagInput! required	Input containing array of tags to be created with their properties	tagsInput [TagDTO!]!

Fields

Return type: AddTagRes

You can use the following field(s) to specify what information your addTags mutation will return. Please note that some fields may have their own subfields.

Field	Description	Supported fields
tags [TagObject!]!	Array of newly created tag objects	tagId String! name String! displayName String! tagType OxTagType! createdBy String! createdAt DateTime updatedAt DateTime tagCategory String deploymentModel String purpose String email String