swagger: '2.0'
info:
  description: Configuration for AF Threat Data Report table resource.
  version: 'v2'
  title: si_security_violation
host: 'adm.cloud.com'
schemes:
 - https
# tags are used for organizing operations
tags:
  - name: si_security_violation
    description: AF Threat Data 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_security_violation:
    get:
      tags:
        - si_security_violation
      summary: GET all si_security_violation
      operationId: getall_si_security_violation
      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_security_violation 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_security_violation 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_security_violation resources.
          enum:
            - yes
      responses:
        200:
          description:  for si_security_violation
          schema: 
              $ref: '#/definitions/getsi_security_violationsResponse'
        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_security_violationResponse:
    type: object
    required:
      - si_security_violation
    properties:
      si_security_violation:
        $ref: '#/definitions/si_security_violation'
    title: getsi_security_violationResponse
    example:
      si_security_violation:
        violation_action: "Blocked"
        threat_index: "1.0"
        not_blocked_flags: "1.0"
        violation_value: "Value"
        name: "app_1.1.1.1"
        violation_name: "Name"
        violation_threat_index: "4.0"
        si_device_ip_address: "1.1.1.1"
        transformed_flags: "1.0"
        si_app_unit_name: "app_1.1.1.1"
        __count: "1.0"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        attack_category: "Denial of Service"
        block_flags: "1.0"
        severity: "5.0"
        total_attacks: "1.0"

  getsi_security_violationsResponse:
    type: object
    required:
      - si_security_violation
    properties:
      si_security_violation:
        type: array
        items:
          $ref: '#/definitions/si_security_violation'
    title: getsi_security_violationsResponse
    example:
      si_security_violation:
        violation_action: "Blocked"
        threat_index: "1.0"
        not_blocked_flags: "1.0"
        violation_value: "Value"
        name: "app_1.1.1.1"
        violation_name: "Name"
        violation_threat_index: "4.0"
        si_device_ip_address: "1.1.1.1"
        transformed_flags: "1.0"
        si_app_unit_name: "app_1.1.1.1"
        __count: "1.0"
        id: "c970e730-6bc5-44c2-a2bf-8dd1382ffb5f"
        attack_category: "Denial of Service"
        block_flags: "1.0"
        severity: "5.0"
        total_attacks: "1.0"

  si_security_violation_readwrite:
    type: object
    properties:
      violation_action:
        description: "violation_action"
        type: string
        format: string
        maxLength: 255
      threat_index:
        description: "Threat Index"
        type: number
        format: double
      not_blocked_flags:
        description: "Not Block Flags."
        type: number
        format: double
      violation_value:
        description: "Violation Value"
        type: string
        format: string
        maxLength: 255
      name:
        description: "AppName"
        type: string
        format: string
        maxLength: 255
      violation_name:
        description: "violation_name"
        type: string
        format: string
        maxLength: 255
      violation_threat_index:
        description: "Violation Threat Index."
        type: number
        format: double
      transformed_flags:
        description: "Transformed Flags."
        type: number
        format: double
      si_app_unit_name:
        description: "AppName"
        type: string
        format: string
        maxLength: 255
      __count:
        description: "Number of records"
        type: number
        format: double
      attack_category:
        description: "attack_category"
        type: string
        format: string
        maxLength: 255
      block_flags:
        description: "Block Flags."
        type: number
        format: double
      severity:
        description: "severity."
        type: number
        format: double
      total_attacks:
        description: "total attacks."
        type: number
        format: double

  si_security_violation:
    allOf:
      -
        properties:
          id:
            description: Id is Security check violation name
            type: string
            format: uuid
      - $ref: '#/definitions/si_security_violation_readwrite'

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