Securonix Connectors API

openapi: 3.2.0
info:
  title: ThreatQ Connectors API
  description: '© 2025


    The API doc you are viewing is a BETA version that provides an early look at ThreatQ’s new API documentation format.'
  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: Connectors
paths:
  /connectors:
    post:
      tags:
      - Connectors
      summary: Create a Connector
      description: 'There are two request options for creating a Connector:


        (1) A JSON representation of the Connector definition

        in the request body


        (2) Resumable file upload parameters in the request body or as query path parameters for a YAML

        Connector definition file'
      operationId: d97edc7a4bcd0ff52666d9ae79afda35
      parameters:
      - $ref: '#/components/parameters/ResumableChunkNumber'
      - $ref: '#/components/parameters/ResumableChunkSize'
      - $ref: '#/components/parameters/ResumableCurrentChunkSize'
      - $ref: '#/components/parameters/ResumableTotalSize'
      - $ref: '#/components/parameters/ResumableType'
      - $ref: '#/components/parameters/ResumableIdentifier'
      - $ref: '#/components/parameters/ResumableFilename'
      - $ref: '#/components/parameters/ResumableRelativePath'
      - $ref: '#/components/parameters/ResumableTotalChunks'
      - $ref: '#/components/parameters/ConnectorWith'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ConnectorFileUpload'
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/ConnectorFillable'
              - oneOf:
                - $ref: '#/components/schemas/ConnectorCategoryId'
                - properties:
                    category:
                      $ref: '#/components/schemas/ConnectorCategoryFillable'
                  type: object
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/Connector'
                type: object
        '400':
          $ref: '#/components/responses/FailedValidation'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-visibility: public
  /connectors/analyze:
    post:
      tags:
      - Connectors
      summary: Analyze Connector YAML
      description: Analyze the connector YAML to determine if it can be uploaded
      operationId: ff74afa58c8cc145f8f3d9586b3ad79d
      parameters:
      - $ref: '#/components/parameters/ResumableChunkNumber'
      - $ref: '#/components/parameters/ResumableChunkSize'
      - $ref: '#/components/parameters/ResumableCurrentChunkSize'
      - $ref: '#/components/parameters/ResumableTotalSize'
      - $ref: '#/components/parameters/ResumableType'
      - $ref: '#/components/parameters/ResumableIdentifier'
      - $ref: '#/components/parameters/ResumableFilename'
      - $ref: '#/components/parameters/ResumableRelativePath'
      - $ref: '#/components/parameters/ResumableTotalChunks'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/ConnectorFileUpload'
      responses:
        '200':
          description: Response Successful
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ConnectorAnalyze'
                type: object
        '400':
          $ref: '#/components/responses/FailedValidation'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-visibility: public
