Securonix Tags API

openapi: 3.2.0
info:
  title: ThreatQ Tags API
  description: "&copy; 2025<br/><br/><b>The API doc you are viewing is a BETA version that provides an early look at ThreatQ’s new API documentation format. At the moment, it does not cover the entire application program interface. Additional API resources, including the current standard format as well as previous versions, are available on the ThreatQ Help Center.</b><br/><br/>Last Updated: 07/11/2025\n## Introduction\n\nThe ThreatQ API is built on REST principles and uses JSON as a data interchange format.\n\n<script type=\"text/javascript\" src=\"ga.js\"></script>\n\n\n### Base URI\n\nAll URIs referenced in this document use the following base: https://**hostname**/api/, where **hostname** is replaced with the hostname or ip address of your ThreatQ instance.\n\n\n### Request Format\n\nThe ThreatQ API supports the following HTTP verbs:\n\n| Verb          | Description                        |\n| :-------------| :----------------------------------|\n| GET           | GET requests retrieve resources.   |\n| POST          | POST requests create resources.    |\n| PUT           | PUT requests update resources.     |\n| DELETE        | DELETE requests delete resources.  |\n\n\n### Response Format\n\nAll responses are returned in JSON. The response is wrapped in a top level data envelope which is an object or array depending on whether a single item or a collection is returned. If a single item is returned, the data field will be an object. If a collection is returned, the field will be an array.\n\n\n### Response Codes\n\nThe ThreatQ API uses HTTP status codes to indicate the status of your request.\n\n| Code          | Description                                                                           |\n| :-------------| :-------------------------------------------------------------------------------------|\n| 200           |  Object was retrieved successfully.                                                   |\n| 201           |  Object was created successfully.                                                     |\n| 204           |  Object(s) were successfully deleted.                                                 |\n| 400           |  Validation failed (usually as the result of an incorrect request)                    |\n| 401           |  Access denied (authorization access token in the header was incorrect / out of date) |\n| 403           |  Access forbidden (usually as the result of a bad request)                            |\n| 404           |  Object not found                                                                     |\n\n<hr />\n\n### Authentication\n\nThreatQ uses OAuth 2.0 to authenticate end users. You must have a ThreatQ user account to retrieve an API token. The API token is required for all API requests. The token does time out; therefore, you must periodically refresh the token.\n\n\n#### Authorization workflow\n\n1. Run a GET request to retrieve your client ID using the following format:\n\thttps://**hostname**/assets/js/config.js\n2. Run a POST/token request to retrieve your authorization access token. See POST/token in the Authorization section of this reference for the correct format.\n\n    Include the following parameters:\n\t  * grant_type (password)\n\t  * client-id (retrieved in step 1)\n\n    **Example:** https://**hostname**/api/token?grant_type=password&client_id=ab20a55dd9ac779246210d7102a45ee37\n\n    In the request body, include your ThreatQ credentials:\n\t  * email\n\t  * password\n\n3. Enter the access token as the authorization key in the header for all subsequent api requests."
  license:
    name: null
    url: null
  version: 1.0.0
  x-logo:
    url: null
    backgroundColor: null
    altText: ThreatQuotient
servers:
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/securonix-b7a/ThreatQ/1.0.0
- url: https://threatq.com/api
  description: ThreatQ Server
