find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/securonix-object-watchlist-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ThreatQ Object Watchlist 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: Object Watchlist
paths:
  /{object_type}/watchlist:
    get:
      tags:
      - Object Watchlist
      summary: List all Entries in a User's Watchlist for an Object Type
      description: 'This path can be used for any object type installed on the system.


        Examples:


        Indicator Watchlist: /indicators/watchlist


        Attack Pattern Watchlist: /attack_pattern/watchlist'
      parameters:
      - $ref: '#/components/parameters/ObjectType'
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/ObjectWatchlistWithRelations'
                  type: object
                - $ref: '#/components/schemas/TotalResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-visibility: public
      operationId: getByObjectTypeWatchlist
      x-operation-id-source: derived
    post:
      tags:
      - Object Watchlist
      summary: Bulk Add Entries to a User's Watchlist for an Object Type
      description: 'This path can be used for any object type installed on the system.


        Examples:


        Indicator Watchlist: /indicators/:indicator_id/watchlist


        Attack Pattern Watchlist: /attack_pattern/:attack_pattern_id/watchlist'
      requestBody:
        content:
          application/json:
            schema:
              properties:
                object_ids:
                  type: array
                  items:
                    type: integer
                    example: 2
              type: object
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ObjectWatchlist'
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-visibility: public
      operationId: postByObjectTypeWatchlist
      x-operation-id-source: derived
  /{object_type}/{object_type_id}/watchlist:
    get:
      tags:
      - Object Watchlist
      summary: Get a Single Entry in a User's Watchlist for an Object Type
      description: 'This path can be used for any object type installed on the system.


        Examples:


        Indicator Watchlist: /indicators/:indicator_id/watchlist


        Attack Pattern Watchlist: /attack_pattern/:attack_pattern_id/watchlist'
      parameters:
      - $ref: '#/components/parameters/ObjectType'
      - $ref: '#/components/parameters/ObjectTypeId'
      - $ref: '#/components/parameters/ObjectWatchlistWith'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/ObjectWatchlistWithRelations'
                  type: object
                - $ref: '#/components/schemas/TotalResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-visibility: public
      operationId: getByObjectTypeByObjectTypeIdWatchlist
      x-operation-id-source: derived
    post:
      tags:
      - Object Watchlist
      summary: Add an Entry to a User's Watchlist for an Object Type
      parameters:
      - $ref: '#/components/parameters/ObjectType'
      - $ref: '#/components/parameters/ObjectTypeId'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/ObjectWatchlist'
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-visibility: public
      operationId: postByObjectTypeByObjectTypeIdWatchlist
      x-operation-id-source: derived
  /{object_type}/{object_type_id}/watchlist/{object_type_watchlist_id}:
    delete:
      tags:
      - Object Watchlist
      summary: Remove an Entry from a User's Watchlist for an Object Type
      parameters:
      - $ref: '#/components/parameters/ObjectType'
      - $ref: '#/components/parameters/ObjectTypeId'
      - $ref: '#/components/parameters/ObjectTypeWatchlistId'
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-visibility: public
      operationId: deleteByObjectTypeByObjectTypeIdWatchlistByObjectTypeWatchlistId
      x-operation-id-source: derived
components:
  responses:
    Unauthorized:
      description: Unauthorized
    NotFound:
      description: Object Not Found
    NoContent:
      description: Object(s) were successfully deleted.
  schemas:
    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
    ObjectWatchlist:
      allOf:
      - properties:
          id:
            description: Object Watchlist ID
            type: integer
            example: 39
          user_id:
            description: ID for the User who added the Object to the Watchlist
            type: integer
            example: 42
          object_type:
            description: Object Type - this will match the Object Type collection in the URL path
            type: string
            example: indicator
          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
    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'
    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
    ObjectWatchlistWithRelations:
      allOf:
      - properties:
          indicator:
            $ref: '#/components/schemas/Indicator'
        type: object
      - $ref: '#/components/schemas/ObjectWatchlist'
  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
    ObjectTypeWatchlistId:
      name: object_type_watchlist_id
      in: path
      description: The ID of the Watchlist entry for the specified Object Type
      required: true
      schema:
        type: integer
        example: 12
    ObjectTypeId:
      name: object_type_id
      in: path
      description: The ID for the record of the specified Object Type whose context you would like to retrieve
      required: true
      schema:
        type: integer
        example: 6
    ObjectType:
      name: object_type
      in: path
      description: 'The collection identifier for the Object Type whose context you would like to retrieve. Options include:

        adversaries, attachments, attack_pattern, campaign, course_of_action, event, exploit_target, identity, incident,

        indicators, intrustion_set, malware, report, signature, tool, ttp, and vulnerability. If you have any additional custom

        objects installed on your system, use the value for the `collection` field associated with the object definition.'
      required: true
      schema:
        type: string
        example: indicators
    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
    ObjectWatchlistWith:
      name: with
      in: query
      description: "<br>Object Relationships that can be included in the response.<br><br>Options include: `<object_code>`\n <br><br>The `<object_code>` placeholder in the options takes the value of the `code` field for an object definition.<br><br>"
      required: false
      style: form
      explode: false
      schema:
        type: array
        items:
          type: string
          example: indicator
  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