swagger: '2.0'
info:
  description: Configuration for AF Safety Device Report table resource.
  version: 'v2'
  title: si_device
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: si_device
    description: AF Safety Device Report table
consumes:
  - application/json
produces:
  - application/json
securityDefinitions:
  UserSecurity:
    type: basic
security:
  - UserSecurity: []
parameters:
  authParam:
      in: header
      name: Authorization
      type: string
      required: true
      description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
  cloudParam:
      in: header
      name: isCloud
      type: string
      required: true
      description: set the value to true in case of Cloud services, false for on-prem deployment
paths:
  /massvc/{customerid}/nitro/v2/config/si_device:
    get:
      tags:
        - si_device
      summary: GET all si_device
      operationId: getall_si_device
      description: Af Report for Security Insight Device.
      consumes:
        - application/json
      produces:
        - application/json
      parameters:
        - in: path
          name: customerid
          type: string
          required: true
          description: Customer Id of the user
        - in: header
          name: Authorization
          type: string
          required: true
          description: Session Id for authentication.Should be mentioned in the format CwsAuth bearer=sessionIdValue
        - in: header
          name: isCloud
          type: string
          required: true
          description: set the value to true in case of Cloud services, false for on-prem deployment
        - in: query
          name: filter
          type: string
          required: false
          description: "Use this query-parameter to get the filtered set of vm_device resources configured on the system. You can set a filter on any property of the resource.Example:  property-name1:property-value1 "
        - in: query
          name: args
          type: string
          required: false
          description: "Use this query-parameter to specify arguments.Example:  property-name1:property-value1 "
        - in: query
          name: duration
          type: string
          required: true
          description: "Duration "
          enum:
            - last_1_hour
            - last_1_day
            - last_1_week
            - last_1_month
        - in: query
          name: cr_enabled
          type: string
          required: false
          description: Use this query-parameter to indicate cr is enabled or not
          enum:
            - 0
            - 1
        - in: query
          name: report_start_time
          type: string
          required: false
          description: Use this query-parameter to specify the start time from which the summary for report is considered
        - in: query
          name: report_end_time
          type: string
          required: false
          description: Use this query-parameter to specify the end time until where summary for report is considered
        - in: query
          name: asc
          type: string
          required: false
          description: Use this query-parameter to specify whether the results should be in ascending order or not
          enum:
            - yes
            - no
        - in: query
          name: sla_enabled
          type: string
          required: false
          description: Use this query-parameter to indicate sla is enabled or not
          enum:
            - 0
            - 1
        - in: query
          name: order_by
          type: string
          required: false
          description: Use this query-parameter to get the result that is ordered by the given property
          enum:
            - total_attacks
        - in: query
          name: type
          type: string
          required: false
          description: Use this query-parameter to specify the type
          enum:
            - total_attacks
        - in: query
          name: pagesize
          type: integer
          required: false
          description: Use this query-parameter to get the si_device resources in chunks.To be used along with pageno query parameter.
        - in: query
          name: pageno
          type: integer
          required: false
          description: Use this query-parameter to get the si_device resources in chunks.To be used along with pagesize query parameter.
        - in: query
          name: count
          type: string
          required: false
          description: Use this query-parameter to get the count of si_device resources.
          enum:
            - yes
      responses:
        200:
          description:  for si_device
          schema: 
              $ref: '#/definitions/getsi_devicesResponse'
        400:
          description: Bad input parameter
          schema: 
              $ref: '#/definitions/Error'
        401:
          description: Failed Authentication
          schema: 
              $ref: '#/definitions/Error'
        403:
          description: Unauthorized
          schema: 
              $ref: '#/definitions/Error'
        404:
          description: Item not found
          schema: 
              $ref: '#/definitions/Error'
        409:
          description: Resource Conflict
          schema: 
              $ref: '#/definitions/Error'
        500:
          description: Server Error
          schema: 
              $ref: '#/definitions/Error'
        504:
          description: Gateway Timeout
          schema: 
              $ref: '#/definitions/Error'

definitions:
  getsi_deviceResponse:
    type: object
    required:
      - si_device
    properties:
      si_device:
        $ref: '#/definitions/si_device'
    title: getsi_deviceResponse
    example:
      si_device:
        threat_index: "1.0"
        low_threat: "1.0"
        medium_threat: "1.0"
        medium_safety: "1.0"
        name: "app_1.1.1.1"
        high_safety: "1.0"
        high_threat: "5.0"
        __count: "1.0"
        index_summary: "1.0"
        safety_index: "1.0"
        ip_address: "1.1.1.1"
        total_attacks: "1.0"
        low_safety: "1.0"

  getsi_devicesResponse:
    type: object
    required:
      - si_device
    properties:
      si_device:
        type: array
        items:
          $ref: '#/definitions/si_device'
    title: getsi_devicesResponse
    example:
      si_device:
        threat_index: "1.0"
        low_threat: "1.0"
        medium_threat: "1.0"
        medium_safety: "1.0"
        name: "app_1.1.1.1"
        high_safety: "1.0"
        high_threat: "5.0"
        __count: "1.0"
        index_summary: "1.0"
        safety_index: "1.0"
        ip_address: "1.1.1.1"
        total_attacks: "1.0"
        low_safety: "1.0"

  si_device_readwrite:
    type: object
    properties:
      threat_index:
        description: "Threat Index"
        type: number
        format: double
      low_threat:
        description: "Low Threat Count"
        type: number
        format: double
      medium_threat:
        description: "Medium Threat Count"
        type: number
        format: double
      medium_safety:
        description: "Medium Safety Count."
        type: number
        format: double
      name:
        description: "Name of NetScaler Instance"
        type: string
        format: string
        minLength: 1
        maxLength: 128
      high_safety:
        description: "High Safety Count"
        type: number
        format: double
      high_threat:
        description: "Hig  Threat Count"
        type: number
        format: double
      __count:
        description: "Number of records"
        type: number
        format: double
      index_summary:
        description: "index_summary 0 or 1."
        type: number
        format: double
      safety_index:
        description: "safety index."
        type: number
        format: double
      ip_address:
        description: "NetScaler IP Address."
        type: string
        format: ipaddress
        minLength: 1
        maxLength: 64
      total_attacks:
        description: "total attacks."
        type: number
        format: double
      low_safety:
        description: "Low Safety Count"
        type: number
        format: double

  si_device:
    allOf:
      - $ref: '#/definitions/si_device_readwrite'

  Error:
    properties:
      errorcode:
        type: number
        format: int32
        example: 1001
      errormessage:
        type: string
        format: string
        example: "id cannot be found"