security:
- BearerAuth: []
tags:
- name: Tags
paths:
  /tags:
    get:
      tags:
      - Tags
      summary: List Tags
      operationId: eeb07c6c23256852e6319158d6ad1eff
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/TagWith'
      - $ref: '#/components/parameters/TagWithObjects'
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/TagWithRelationships'
                  type: object
                - $ref: '#/components/schemas/TotalResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-visibility: public
  /tags/{tag_id}{?with}:
    get:
      tags:
      - Tags
      summary: Get a Single Tag
      parameters:
      - $ref: '#/components/parameters/TagId'
      - $ref: '#/components/parameters/TagWith'
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/TagWithRelationships'
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-visibility: public
components:
  responses:
    Unauthorized:
      description: Unauthorized
    NotFound:
      description: Object Not Found
  schemas:
    IndicatorTag:
      allOf:
      - properties:
          pivot:
            $ref: '#/components/schemas/TagPivot'
        type: object
      - $ref: '#/components/schemas/Indicator'
    TagFillable:
      properties:
        name:
          description: Tag Name
          type: string
          example: Ominous
      type: object
    TouchedAtTimestamp:
      properties:
        touched_at:
          description: Update Date for Object Context (Attributes, Comments, Sources, Relationships)
          type: string
          example: '2021-11-13 15:28:17'
      type: object
    Adversary:
      allOf:
      - properties:
          id:
            description: Adversary ID
            type: integer
            example: 54
        type: object
      - $ref: '#/components/schemas/AdversaryFillable'
      - $ref: '#/components/schemas/ThreatQTimestamps'
      - $ref: '#/components/schemas/TouchedAtTimestamp'
    TagWithRelationships:
      allOf:
      - properties:
          adversaries:
            type: array
            items:
              $ref: '#/components/schemas/AdversaryTag'
          indicators:
            type: array
            items:
              $ref: '#/components/schemas/IndicatorTag'
          course_of_action:
            type: array
            items:
              $ref: '#/components/schemas/CourseOfActionTag'
        type: object
      - $ref: '#/components/schemas/Tag'
    AdversaryFillable:
      properties:
        name:
          description: Adversary Name
          type: string
          example: Sad Panda
      type: object
    Indicator:
      allOf:
      - properties:
          id:
            description: Indicator ID
            type: integer
            example: 54
        type: object
      - properties:
          hash:
            description: Indicator Hash
            type: string
            example: 4aba5ab07a3bda558d5d725a09d93ba6
          last_detected_at:
            description: Date the Indicator was last encountered
            type: string
            example: '2020-02-28 13:42:51'
          expires_at:
            description: Date the Indicator will expire
            type: string
            example: '2020-04-01 03:17:23'
          expired_at:
            description: Date the Indicator expired
            type: string
            example: null
          expired_needs_calc:
            description: Determines whether the Indicator's expiration date needs updating
            type: string
            example: N
          expires_calculated_at:
            description: Date the Indicator's expiration date was calculated
            type: string
            example: '2020-02-28 18:36:24'
        type: object
      - $ref: '#/components/schemas/IndicatorFillable'
      - $ref: '#/components/schemas/ThreatQTimestamps'
      - $ref: '#/components/schemas/TouchedAtTimestamp'
    CourseOfAction:
      allOf:
      - properties:
          id:
            description: Course of Action ID
            type: integer
            example: 6274
        type: object
      - $ref: '#/components/schemas/CourseOfActionFillable'
      - $ref: '#/components/schemas/ThreatQTimestamps'
      - $ref: '#/components/schemas/TouchedAtTimestamp'
    AdversaryTag:
      allOf:
      - properties:
          pivot:
            $ref: '#/components/schemas/TagPivot'
        type: object
      - $ref: '#/components/schemas/Adversary'
    TagPivot:
      allOf:
      - properties:
          tag_id:
            description: Tag ID
            type: integer
            example: 1
          object_id:
            description: Object ID
            type: integer
            example: 54
        type: object
      - $ref: '#/components/schemas/ThreatQTimestamps'
    IndicatorFillable:
      properties:
        type_id:
          description: Indicator Type ID
          type: integer
          example: 11
        status_id:
          description: Indicator Status ID
          type: integer
          example: 2
        class:
          description: 'Indicator Class - Options include: host, network'
          type: string
          example: network
        value:
          description: Indicator Value
          type: string
          example: www.danger-doom.com
        description:
          description: Indicator Description
          type: string
          example: Website encountered during incident investigation.
      type: object
    Tag:
      allOf:
      - properties:
          id:
            description: Tag ID
            type: integer
            example: 81
        type: object
      - $ref: '#/components/schemas/TagFillable'
    TotalResponse:
      properties:
        total:
          description: Total Number of Objects Processed
          type: integer
          example: 1
      type: object
    ThreatQTimestamps:
      properties:
        created_at:
          description: Creation Date
          type: string
          example: '2021-07-29 13:58:03'
        updated_at:
          description: Update Date
          type: string
          example: '2022-04-12 08:32:16'
      type: object
    CourseOfActionTag:
      allOf:
      - properties:
          pivot:
            $ref: '#/components/schemas/TagPivot'
        type: object
      - $ref: '#/components/schemas/CourseOfAction'
    CourseOfActionFillable:
      properties:
        value:
          description: Course of Action Value
          type: string
          example: TXXXX - Account Discovery Mitigation
        description:
          description: Description for the Course of Action
          type: string
          example: Prevent administrator accounts from...
      type: object
  parameters:
    Limit:
      name: limit
      in: query
      description: <br>The number of objects included in the response.
      required: false
      style: form
      explode: false
      schema:
        type: integer
        example: 10
    TagWithObjects:
      name: with_DUPLICATES_PREVIOUS_NAME
      in: query
      description: <br>Related Object IDs (as opposed to full Object models) that can be included in the response.
      required: false
      style: form
      explode: false
      schema:
        type: string
        example: objects
    TagWith:
      name: with
      in: query
      description: "<br>Related Object models that can be included in the response.<br><br>Options include: adversaries, \nattachments, attack_pattern, campaign, course_of_action, events, exploit_target, identity, incident, indicators,\nintrusion_set, malware, recipient, report, signatures, tool, and ttp."
      required: false
      style: form
      explode: false
      schema:
        type: string
        example: adversaries,indicators,course_of_action
    Offset:
      name: offset
      in: query
      description: <br>The number of result set records that should be ignored.
      required: false
      style: form
      explode: false
      schema:
        type: integer
        example: 50
    Sort:
      name: sort
      in: query
      description: "<br>Designate the field(s) you want to use to sort the retrieved list. You can prepend each field \n        with a minus sign (-) to reverse the sorting order. This string can be a list of comma-separated values."
      required: false
      style: form
      explode: false
      schema:
        type: string
        example: id,created_at
    TagId:
      name: tag_id
      in: path
      description: Tag ID
      required: true
      schema:
        type: integer
  securitySchemes:
    BearerAuth:
      type: http
      description: "Once authorized, all subsequent requests must include an `Authorization` header\n with the granted `access_token`. See the OAuth2 Authentication path for more information on how to authorize a User.<br><br>\n Example Header: `Authorization: Bearer <access_token>`"
      name: Authorization
      in: header
      bearerFormat: Bearer `<access_token>`
      scheme: bearer