components:
  schemas:
    AttributeIngestRuleMultipleSource:
      description: Attribute ingest rule with multiple sources specified
      properties:
        name:
          description: Attribute name to apply the ingest rule to
          type: string
          example: Country
        multivalue:
          description: Ingest rule allows multiple values
          type: boolean
          example: false
        sources:
          description: Listing of source names to apply the ingest rule to
          type: array
          items:
            type: string
      type: object
    AttributeIngestRuleSingleSource:
      description: Attribute ingest rule with a single source specified
      properties:
        name:
          description: Attribute name to apply the ingest rule to
          type: string
          example: Country
        multivalue:
          description: Ingest rule allows multiple values
          type: boolean
          example: false
        sources:
          description: Source name to apply the ingest rule to
          type: string
          example: GreyNoise
      type: object
    ConnectorCategoryFillable:
      properties:
        name:
          description: Connector Category Name
          type: string
          enum:
          - Commercial
          - Labs
          - OSINT
          - STIX/TAXII
          - Workflow
          example: Labs
      type: object
    ConnectorCustomFieldOptions:
      description: Connector custom fields that do specify options
      properties:
        description:
          description: Longer text describing the purpose of the field exposed to users as a tooltip in the UI<br /><br /><b>Note:</b> Defaults to the value of label
          type: string
          example: My Checkbox
        label:
          description: Friendly name for the field that is displayed in the UI
          type: string
          example: My Checkbox
        name:
          description: Name of the field for internal reference within a CDF or Operation
          type: string
          example: My Checkbox
        options:
          description: Listing of custom field options
          type: array
          items:
            $ref: '#/components/schemas/ConnectorCustomFieldOption'
        required:
          description: Denotes whether or not the field is required
          type: boolean
          default: false
          example: true
        type:
          description: Field type of the custom field
          type: string
          enum:
          - multiselect
          - radio
          - select
          example: select
      type: object
    ConnectorCustomFieldNonRequired:
      description: Connector custom fields that are not require-able
      properties:
        default:
          description: Specifies a default value for a field that is used unless overwritten in the UI
          type: boolean
          default: None
          example: true
        description:
          description: Longer text describing the purpose of the field exposed to users as a tooltip in the UI<br /><br /><b>Note:</b> Defaults to the value of label
          type: string
          example: My Checkbox
        label:
          description: Friendly name for the field that is displayed in the UI
          type: string
          example: My Checkbox
        name:
          description: Name of the field for internal reference within a CDF or Operation
          type: string
          example: My Checkbox
        type:
          description: Field type of the custom field
          type: string
          enum:
          - checkbox
          example: checkbox
      type: object
    ConnectorCustomFieldNonEditable:
      description: Connector custom fields that are not editable
      properties:
        label:
          description: Friendly name for the field that is displayed in the UI
          type: string
          example: My Heading 1
        type:
          description: Field type of the custom field
          type: string
          enum:
          - h1
          - h2
          - h3
          - p
          example: h1
      type: object
    ResumableTotalChunks:
      description: Total amount of chunks for the data
      type: integer
      example: 2
    ConnectorAnalysisSummary:
      description: Listing of connector analysis summaries by connector name
      properties:
        connector_name:
          description: Connector analysis summary
          properties:
            additional_run_params:
              description: Additional run parameters
              type: array
              items:
                type: string
                example: since
            config:
              $ref: '#/components/schemas/ConnectorConfiguration'
            is_supplemental:
              description: Connector is a supplemental
              type: boolean
              example: false
            object_types:
              $ref: '#/components/schemas/ObjectList'
            supports_manual:
              description: Connector supports manual runs
              type: boolean
              example: false
          type: object
      type: object
    ConnectorCategoryId:
      properties:
        category_id:
          description: Connector Category ID
          type: integer
          example: 1
      type: object
    ResumableCurrentChunkSize:
      description: Current chunk size of the data
      type: integer
      example: 1024
    ConnectorFillable:
      required:
      - name
      - namespace
      - category_id
      - category
      properties:
        name:
          description: Connector Name
          type: string
          example: Adversary Reader
        namespace:
          description: Connector Namespace
          type: string
          example: threatq.adversary_reader
        description:
          description: Connector Description
          type: string
          example: Captures Adversary and related information...
        custom_fields:
          description: JSON representation of custom fields for configuration of the Connector (e.g. Poll URLs, API keys, etc)
          type: string
          example: '[{...}]'
        frequency:
          description: Connector Run Frequency (in seconds)
          type: integer
          default: 3600
          example: 86400
        connector_definition_id:
          description: Connector Definition ID - this field will be defined if the Connector's `definition_type` set to `Feed`
          type: integer
          example: 1
        workflow_definition_id:
          description: Workflow Definition ID - this field will be defined if the Connector's `definition_type` is set to `Workflow`
          type: integer
          example: 1
        indicator_status_id:
          description: Default Indicator Status ID for any Indicators ingested by the Connector (Feed)
          type: integer
          example: 1
        last_import_at:
          description: The date/time the Connector was last run
          type: string
          example: '2022-08-17 00:00:00'
        last_import_count:
          description: Number of objects processed in the last Connector run
          type: integer
          example: 100
        is_active:
          description: 'Connector''s active status: enabled or disabled'
          type: string
          default: disabled
          enum:
          - enabled
          - disabled
          example: disabled
        is_notifiable:
          description: Connector supports notifications
          type: boolean
          example: false
        tlp_id:
          description: Default TLP ID for objects imported by the Connector
          type: integer
          example: 1
        version:
          description: Connector Version
          type: string
          example: 1.0.0
        file_save_enabled:
          description: For debugging - log files associated with the Connector run should be saved
          type: boolean
          default: false
          example: false
        schedule:
          description: Connector Schedule
          type: string
          example: null
        next_run_at:
          description: The date/time the Connector is next scheduled to run
          type: string
          example: '2022-08-17 12:00:00'
      type: object
    ResumableIdentifier:
      description: Identifier of the data
      type: string
      example: 2048-connectoryaml
    ConnectorConfiguration:
      description: Connector configuration
      properties:
        category:
          $ref: '#/components/schemas/ConnectorCategoryFillable'
        custom_fields:
          $ref: '#/components/schemas/ConnectorCustomFields'
        description:
          description: Connector description
          type: string
          example: My connector
        indicator_status:
          $ref: '#/components/schemas/IndicatorStatusName'
        ingest_rules:
          description: Listing of connector ingest rules by type
          properties:
            attributes:
              $ref: '#/components/schemas/AttributeIngestRule'
          type: object
        name:
          description: Connector name
          type: string
          example: connector_name
        namespace:
          description: Connector namespace
          type: string
          example: threatq.connector_name
        signature_status:
          $ref: '#/components/schemas/SignatureStatusName'
      type: object
    SignatureStatusName:
      description: Signature status name
      type: string
      enum:
      - Active
      - Expired
      - Inactive
      - Non-malicious
      - Review
      - Whitelisted
      example: Active
    ConnectorCustomFieldNoOptions:
      description: Connector custom fields that do not specify any options
      properties:
        default:
          description: Specifies a default value for a field that is used unless overwritten in the UI
          type: boolean
          default: None
          example: true
        description:
          description: Longer text describing the purpose of the field exposed to users as a tooltip in the UI<br /><br /><b>Note:</b> Defaults to the value of label
          type: string
          example: My Checkbox
        label:
          description: Friendly name for the field that is displayed in the UI
          type: string
          example: My Checkbox
        name:
          description: Name of the field for internal reference within a CDF or Operation
          type: string
          example: My Checkbox
        required:
          description: Denotes whether or not the field is required
          type: boolean
          default: false
          example: true
        type:
          description: Field type of the custom field
          type: string
          enum:
          - password
          - text
          - textarea
          - threat_collection
          example: text
      type: object
    ConnectorCustomFields:
      description: Listing of connector custom fields
      type: array
      items:
        anyOf:
        - description: Connector custom fields that have no text
          properties:
            type:
              description: Field type of the custom field
              type: string
              enum:
              - hr
              example: hr
          type: object
        - $ref: '#/components/schemas/ConnectorCustomFieldNonEditable'
        - $ref: '#/components/schemas/ConnectorCustomFieldNonRequired'
        - $ref: '#/components/schemas/ConnectorCustomFieldNoOptions'
        - $ref: '#/components/schemas/ConnectorCustomFieldOptions'
    ResumableChunkNumber:
      description: Chunk number of the data
      type: integer
      example: 1
    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
    IndicatorStatusName:
      description: Indicator status name
      type: string
      enum:
      - Active
      - Expired
      - Indirect
      - Review
      - Whitelisted
      example: Active
    ResumableRelativePath:
      description: Relative path of the file
      type: string
      example: connector.yaml
    ResumableFilename:
      description: File name
      type: string
      example: connector.yaml
    ResumableTotalSize:
      description: Total size of the data
      type: integer
      example: 2048
    ConnectorAnalyze:
      description: Connector analysis object
      properties:
        definition_yaml:
          description: Connector YAML
          type: string
          example: Connector YAML contents...
        required_threatq_version:
          description: Required ThreatQ version
          type: string
          example: null
        summary:
          $ref: '#/components/schemas/ConnectorAnalysisSummary'
        version:
          description: Connector YAML version
          type: string
          example: 1.0.0
      type: object
    ResumableChunkSize:
      description: Chunk size of the data
      type: integer
      example: 4096
    ResumableType:
      description: Type of the data
      type: string
      example: application/x-yaml
    AttributeIngestRule:
      description: Listing of attribute ingest rules<br /><br /><b>Note:</b>The connector name is used for the source name when the Attribute Ingest Rule No Source object is used.
      type: array
      items:
        anyOf:
        - $ref: '#/components/schemas/AttributeIngestRuleNoSource'
        - $ref: '#/components/schemas/AttributeIngestRuleSingleSource'
        - $ref: '#/components/schemas/AttributeIngestRuleMultipleSource'
    ConnectorSystemSetFields:
      properties:
        definition_type:
          description: Connector Definition Type - Feed or Workflow
          type: string
          enum:
          - feed
          - workflow
          example: feed
        gate_oauth2_client_id:
          description: OAuth2 Gate Client associated with the Connector
          type: integer
          example: 1
      type: object
    AttributeIngestRuleNoSource:
      description: Attribute ingest rule with no source specified
      properties:
        name:
          description: Attribute name to apply the ingest rule to
          type: string
          example: Country
        multivalue:
          description: Ingest rule allows multiple values
          type: boolean
          example: false
      type: object
    Connector:
      description: Class Connector
      allOf:
      - $ref: '#/components/schemas/ConnectorFillable'
      - $ref: '#/components/schemas/ConnectorCategoryId'
      - $ref: '#/components/schemas/ConnectorSystemSetFields'
      - $ref: '#/components/schemas/ThreatQTimestamps'
    ObjectList:
      description: Listing of supported object types<br /><br /><b>Note:</b> Any created custom object name can be used
      type: array
      items:
        $ref: '#/components/schemas/ObjectType'
    ObjectType:
      description: Object type<br /><br /><b>Note:</b> Any created custom object name can be used
      type: string
      enum:
      - adversary
      - attachment
      - attack_pattern
      - campaign
      - course_of_action
      - event
      - exploit_target
      - identity
      - incident
      - indicator
      - intrusion_set
      - investigation
      - malware
      - report
      - signature
      - task
      - tool
      - ttp
      - vulnerability
      example: indicator
    ConnectorFileUpload:
      required:
      - package
      properties:
        resumableChunkNumber:
          $ref: '#/components/schemas/ResumableChunkNumber'
        resumableChunkSize:
          $ref: '#/components/schemas/ResumableChunkSize'
        resumableCurrentChunkSize:
          $ref: '#/components/schemas/ResumableCurrentChunkSize'
        resumableTotalSize:
          $ref: '#/components/schemas/ResumableTotalSize'
        resumableType:
          $ref: '#/components/schemas/ResumableType'
        resumableIdentifier:
          $ref: '#/components/schemas/ResumableIdentifier'
        resumableFilename:
          $ref: '#/components/schemas/ResumableFilename'
        resumableRelativePath:
          $ref: '#/components/schemas/ResumableRelativePath'
        resumableTotalChunks:
          $ref: '#/components/schemas/ResumableTotalChunks'
        package:
          description: The Connector definition YAML file
          type: string
      type: object
    ConnectorCustomFieldOption:
      description: Custom field option
      properties:
        default:
          description: Custom field option should be selected by default
          type: boolean
          example: true
        text:
          description: Custom field option display text
          type: string
          example: My Custom Field Option
        value:
          description: Custom field option value
          type: string
          example: My Custom Field Option Value
      type: object
  parameters:
    ResumableTotalSize:
      name: resumableTotalSize
      in: path
      description: <br />Total size of the data
      required: true
      schema:
        $ref: '#/components/schemas/ResumableTotalSize'
    ResumableChunkSize:
      name: resumableChunkSize
      in: path
      description: <br />Chunk size of the data
      required: true
      schema:
        $ref: '#/components/schemas/ResumableChunkSize'
    ResumableFilename:
      name: resumableFilename
      in: path
      description: <br />File name
      required: true
      schema:
        $ref: '#/components/schemas/ResumableFilename'
    ResumableChunkNumber:
      name: resumableChunkNumber
      in: path
      description: <br />Chunk number of the data
      required: true
      schema:
        $ref: '#/components/schemas/ResumableChunkNumber'
    ResumableTotalChunks:
      name: resumableTotalChunks
      in: path
      description: <br />Total amount of chunks for the data
      required: true
      schema:
        $ref: '#/components/schemas/ResumableTotalChunks'
    ResumableIdentifier:
      name: resumableIdentifier
      in: path
      description: <br />Identifier of the data
      required: true
      schema:
        $ref: '#/components/schemas/ResumableIdentifier'
    ResumableType:
      name: resumableType
      in: path
      description: <br />Type of the data
      required: true
      schema:
        $ref: '#/components/schemas/ResumableType'
    ResumableCurrentChunkSize:
      name: resumableCurrentChunkSize
      in: path
      description: <br />Current chunk size of the data
      required: true
      schema:
        $ref: '#/components/schemas/ResumableCurrentChunkSize'
    ConnectorWith:
      name: with
      in: path
      description: "<br />Comma-delimited list of relationships that can be included in the response<br /><br />\n <b>Note:</b> Supported relationships are `category`, `definition`, `gateOauth2Client`, `health`, `polyDefinition`,\n  `runLog`, `source`, and `tlp`"
      required: false
      schema:
        type: string
        example: category,definition,tlp
    ResumableRelativePath:
      name: resumableRelativePath
      in: path
      description: <br />Relative path of the file
      required: true
      schema:
        $ref: '#/components/schemas/ResumableRelativePath'
  responses:
    FailedValidation:
      description: Validation Failed
    Unauthorized:
      description: Unauthorized
  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