Cyware

Cyware Tag Groups API

Tag Groups

GitHub OpenAPI

Documentation

📖
Documentation
https://techdocs.cyware.com/ctix/en/product-documentation.html
📖
APIReference
https://ctixapiv3.cyware.com/
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/cyware/refs/heads/main/authentication/cyware-authentication.yml
📖
Documentation
https://techdocs.cyware.com/co/en/product-documentation.html
📖
APIReference
https://orchestrateapi.cyware.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/cyware/refs/heads/main/openapi/cyware-tag-groups-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/cyware/refs/heads/main/conventions/cyware-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/cyware/refs/heads/main/errors/cyware-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/cyware/refs/heads/main/data-model/cyware-data-model.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/cyware/refs/heads/main/llms/cyware-intel-exchange-api-llms.txt
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/cyware/refs/heads/main/asyncapi/cyware-orchestrate-webhooks.yml
🔗
LLMsTxt
https://raw.githubusercontent.com/api-evangelist/cyware/refs/heads/main/llms/cyware-orchestrate-api-llms.txt

OpenAPI Specification

cyware-tag-groups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Cyware Intel Exchange (CTIX) v3 Open Tag Groups API
  version: 3.6.2
  description: 'Public Open API for Cyware Intel Exchange (formerly CTIX), Cyware''s threat intelligence platform for the ingestion, enrichment, analysis, correlation and bi-directional sharing of structured and unstructured threat intelligence using STIX 2.x and TAXII 2.x. The API covers threat data objects, intel creation and import, enrichment, rules, tags, watchlists, threat bulletins, threat investigation, dashboards, reports, PIR management, MITRE ATT&CK navigator data and platform administration.


    Intel Exchange is deployed per tenant, so the server host is the customer''s own Intel Exchange deployment; the API is mounted under `/ctixapi`.


    This document was assembled by API Evangelist from Cyware''s own published, structured API reference documents at https://ctixapiv3.cyware.com — each endpoint page is served as machine-readable markdown carrying a JSON endpoint model, and every page is indexed from that host''s llms.txt. Paths, methods, parameters, descriptions, enumerations and examples are reproduced from those documents; nothing is invented.'
  contact:
    name: Cyware
    url: https://www.cyware.com/contact-us
  termsOfService: https://www.cyware.com/legal/terms-of-use
  x-apievangelist-source: https://ctixapiv3.cyware.com/llms.txt
  x-apievangelist-method: generated
servers:
- url: https://{ctix_host}/ctixapi
  description: Tenant Intel Exchange deployment. Replace {ctix_host} with your own Intel Exchange host. Cyware documents the base URL form https://sample.domain.com/ctixapi in its authentication guide and uses https://demo.cyware.com/ctix/ as the example host in the config of its open-source MCP server.
  variables:
    ctix_host:
      default: demo.cyware.com
security:
- ctixOpenApiSignature: []
tags:
- name: Tag Groups
  description: Tag Groups
