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-whitelist-rules-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 Whitelist Rules 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: Whitelist Rules
paths:
  /whitelist/rules:
    post:
      tags:
      - Whitelist Rules
      summary: Create a Whitelist Rule
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WhitelistRuleFillable'
      responses:
        '201':
          description: New Whitelist Rule Created
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/WhitelistRuleWithIndicatorCount'
                type: object
        '400':
          $ref: '#/components/responses/FailedValidation'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-visibility: public
      operationId: postWhitelistRules
      x-operation-id-source: derived
  /whitelist/rules/count{?rule,type_id}:
    get:
      tags:
      - Whitelist Rules
      summary: Whitelist Rule Indicator Count
      operationId: 9112fbf964a0de3c9db887030c936f8a
      parameters:
      - parameter: WhitelistRuleValue
        name: rule
        in: query
        description: Whitelist Rule Value
        required: true
        schema:
          type: string
          example: '*.threatq.com'
      - parameter: WhitelistRuleIndicatorTypeId
        name: type_id
        in: query
        description: Whitelist Rule Indicator Type ID
        required: true
        schema:
          type: integer
          example: 11
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                properties:
                  count:
                    type: integer
                    example: 37
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-visibility: public
  /whitelist/rules/{whitelist_rule_id}:
    delete:
      tags:
      - Whitelist Rules
      summary: Delete a Whitelist Rule
      parameters:
      - $ref: '#/components/parameters/WhitelistRuleId'
      responses:
        '204':
          $ref: '#/components/responses/NoContent'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-visibility: public
      operationId: deleteWhitelistRulesByWhitelistRuleId
      x-operation-id-source: derived
  /whitelist/rules/{whitelist_rule_id}{?with}:
    get:
      tags:
      - Whitelist Rules
      summary: Get a Single Whitelist Rule
      parameters:
      - $ref: '#/components/parameters/WhitelistRuleId'
      - $ref: '#/components/parameters/WhitelistRuleWith'
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/WhitelistRuleWithType'
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-visibility: public
      operationId: getWhitelistRulesByWhitelistRuleId}{?with
      x-operation-id-source: derived
    put:
      tags:
      - Whitelist Rules
      summary: Update a Whitelist Rule
      parameters:
      - $ref: '#/components/parameters/WhitelistRuleId'
      - $ref: '#/components/parameters/WhitelistRuleWith'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WhitelistRuleFillable'
      responses:
        '201':
          description: Whitelist Rule Updated
          content:
            application/json:
              schema:
                properties:
                  data:
                    $ref: '#/components/schemas/WhitelistRuleWithType'
                type: object
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-visibility: public
      operationId: putWhitelistRulesByWhitelistRuleId}{?with
      x-operation-id-source: derived
  /whitelist/rules{?limit,offset,sort,with}:
    get:
      tags:
      - Whitelist Rules
      summary: List Whitelist Rules
      parameters:
      - $ref: '#/components/parameters/Limit'
      - $ref: '#/components/parameters/Offset'
      - $ref: '#/components/parameters/Sort'
      - $ref: '#/components/parameters/WhitelistRuleWith'
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/WhitelistRuleWithType'
                  type: object
                - $ref: '#/components/schemas/TotalResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-visibility: public
      operationId: getWhitelistRules{?limit,offset,sort,with}
      x-operation-id-source: derived
components:
  schemas:
    WhitelistRule:
      allOf:
      - properties:
          id:
            description: Whitelist Rule ID
            type: integer
            example: 1
        type: object
      - properties:
          created_at:
            description: Whitelist Rule Creation Date
            type: string
            example: '2020-05-01 02:35:16'
          updated_at:
            description: Whitelist Rule Update Date
            type: string
            example: '2020-05-03 04:27:51'
        type: object
      - $ref: '#/components/schemas/WhitelistRuleFillable'
    WhitelistRuleFillable:
      properties:
        type_id:
          description: Indicator Type ID
          type: integer
          example: 11
        status_id:
          description: Indicator Status ID
          type: integer
          example: 2
        rule:
          description: Whitelist Rule Value
          type: string
          example: '*.threatq.com'
        enabled:
          description: Determines whether the Whitelist Rule is being actively applied
          type: string
          example: Y
      type: object
    TotalResponse:
      properties:
        total:
          description: Total Number of Objects Processed
          type: integer
          example: 1
      type: object
    IndicatorType:
      allOf:
      - properties:
          id:
            description: Indicator Type ID
            type: integer
            example: 1
        type: object
      - properties:
          wildcard_matching:
            description: Determines whether the Indicator Type matches wild cards
            type: string
            example: Y
          created_at:
            description: Indicator Type Creation Date
            type: string
            example: '2020-05-01 02:35:16'
          updated_at:
            description: Indicator Type Update Date
            type: string
            example: '2020-05-03 04:27:51'
        type: object
      - $ref: '#/components/schemas/IndicatorTypeFillable'
    WhitelistRuleWithType:
      allOf:
      - properties:
          type:
            $ref: '#/components/schemas/IndicatorType'
        type: object
      - $ref: '#/components/schemas/WhitelistRule'
    IndicatorTypeFillable:
      properties:
        name:
          description: Indicator Type Name
          type: string
          example: FQDN
        class:
          description: Indicator Type Class - Options include Network or Host
          type: string
          example: network
        score:
          description: Indicator Type Score - Ranges from -10 to 10
          type: integer
          example: 3
      type: object
    WhitelistRuleWithIndicatorCount:
      allOf:
      - properties:
          updated_count:
            description: Number of Indicators updated via new Whitelist Rule
            type: integer
            example: 3
        type: object
      - $ref: '#/components/schemas/WhitelistRule'
  responses:
    Unauthorized:
      description: Unauthorized
    FailedValidation:
      description: Validation Failed
    NoContent:
      description: Object(s) were successfully deleted.
    NotFound:
      description: Object Not Found
  parameters:
    WhitelistRuleWith:
      name: with
      in: query
      description: <br>Indicator Type relationship that can be included in the response.
      required: false
      style: form
      explode: false
      schema:
        type: string
        example: type
    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
    WhitelistRuleId:
      name: whitelist_rule_id
      in: path
      description: Whitelist Rule ID
      required: true
      schema:
        type: integer
    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
  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