sra-stream-param-schema.yaml

id: http://farsightsecurity.com/axamd-stream-param-schema#
$schema: http://json-schema.org/draft-04/schema#
title: axamd stream parameter
description: parameters for axamd's /v1/sra/stream API call
type: object
definitions:
        watch:
                type: string
                oneOf:
                        - pattern: '^ch=[0-9]+$'
                        - pattern: '^ip=[0-9a-fA-F:\.]+(/[0-9]+)?$'
                        - pattern: '^dns=(\*\.|(\*\.)?[a-z0-9-\.]+)$'
                        - pattern: '^errors$'
properties:
        channels:
                type: array
                items:
                        type: integer
                        minimum: 1
                        maximum: 255
                minItems: 1
        watches:
                type: array
                items:
                        $ref: "#/definitions/watch"
                minItems: 1
        sample_rate:
                type: number
                maximum: 1
                minimum: 0
                exclusiveMinimum: true
        rate_limit:
                type: integer
                maximum: 1000000000
        report_interval:
                type: integer
                minimum: 10
        output_format:
                type: string
                oneOf:
                        - pattern: '^axa\+json$'
                        - pattern: '^nmsg\+json$'
                        - pattern: '^nmsg\+binary$'
required:
        - channels
        - watches