paths:
  /ingestion/tags/bulk-actions/:
    post:
      operationId: copy
      summary: Disable Bulk Tag Group
      tags:
      - Tag Groups
      description: Disable multiple tag groups in a single request to deactivate them from use.
      externalDocs:
        description: Cyware Intel Exchange API reference
        url: https://ctixapiv3.cyware.com/tag-groups/bulk-action/copy
      parameters:
      - name: component
        in: query
        required: false
        schema:
          type: string
          description: Pass `tags` to include all the tags, irrespective of the status.
          examples:
          - tags
        description: Pass `tags` to include all the tags, irrespective of the status.
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                ids:
                  type: array
                  description: Pass the list of unique tag group IDs on which the bulk action must be performed.
                  items:
                    type: string
                    description: This is an example Tag group ID.
                    examples:
                    - 1bcbd3e4-0e45-48a0-b87f-775051c7b363
                action:
                  type: string
                  description: Pass the action to apply to the specified tag groups.
                  enum:
                  - enabled
                  - disabled
                  examples:
                  - disabled
            example:
              ids:
              - 1bcbd3e4-0e45-48a0-b87f-775051c7b363
              action: disabled
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    description: Returns the response details of the bulk action request.
                    properties:
                      details:
                        type: string
                        description: Returns a message confirming that the action was successfully executed.
                        examples:
                        - Action Successfully Executed
              example:
                result:
                  details: Action Successfully Executed
      x-alternate-documents:
      - title: Bulk Enable/Disable Tags
        operationId: bulkEnableDisableTags
        url: https://ctixapiv3.cyware.com/administration/tag-management/bulk-enable-disable-tags
      - title: Create Tags
        operationId: createTags
        url: https://ctixapiv3.cyware.com/administration/tag-management/create-tags
      - title: Enable Bulk Tag Group
        operationId: enableBulkTagGroup
        url: https://ctixapiv3.cyware.com/tag-groups/bulk-action/enable-bulk-tag-group
      - title: Create Tag Group
        operationId: getListTagGroupsCopy
        url: https://ctixapiv3.cyware.com/tag-groups/get-list-tag-groups-copy
  /ingestion/tags/{tag_id}/:
    put:
      operationId: listTagsInTagGroupCopy
      summary: Update Tag Group
      tags:
      - Tag Groups
      description: Update all fields of an existing tag group with new values.
      externalDocs:
        description: Cyware Intel Exchange API reference
        url: https://ctixapiv3.cyware.com/tag-groups/list-tags-in-tag-group-copy
      parameters:
      - name: tag_id
        in: path
        required: true
        schema:
          type: string
          description: Pass the ID of a tag group to retrieve the details.
        description: Pass the ID of a tag group to retrieve the details.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Pass the name of the tag group.
                  examples:
                  - AS Group
                description:
                  type: string
                  description: Pass the description of the tag group.
                  examples:
                  - Ransomware AS Check
                tag_type:
                  type: object
                  description: Pass the details of the tag type.
                  enum:
                  - system
                  - source
                  - user
                  - privileged
                  - group
                  properties:
                    id:
                      type: string
                      description: Pass the tag type ID.
                      examples:
                      - group
                    name:
                      type: string
                      description: Pass the tag type name.
                      examples:
                      - Group
                associated_tags:
                  type: array
                  description: Pass a list of associated tags.
                  items:
                    type: object
                    properties:
                      colour_code:
                        type: string
                        description: Pass the hex color code defined for the tag.
                        examples:
                        - '#45505E'
                      icon:
                        type: string
                        description: Pass the icon of the tag.
                      id:
                        type: string
                        description: Pass the unique ID of the tag.
                        examples:
                        - 96031982-fe29-462b-9ab6-5e278a62e281
                      name:
                        type: string
                        description: Pass the name of the tag.
                        examples:
                        - AS57333
                      tag_type:
                        type: string
                        description: Pass the details of the tag type.
                        enum:
                        - system
                        - user
                        - source
                        - privileged
                        - group
                        examples:
                        - source
                      theme:
                        type: string
                        description: Pass the theme associated with the tag.
                        examples:
                        - neutral
                is_active:
                  type: boolean
                  description: Pass true if the tag group is active in Intel Exchange.
                  examples:
                  - true
              required:
              - name
              - tag_type
              - associated_tags
            example:
              name: AS Group
              description: Ransomware AS Check
              tag_type:
                id: group
                name: Group
              associated_tags:
              - colour_code: '#45505E'
                icon: null
                id: 96031982-fe29-462b-9ab6-5e278a62e281
                name: AS57333
                tag_type: source
                theme: neutral
              is_active: true
      responses:
        '200':
          description: HTTP 200 response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: Returns the unique ID of the tag group.
                    examples:
                    - 8b523365-34c3-49d6-890a-e8015b927d45
                  name:
                    type: string
                    description: Returns the name of the tag group.
                    examples:
                    - AS Group
                  colour_code:
                    type: string
                    description: Returns the hex color code defined for the tag group.
                    examples:
                    - '#DCDEE4'
                  created:
                    type: number
                    description: Returns the created date and time of the tag group in epoch format.
                    examples:
                    - 1760440627
                  created_by:
                    type: string
                    description: Returns the user details who created the tag group.
                    examples:
                    - 70f3d3ee-b7bc-4ceb-849e-16db0de5278b
                  modified_by:
                    type: string
                    description: Returns the details of the user who modified the tag group details.
                    examples:
                    - 70f3d3ee-b7bc-4ceb-849e-16db0de5278b
                  modified:
                    type: number
                    description: Returns the modified date and time of a tag group in epoch format.
                    examples:
                    - 1760511178
                  tag_type:
                    type: object
                    description: Returns the details of the tag type.
                    properties:
                      id:
                        type: string
                        description: Returns the tag type ID.
                        examples:
                        - group
                      name:
                        type: string
                        description: Returns the tag type name.
                        examples:
                        - Group
                  is_active:
                    type: boolean
                    description: Returns true if the tag group is active in Intel Exchange.
                    examples:
                    - true
                  groups:
                    type: array
                    description: Returns a list of groups associated with this tag group.
                    items: {}
                  description:
                    type: string
                    description: Returns the description of the tag group.
                    examples:
                    - Ransomware AS Check
                  theme:
                    type: string
                    description: Returns the theme associated with the tag group.
                    examples:
                    - white
                  icon:
                    type: string
                    description: Returns the icon of the tag group.
                    examples:
                    - cyicon-tags-solid
                  associated_tags_count:
                    type: number
                    description: Returns the number of tags associated with this tag group.
                    examples:
                    - 1
                  associated_tags:
                    type: array
                    description: Returns a list of associated tags.
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Returns the unique ID of the tag.
                          examples:
                          - 96031982-fe29-462b-9ab6-5e278a62e281
                        name:
                          type: string
                          description: Returns the name of the tag.
                          examples:
                          - ASN/AS57333
                        tag_type:
                          type: string
                          description: Returns the details of the tag type.
                          examples:
                          - source
                        colour_code:
                          type: string
                          description: Returns the hex color code defined for the tag.
                          examples:
                          - '#45505E'
                        theme:
                          type: string
                          description: Returns the theme associated with the tag.
                          examples:
                          - neutral
                        icon:
                          type: string
                          description: Returns the icon of the tag.
              example:
                id: 8b523365-34c3-49d6-890a-e8015b927d45
                name: AS Group
                colour_code: '#DCDEE4'
                created: 1760440627
                created_by: 70f3d3ee-b7bc-4ceb-849e-16db0de5278b
                modified_by: 70f3d3ee-b7bc-4ceb-849e-16db0de5278b
                modified: 1760511178
                tag_type:
                  id: group
                  name: Group
                is_active: true
                groups: []
                description: Ransomware AS Check
                theme: white
                icon: cyicon-tags-solid
                associated_tags_count: 1
                associated_tags:
                - id: 96031982-fe29-462b-9ab6-5e278a62e281
                  name: ASN/AS57333
                  tag_type: source
                  colour_code: '#45505E'
                  theme: neutral
                  icon: null
      x-alternate-documents:
      - title: Update Tag
        operationId: updateTag
        url: https://ctixapiv3.cyware.com/tags/update-tag
components:
  securitySchemes:
    ctixOpenApiSignature:
      type: apiKey
      in: query
      name: AccessID
      description: 'Intel Exchange Open API credentials. Every request carries three query parameters: AccessID (the access ID of the Open API credential), Expires (an epoch timestamp, at most 30 seconds in the future) and Signature - an HMAC-SHA1 of "AccessID\nExpires" keyed with the secret key, Base64 encoded and then URL encoded. See https://ctixapiv3.cyware.com/authentication'
externalDocs:
  description: Cyware Intel Exchange API Reference
  url: https://ctixapiv3.cyware.com/