swagger: '2.0'
info:
  description: Configuration for AF IP Reputation Report resource.
  version: 'v2'
  title: si_ip_reputation
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: si_ip_reputation
    description: AF IP Reputation Report
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_ip_reputation:
    get:
      tags:
        - si_ip_reputation
      summary: GET all si_ip_reputation
      operationId: getall_si_ip_reputation
      description: Af Report for IP Reputation.
      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_ip_reputation 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_ip_reputation 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_ip_reputation resources.
          enum:
            - yes
      responses:
        200:
          description:  for si_ip_reputation
          schema: 
              $ref: '#/definitions/getsi_ip_reputationsResponse'
        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_ip_reputationResponse:
    type: object
    required:
      - si_ip_reputation
    properties:
      si_ip_reputation:
        $ref: '#/definitions/si_ip_reputation'
    title: getsi_ip_reputationResponse
    example:
      si_ip_reputation:
        violation_action: "Blocked"
        name: "name_1.1.1.1"
        violation_type: "Type"
        iprep_severity: "Critcal"
        iprep_attack_time: "1580886160"
        rpt_sample_time: "1580886160"
        si_device_ip_address: "1.1.1.1"
        iprep_app_threat_index: "1.0"
        __count: "1.0"
        iprep_reputation_score: "IP Reputation"
        attack_category: "Denial of Service"
        iprep_category: "Name"
        source_ip_address: "1.1.1.1"
        total_attacks: "1.0"
        iprep_http_method: "GET"

  getsi_ip_reputationsResponse:
    type: object
    required:
      - si_ip_reputation
    properties:
      si_ip_reputation:
        type: array
        items:
          $ref: '#/definitions/si_ip_reputation'
    title: getsi_ip_reputationsResponse
    example:
      si_ip_reputation:
        violation_action: "Blocked"
        name: "name_1.1.1.1"
        violation_type: "Type"
        iprep_severity: "Critcal"
        iprep_attack_time: "1580886160"
        rpt_sample_time: "1580886160"
        si_device_ip_address: "1.1.1.1"
        iprep_app_threat_index: "1.0"
        __count: "1.0"
        iprep_reputation_score: "IP Reputation"
        attack_category: "Denial of Service"
        iprep_category: "Name"
        source_ip_address: "1.1.1.1"
        total_attacks: "1.0"
        iprep_http_method: "GET"

  si_ip_reputation_readwrite:
    type: object
    properties:
      violation_action:
        description: "Violation Action"
        type: string
        format: string
        maxLength: 255
      name:
        description: "AppName"
        type: string
        format: string
        maxLength: 255
      violation_type:
        description: "Violation Type"
        type: string
        format: string
        maxLength: 255
      iprep_severity:
        description: "Severity"
        type: string
        format: string
        maxLength: 255
      iprep_attack_time:
        description: "Time of Attack"
        type: number
        format: double
      rpt_sample_time:
        description: "Report Sample time."
        type: number
        format: double
      iprep_app_threat_index:
        description: "App Threat Index"
        type: number
        format: double
      __count:
        description: "Number of records"
        type: number
        format: double
      iprep_reputation_score:
        description: "Reputation Score of IP"
        type: number
        format: string
      attack_category:
        description: "Attack Category"
        type: string
        format: string
        maxLength: 255
      iprep_category:
        description: "Category of the IPREP"
        type: string
        format: string
        maxLength: 255
      source_ip_address:
        description: "source_ip_address"
        type: string
        format: ipaddress
        maxLength: 255
      total_attacks:
        description: "total attacks."
        type: number
        format: double
      iprep_http_method:
        description: "HTTP Req method"
        type: string
        format: string
        maxLength: 255

  si_ip_reputation:
    allOf:
      - $ref: '#/definitions/si_ip_reputation_readwrite'

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