getAllTags

Retrieve all tags in the system including both user-defined and system (ox) tags.

Examples

GraphQL

query GetAllTags($input: GetTagsInput) {
  getAllTags(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": {
    "filters": {
      "tagType": ["simple"],
      "tagId": ["ox_tag_1"]
    }
  }
}

cURL

curl -X POST \
https://api.cloud.ox.security/api/apollo-gateway \
-H 'Content-Type: application/json' \
-H 'Authorization: YOUR_API_TOKEN' \
-d '{
 "query": "query GetAllTags($input: GetTagsInput) { getAllTags(input: $input) { tags { tagId name displayName tagType createdBy createdAt updatedAt tagCategory deploymentModel purpose email } } }",
 "variables": {
    "input": {
      "filters": {
        "tagType": ["simple"],
        "tagId": ["ox_tag_1"]
      }
    }
  }
}'

Node.js

const query = 'query GetAllTags($input: GetTagsInput) { getAllTags(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: {
        filters: {
          tagType: ["simple"],
          tagId: ["ox_tag_1"]
        }
      }
    }
  })
})
.then(response => response.json())
.then(result => console.log(JSON.stringify(result, null, 2)))
.catch(error => console.error('Error:', error));

Python

import requests

query = 'query GetAllTags($input: GetTagsInput) { getAllTags(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": {
        "filters": {
          "tagType": ["simple"],
          "tagId": ["ox_tag_1"]
        }
      }
    }
  }
)

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 getAllTags query.

Argument	Description	Supported fields
input GetTagsInput	Input parameters for filtering tags by type, ID, and other criteria	filters GetTagsFilters

Fields

Return type: GetAllTagsResponse!

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

Field	Description	Supported fields
tags [TagObject!]!	Array of tags matching the query criteria	tagId String! name String! displayName String! tagType OxTagType! createdBy String! createdAt DateTime updatedAt DateTime tagCategory String deploymentModel String purpose String email String