openapi: 3.0.1
info:
  title: Dragos WorldView Indicators Products API
  version: v1
  description: API access to the WorldView Reports and Indicators
  contact:
    name: the developer
    email: support@dragos.com
tags:
- name: Products
paths:
  /api/v1/products:
    get:
      summary: Returns a list of all products
      tags:
      - Products
      security:
      - api_token: []
        api_secret: []
        npe_token: []
      parameters:
      - name: page
        in: query
        description: Page number (default 1)
        required: false
        schema:
          type: string
      - name: page_size
        in: query
        description: Page size (default 50) (must be less than 501)
        required: false
        schema:
          type: string
      - name: sort_by
        in: query
        description: Sort returned products (default release_date)
        required: false
        schema:
          type: string
          enum:
          - title
          - threat
          - tlp
          - release_date
      - name: sort_desc
        in: query
        description: Page desc (default false)
        required: false
        schema:
          type: boolean
      - name: updated_after
        in: query
        description: UTC timestamp in YYYY-mm-dd (optionally with HH:mm:ss) to filter to recently updated products
        required: false
        schema:
          type: string
      - name: released_after
        in: query
        description: UTC timestamp in YYYY-mm-dd (optionally with HH:mm:ss) to filter to recently released products
        required: false
        schema:
          type: string
      - name: serials[]
        in: query
        description: Filter reports from an array of serials
        required: false
        schema:
          type: array
          items:
            type: string
            example: ''
      - name: indicator
        in: query
        description: Filter reports related to a given indicator (exact match only)
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '429':
          description: Too Many Requests
  /api/v1/products/{id}:
    get:
      summary: Returns the metadata of a product
      tags:
      - Products
      security:
      - api_token: []
        api_secret: []
        npe_token: []
      parameters:
      - name: id
        in: path
        description: Product serial number
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '404':
          description: Not Found
        '401':
          description: Unauthorized
        '429':
          description: Too Many Requests
  /api/v1/products/{id}/csv:
    get:
      summary: Returns the CSV file for the indicators related to a given serial
      tags:
      - Products
      security:
      - api_token: []
        api_secret: []
        npe_token: []
      parameters:
      - name: id
        in: path
        description: Product serial number
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '404':
          description: Not Found
        '401':
          description: Unauthorized
        '429':
          description: Too Many Requests
  /api/v1/products/{id}/stix2:
    get:
      summary: Returns the STIX2.0 JSON bundle for the indicators related to a given serial
      tags:
      - Products
      security:
      - api_token: []
        api_secret: []
        npe_token: []
      parameters:
      - name: id
        in: path
        description: Product serial number
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success
        '404':
          description: Not Found
        '401':
          description: Unauthorized
        '429':
          description: Too Many Requests
components:
  securitySchemes:
    api_token:
      description: API Access Token
      in: header
      name: API-Token
      type: apiKey
    api_secret:
      description: API Secret Key
      in: header
      name: API-Secret
      type: apiKey
    npe_token:
      description: NPE Token
      in: header
      name: Authorization
      type: apiKey