SIE OpenAPI Spec

This specification is also available on the Swagger API Hub.

openapi: 3.0.0
servers:
  - url: https://batch.sie-remote.net
    description: prod
info:
  description: |
    Designed to combat the challenges with consuming real-time data, SIE Batch allows subscribers to select, or “batch”, their available real-time data sets and pinpoint data needed for their investigations. Available via both API and a Web interface, subscribers can log into SIE Batch and download a recent sample of data (from 2 minutes to 12 hours in length) or download a specific time period of data they need. In addition, Farsight offers a SIE Batch API that lets subscribers easily access SIE data (in file format) from a program or script.

  version: 1.0.0
  title: SIE Batch REST API

paths:
  /siebatchd/v1/validate:
    post:
      security: []
      summary: Get Channel Details
      description: Validates a provided API Key and then returns profile and provisioning information associated with it.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                apikey:
                  type: string
                  format: password
                  description: Your Farsight SIE Batch API Key

      externalDocs:
        url: https://batch.sie-remote.net/apidoc/#api-Batched_Channel_Access-_siebatch_chdetails

      responses:
        200:
          $ref: '#/components/responses/200_validate'
        400:
          $ref: '#/components/responses/4xx'
        500:
          $ref: '#/components/responses/4xx'

  /siebatchd/v1/siebatch/makeurl:
    post:
      security: []
      summary: Make URL
      description: Generate a URL that can be used to download data associated with a channel later or independently of the SIE Batch webserver.
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required: [apikey,channel,start_time,end_time]
              properties:
                apikey:
                  type: string
                  format: password
                  description: Your Farsight SIE Batch API Key
                channel:
                  type: integer
                  description: Channel Number
                  enum: [14, 24, 25, 27, 42, 80, 115, 204, 207, 208, 211, 212, 213, 214, 220, 221, 255]
                expire:
                  type: string
                  description: Number of hours (from when you call this API) until the URL expires (max 168 - default)
                start_time:
                  type: string
                  description: A Start Date, "YYYY-mm-dd HH:MM:SS" in UTC
                  example: YYYY-mm-dd HH:MM:SS
                end_time:
                  type: string
                  description: An End Date, "YYYY-mm-dd HH:MM:SS" in UTC
                  example: YYYY-mm-dd HH:MM:SS

      externalDocs:
        url: https://batch.sie-remote.net/apidoc/#api-Batched_Channel_Access-_siebatch_makeurl

      responses:
        200:
          $ref: '#/components/responses/200_make'
        400:
          $ref: '#/components/responses/4xx'
        500:
          $ref: '#/components/responses/4xx'

  /siebatchd/v1/siebatch/chfetch:
    post:
      summary: Fetch Channel Data
      description: Download data associated with a channel
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                apikey:
                  type: string
                  format: password
                  description: Your Farsight SIE Batch API Key
                channel:
                  type: integer
                  description: Channel Number
                  enum: [14, 24, 25, 27, 42, 80, 115, 204, 207, 208, 211, 212, 213, 214, 220, 221, 255]
                start_time:
                  type: string
                  description: A Start Date, "YYYY-mm-dd HH:MM:SS" in UTC
                  example: YYYY-mm-dd HH:MM:SS
                end_time:
                  type: string
                  description: An End Date, "YYYY-mm-dd HH:MM:SS" in UTC
                  example: YYYY-mm-dd HH:MM:SS

      externalDocs:
        url: https://batch.sie-remote.net/apidoc/#api-Batched_Channel_Access-_siebatch_chfetch

      responses:
        400:
          $ref: '#/components/responses/4xx'
        500:
          $ref: '#/components/responses/4xx'

components:
  responses:
    200_validate:
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              profile:
                type: object
                properties:
                  username:
                    type: string
                  apikey:
                    type: string
                  over_quota_action:
                    type: string
                  channels:
                    type: object
                  not_really:
                    type: boolean
                  siebatch:
                    type: object
                    properties:
                      "ch ID":
                        type: object
                        properties:
                          description:
                            type: string
                  anomalies:
                    type: object
                  state_quota:
                    type: string
              _status:
                type: string
              _message:
                type: string
    200_make:
      description: OK
      content:
        application/json:
          schema:
            type: object
            properties:
              _status:
                type: string
              _message:
                type: string
              url:
                type: string
    4xx:
      description: ERROR
      content:
        application/json:
          schema:
            type: object
            properties:
              _status:
                type: string
              _message:
                type: string
              status:
                type: integer
              type:
                type: string
              detail:
                type: string              
              logid:
                type: string
externalDocs:
  url: https://batch.sie-remote.net/apidoc