old_console/schema.yml

openapi: 3.0.3
info:
  title: ARMA Management Console API
  version: 1.1.0-rc22
  description: ARMA Management Console API
paths:
  /en/api/asset/authorize:
    post:
      operationId: api_asset_authorize_create
      description: |
        API for authorizing assets by changing its status from NEW to ALLOWED.
        
        Permisions requred:
          - Can view list actives        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - asset
      security:
      - asset_permissions: [can_view_assets_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /en/api/asset/elements/:
    get:
      operationId: api_asset_elements_list
      description: |-
        Show Active List.

        Permisions requred: 
        - "Can view list active";        

      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - asset
      security:
      - asset_permissions:
          - can_view_assets_list
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAssetList'
          description: ''
  /en/api/asset/elements/{id}/:
    delete:
      operationId: api_asset_elements_destroy
      description: |-
        Delete Asset.
        
        Permisions requred:
         - 'Can delete active'        

      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this asset.
        required: true
      tags:
      - asset
      security:
      - asset_permissions:
          - can_delete_asset
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/asset/elements/csv_export/:
    get:
      operationId: api_asset_elements_csv_export_retrieve
      description: |-
        Getting data for json export.
        
        Permisions requred:
        - "Can export actives";         

      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - asset
      security:
      - asset_permissions: [asset_permissions]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CeleryExport_Asset'
          description: ''
  /en/api/asset/groups/:
    get:
      operationId: api_asset_groups_list
      description: |
        Return assrt group list.
        
        Permisions requred:
          - Can view list actives        

      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - asset
      security:
      - asset_permissions: [can_view_assets_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAssetGroupList'
          description: ''
    post:
      operationId: api_asset_groups_create
      description: |
        Create Assert group.
        
        Permisions requred:
          - Can view list actives        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - asset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetGroup'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AssetGroup'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AssetGroup'
        required: true
      security:
      - asset_permissions: [can_view_assets_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetGroup'
          description: ''
  /en/api/asset/groups/{id}/:
    get:
      operationId: api_asset_groups_retrieve
      description: |
        Retrieve asset group.
        
        Permisions requred:
          - Can view list actives        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this asset list group.
        required: true
      tags:
      - asset
      security:
      - asset_permissions: [can_view_assets_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetGroup'
          description: ''
    put:
      operationId: api_asset_groups_update
      description: | 
        Update asssert group.
        
        Permisions requred:
          - Can view list actives
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this asset list group.
        required: true
      tags:
      - asset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetGroup'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AssetGroup'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AssetGroup'
        required: true
      security:
      - asset_permissions: [ can_view_assets_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetGroup'
          description: ''
    patch:
      operationId: api_asset_groups_partial_update
      description: |
        Update assert group 
        
        Permisions requred:
          - Can view list actives        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this asset list group.
        required: true
      tags:
      - asset
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedAssetGroup'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedAssetGroup'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedAssetGroup'
      security:
      - asset_permissions: [ can_view_assets_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetGroup'
          description: ''
    delete:
      operationId: api_asset_groups_destroy
      description: |
        Delete assert group.
        
        Permisions requred:
          - Can view list actives        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this asset list group.
        required: true
      tags:
      - asset
      security:
      - asset_permissions: [ can_view_assets_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/asset/info/:
    get:
      operationId: api_asset_info_list
      description: |
        Returen list assert information.
        
        Permisions requred:
          - Can view list active        

      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - asset
      security:
      - asset_permissions: [can_view_assets_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedAssetInfoList'
          description: ''
  /en/api/asset/info/{id}/:
    get:
      operationId: api_asset_info_retrieve
      description: |
        Retrieve asset information.
        
        Permisions requred:
          - Can view active        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this asset.
        required: true
      tags:
      - asset
      security:
      - asset_permissions: [can_view_asset]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetInfo'
          description: ''
  /en/api/asset/os/:
    get:
      operationId: api_asset_os_list
      description: |-
        Return list of Operation System
        
        Permisions requred:
          - Can view the list of correlation rules        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - asset
      security:
      - asset_permissions: [can_view_correlation_rules_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOsList'
          description: ''
  /en/api/asset/problems/{id}/:
    get:
      operationId: api_asset_problems_retrieve
      description: |
        Retrieve vulnerabilities information.
        
        Permisions requred:
          - Can view vulnerabilities        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this asset.
        required: true
      tags:
      - asset
      security:
      - asset_permissions: [can_view_vulnerabilities]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetActiveProblems'
          description: ''
  /en/api/auth/token/:
    post:
      operationId: api_auth_token_create
      tags:
      - auth
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AuthToken'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AuthToken'
          application/json:
            schema:
              $ref: '#/components/schemas/AuthToken'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthToken'
          description: ''
  /en/api/celery/{task_id}/:
    get:
      operationId: api_celery_retrieve
      description: |-
        Check that celery task is finished
        :param task_id: Celery task ID        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: task_id
        schema:
          type: string
        required: true
      tags:
      - celery
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CeleryTaskData'
          description: ''
  /en/api/connections/:
    get:
      operationId: api_connections_list
      description: |-
        Return Information list of connections
        
        Permisions requred:
          - Can view network structure        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - connections
      security:
      - connection_permissions: ['can_view_network']
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedConnectionList'
          description: ''
  /en/api/connections/{id}/:
    get:
      operationId: api_connections_retrieve
      description: |-
        Retrieve Connection information
        
        Permisions requred: 
          - Can view network structure        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this connection.
        required: true
      tags:
      - connections
      security:
      - connection_permissions: ['can_view_network']
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Connection'
          description: ''
  /en/api/dashboard/layout/:
    get:
      operationId: api_dashboard_layout_list
      description: |
        ViewSet for handling all operations with dashboard layout
        
        Permisions requred:
          - Can add widgets        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_add_widgets]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Dashboard'
          description: ''
    post:
      operationId: api_dashboard_layout_create
      description: |
        ViewSet for handling all operations with dashboard layout
        
        Permisions requred:
          - Can add widgets        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - dashboard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dashboard'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dashboard'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Dashboard'
        required: true
      security:
      - dashboard_permissions: [can_add_widgets]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: ''
  /en/api/dashboard/layout/{id}/:
    get:
      operationId: api_dashboard_layout_retrieve
      description: |
        ViewSet for handling all operations with dashboard layout
        
         Permisions requred:
          - Can add widgets        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard layout.
        required: true
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_add_widgets]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: ''
    put:
      operationId: api_dashboard_layout_update
      description: |
        ViewSet for handling all operations with dashboard layout.
        Permisions requred:
          - Can add widgets        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard layout.
        required: true
      tags:
      - dashboard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Dashboard'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Dashboard'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Dashboard'
        required: true
      security:
      - dashboard_permissions: [can_add_widgets]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: ''
    patch:
      operationId: api_dashboard_layout_partial_update
      description: | 
        ViewSet for handling all operations with dashboard layout.
        
        Permisions requred:
          - Can add widgets
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this dashboard layout.
        required: true
      tags:
      - dashboard
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedDashboard'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedDashboard'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedDashboard'
      security:
      - dashboard_permissions: [can_add_widgets]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Dashboard'
          description: ''
  /en/api/dashboard/redis/events_by_time/data-events_by_time_redis_data:
    get:
      operationId: api_dashboard_redis_events_by_time_data_retrieve
      description: |
        Events by time widget api
        
        Permisions requred:
          - Can add widgets        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_add_widgets]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /en/api/dashboard/redis/incs_by_time/data:
    get:
      operationId: api_dashboard_redis_incs_by_time_data_retrieve
      description: |
        Incidendts by time widget api
        
        Permisions requred:
          - Can add widgets        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_add_widgets]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /en/api/dashboard/widgets/assets_by_incs/:
    get:
      operationId: api_dashboard_widgets_assets_by_incs_list
      description: |
        Permisions requred:
          - Can add widgets        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_add_widgets]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AssetsByIncidents'
          description: ''
  /en/api/dashboard/widgets/correlator:
    get:
      operationId: api_dashboard_widgets_correlator_retrieve
      description: |-
        Reture Correlator statistic for dashboard
        
        Permisions requred:
          - Can view the list of correlation rules        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_view_correlation_rules_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardCorrelator'
          description: ''
  /en/api/dashboard/widgets/incs_by_cat/:
    get:
      operationId: api_dashboard_widgets_incs_by_cat_list
      description: |
        Return count incidents by category
        
         Permisions requred:
          - Can view incidents        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_view_incidents]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IncidentsByCategory'
          description: ''
  /en/api/dashboard/widgets/incs_by_importance/:
    get:
      operationId: api_dashboard_widgets_incs_by_importance_retrieve
      description: |
        Data source for incidents by importance widget
        
        Permisions requred:
          - Can view incidents        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_view_incidents]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardIncidentsByImportance'

          description: No response body
  /en/api/dashboard/widgets/opened_incs/:
    get:
      operationId: api_dashboard_widgets_opened_incs_retrieve
      description: | 
        Count of open incident
        
         Permisions requred:
         - Can view incidents
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_view_incidents]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardOpenIncident'
          description: ''
  /en/api/dashboard/widgets/services_info/:
    get:
      operationId: api_dashboard_widgets_services_info_retrieve
      description: | 
        Data source for services widget
        
        Permisions requred:
        - Can view system information
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_view_sys_info]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardSerivcesInfo'
          description: ''
  /en/api/dashboard/widgets/sys_info/:
    get:
      operationId: api_dashboard_widgets_sys_info_retrieve
      description: | 
        Data source for system information widget
        
        Permisions requred:
          - Can view system information
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_view_sys_info]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardSystemInfo'
          description: ''
  /en/api/dashboard/widgets/top_ids_events/:
    get:
      operationId: api_dashboard_widgets_top_ids_events_retrieve
      description: |
        Return top incident. Warning now not implemented
        
        Permisions requred:
          - Can view events        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - dashboard
      security:
      - dashboard_permissions: [can_view_events]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DashboardTOPIDs'
          description: ''
  /en/api/endpoint/:
    get:
      operationId: api_endpoint_list
      description: | 
        Return endpoint list
        
        Permisions requred:
         - Can view list of endpoints (can_view_endpoints_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - endpoint
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEndpointList'
          description: ''
    post:
      operationId: api_endpoint_create
      description: |
        Create Endpoint

        Permisions requred:
          - Can add endpoint (can_add_endpoint)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Endpoint'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Endpoint'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Endpoint'
        required: true
      security:
      - endpoint_permissions: [can_add_endpoint]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
          description: ''
  /en/api/endpoint/{id}/:
    get:
      operationId: api_endpoint_retrieve
      description: |
        Retrieve enpoint data
        
        Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
          description: ''
    put:
      operationId: api_endpoint_update
      description: |
        Edit endpoint data
        
        Permisions requred:
          - Can change endpoint config (can_edit_endpoint)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Endpoint'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Endpoint'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Endpoint'
        required: true
      security:
      - endpoint_permissions: [can_edit_endpoint]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
          description: ''
    patch:
      operationId: api_endpoint_partial_update
      description: | 
        Edit endpoint data
        
        Permisions requred:
          - Can change endpoint config (can_edit_endpoint)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedEndpoint'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedEndpoint'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedEndpoint'
      security:
      - endpoint_permissions: [can_edit_endpoint]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Endpoint'
          description: ''
    delete:
      operationId: api_endpoint_destroy
      description: | 
        Delete endpoint
        
        Permisions requred:
          - Can delete endpoint (can_delete_endpoint)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      security:
      - endpoint_permissions: [can_delete_endpoint]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/endpoint/{id}/config_upload_failed/:
    get:
      operationId: api_endpoint_config_upload_failed_retrieve
      description: |-
        Function for setting `request_config` value to False. Used when errors occurring in process of uploading new
            config file from endpoint
        :return: JSON response with `ok` status
        
        Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)        

      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseStatusOk'
          description: ''
  /en/api/endpoint/{id}/download/:
    get:
      operationId: api_endpoint_download_retrieve
      description: |
        Return endpoint settings file json or b64 message
        
        Permisions requred:
          - Can download endpoint config (can_download_endpoint_config)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      security:
      - endpoint_permissions: [can_download_endpoint_config]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointReturnFile'
          description: ''
  /en/api/endpoint/{id}/endpoint_config_request/:
    get:
      operationId: api_endpoint_endpoint_config_request_retrieve
      description: |-
        Function to set the Endpoint flag `request_config` in True state to request current config
            from corresponding Endpoint to update console config model for this Endpoint instance
        :param request: request instance
        :param pk: PK of selected Endpoint
        :return: JSON response with `ok` status
        
        Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseStatusOk'
          description: ''
  /en/api/endpoint/{id}/keepalive/:
    get:
      operationId: api_endpoint_keepalive_retrieve
      description: |
         Permisions requred:
          - Can download endpoint config (can_download_endpoint_config)         
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      security:
      - endpoint_permissions: [can_download_endpoint_config]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/ResponseStatusOkWithCommand'
                  - $ref: '#/components/schemas/ResponseStatusOk'
          description: ''
  /en/api/endpoint/{id}/status/:
    get:
      operationId: api_endpoint_status_retrieve
      description: |-
        Function to respond with current Endpoint states. Current response states are:
            config_errors,
            request_config
        :param request: request instance
        :param pk: Corresponding Endpoint pk
        :return: JSON response with endpoint configuration errors
        
         Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointStatusInfo'
          description: ''
  /en/api/endpoint/{id}/upload/:
    post:
      operationId: api_endpoint_upload_create
      description: |-
        Function to update Endpoint model from received Endpoint config. During the process setting the
            `request_config` flag to False if settings applied correctly
        :param request: request instance with Endpoint config
        :param pk: PK of Endpoint
        :return: JSON response, depending on state of function execution:
            {'status': 'error', 'error_message': 'json decode error'} in case JSON received from Endpoint cannot be read
            {'status': 'error', 'error_message': errors} if setup process failed
            {'status': 'ok'} otherwise
        
         Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Endpoint'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Endpoint'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Endpoint'
        required: true
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseStatusOk'
          description: ''
  /en/api/endpoint/{id}/usb/:
    post:
      operationId: api_endpoint_usb_create
      description: |-
        Function for setting an API anchor for receiving connected USB list from endpoint
        :param request: request endpoint instance
        :param pk: PK of target Endpoint
        :return: JSON response, depending on state of function execution:
            {'status': 'error', 'error_message': 'json decode error'} in case JSON received from Endpoint cannot be read
            {'status': 'error', 'error_message': 'errors'} if provided USB list is not in correct JSON format
            {'status': 'ok'} otherwise
        Permisions requred:
         - Can view list of endpoints (can_view_endpoints_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Endpoint'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Endpoint'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Endpoint'
        required: true
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseStatusOk'
          description: ''
  /en/api/endpoint/config/:
    get:
      operationId: api_endpoint_config_list
      description: |
        API for getting necessary endpoint config fields
        Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - endpoint
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedEndpointConfigList'
          description: ''
  /en/api/endpoint/usb/settings/classes/{id}/:
    get:
      operationId: api_endpoint_usb_settings_classes_retrieve
      description: |
        API for getting and updating USB device classes and subclasses
          allow/block statuses
        
         Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)        
      parameters:
        - in: query
          name: format
          schema:
            type: string
            enum:
              - datatables
              - json
        - in: path
          name: id
          schema:
            type: integer
          description: A unique integer value identifying this endpoint.
          required: true
      tags:
        - endpoint
      security:
        - endpoint_permissions: [can_view_endpoints_list]
        - cookieAuth: []
        - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointUsbClassesSetup'
          description: ''
    put:
      operationId: api_endpoint_usb_settings_classes_update
      description: | 
        API for getting and updating USB device classes and subclasses allow/block statuses
        
         Permisions requred:
           - Can view list of endpoints (can_view_endpoints_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointUsbClassesSetup'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EndpointUsbClassesSetup'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EndpointUsbClassesSetup'
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointUsbClassesSetup'
          description: ''
    patch:
      operationId: api_endpoint_usb_settings_classes_partial_update
      description: | 
        API for getting and updating USB device classes and subclasses allow/block statuses
        
        Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUsbClassesSetup'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUsbClassesSetup'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUsbClassesSetup'
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointUsbClassesSetup'
          description: ''
  /en/api/endpoint/usb/settings/devices/{id}/:
    get:
      operationId: api_endpoint_usb_settings_devices_retrieve
      description: | 
        Permisions requred:
        - Can view list of endpoints(can_view_endpoints_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointUsbDevices'
          description: ''
  /en/api/endpoint/usb/settings/table/classes/{id}/:
    put:
      operationId: api_endpoint_usb_settings_table_classes_update
      description: | 
        API for updating allow/block status for selected by user class
        Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointUpdateClassesSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EndpointUpdateClassesSettings'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EndpointUpdateClassesSettings'
        required: true
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointUpdateClassesSettings'
          description: ''
    patch:
      operationId: api_endpoint_usb_settings_table_classes_partial_update
      description: | 
        API for updating allow/block status for selected by user class
        
        Permisions requred:
                 - Can view list of endpoints (can_view_endpoints_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUpdateClassesSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUpdateClassesSettings'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUpdateClassesSettings'
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointUpdateClassesSettings'
          description: ''
  /en/api/endpoint/usb/settings/table/storage/{id}/:
    put:
      operationId: api_endpoint_usb_settings_table_storage_update
      description: | 
        API for updating allow/block status for selected by user storage device
        
        Permisions requred:
          - (can_view_endpoints_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointUsbStorageDevicesSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EndpointUsbStorageDevicesSettings'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EndpointUsbStorageDevicesSettings'
        required: true
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointUsbStorageDevicesSettings'
          description: ''
    patch:
      operationId: api_endpoint_usb_settings_table_storage_partial_update
      description: | 
        API for updating allow/block status for selected by user storage device
        
        Permisions requred:
          - (can_view_endpoints_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUsbStorageDevicesSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUsbStorageDevicesSettings'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUsbStorageDevicesSettings'
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointUsbStorageDevicesSettings'
          description: ''
  /en/api/endpoint/usb/settings/table/subclasses/{id}/:
    put:
      operationId: api_endpoint_usb_settings_table_subclasses_update
      description: |
        API for updating allow/block status for selected by user HID subclass
        
         Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EndpointUpdateHidSubclassesSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/EndpointUpdateHidSubclassesSettings'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/EndpointUpdateHidSubclassesSettings'
        required: true
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointUpdateHidSubclassesSettings'
          description: ''
    patch:
      operationId: api_endpoint_usb_settings_table_subclasses_partial_update
      description: | 
        API for updating allow/block status for selected by user HID subclass
        
        Permisions requred:
          - Can view list of endpoints (can_view_endpoints_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this endpoint.
        required: true
      tags:
      - endpoint
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUpdateHidSubclassesSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUpdateHidSubclassesSettings'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedEndpointUpdateHidSubclassesSettings'
      security:
      - endpoint_permissions: [can_view_endpoints_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EndpointUpdateHidSubclassesSettings'
          description: ''
  /en/api/event_export/receivers/opcua/:
    get:
      operationId: api_event_export_receivers_opcua_list
      description: |-
         Permisions requred:
          - Can export journals (can_export_events)         
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - event_export
      security:
      - event_export_permissions: [can_export_events]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedOpcuaReceiverList'
          description: ''
  /en/api/event_export/receivers/opcua/{id}/:
    delete:
      operationId: api_event_export_receivers_opcua_destroy
      description: |-
        Permisions requred:
          - Can export journals (can_export_events)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this opcua receiver.
        required: true
      tags:
      - event_export
      security:
      - event_export_permissions: [can_export_events]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/event_export/receivers/syslog/:
    get:
      operationId: api_event_export_receivers_syslog_list
      description: |-
        Permisions requred:
          - Can export journals (can_export_events)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - event_export
      security:
      - event_export_permissions: [can_export_events]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSyslogReceiverList'
          description: ''
  /en/api/event_export/receivers/syslog/{id}/:
    delete:
      operationId: api_event_export_receivers_syslog_destroy
      description: |-
        Permisions requred:
          - Can export journals (can_export_events)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this syslog receiver.
        required: true
      tags:
      - event_export
      security:
      - event_export_permissions: [can_export_events]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/event_export/set_state/{receiver_type}:
    post:
      operationId: api_event_export_set_state_create
      description: |-
        API for setting event receivers export status. The received status will be set to the transmitted receivers
        :param request: request from the web page, request should contain JSON with following structure:
            {
                status: 'true' || 'false',
                id: [1,2,3,...]
            }
        :param receiver_type: receiver type, could be syslog, opcua or email (not implemented yet)
        :return: JSON response with status of API execution
        
        Permisions requred:
          - can_export_events        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: receiver_type
        schema:
          type: string
        required: true
      tags:
      - event_export
      security:
      - event_export_permissions: [can_export_events]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /en/api/groups/{g_name}/add:
    post:
      operationId: api_groups_add_create
      description: |-
        API for adding new group
        :param request: request object
        :param g_name: target group name
        :return: JSON with serialized groups data
        
        Permisions requred:
         - Can add group (can_add_group)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: g_name
        schema:
          type: string
        required: true
      tags:
      - groups
      security:
      - groups_permissions: [can_add_group]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOnlyName'
          description: ''
  /en/api/groups/{g_name}/copy/{new_g_name}:
    post:
      operationId: api_groups_copy_create
      description: |-
        API for copying the target group
        :param request: request object
        :param g_name: target group name
        :param new_g_name: new target group name
        
        Permisions requred:
          - Can add group (can_add_group)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: g_name
        schema:
          type: string
        required: true
      - in: path
        name: new_g_name
        schema:
          type: string
        required: true
      tags:
      - groups
      security:
      - groups_permissions: [can_add_group]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOnlyName'
          description: ''
  /en/api/groups/{g_name}/remove:
    post:
      operationId: api_groups_remove_create
      description: |-
        API for deleting the group
        :param request: request object
        :param g_name: target group name
        :return: JSON with serialized groups data
        
        Permisions requred:
          - Can add group (can_add_group)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: g_name
        schema:
          type: string
        required: true
      tags:
      - groups
      security:
      - groups_permissions: [can_add_group]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOnlyName'
          description: ''
  /en/api/groups/{g_name}/rename/{new_g_name}:
    post:
      operationId: api_groups_rename_create
      description: |-
        API for renaming the target group
        :param request: request object
        :param g_name: target group name
        :param new_g_name: new target group name
        
        Permisions requred:
          - Can add group (can_add_group)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: g_name
        schema:
          type: string
        required: true
      - in: path
        name: new_g_name
        schema:
          type: string
        required: true
      tags:
      - groups
      security:
      - groups_permissions: [can_add_group]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOnlyName'
          description: ''
  /en/api/groups/{g_name}/udpate/users:
    post:
      operationId: api_groups_udpate_users_create
      description: |-
        API for updating the group users set
        :param request: request object
        :param g_name: target group name from the user
        :return: JSON with serialized users data
        
        Permisions requred:
          - Can add group (can_add_group)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: g_name
        schema:
          type: string
        required: true
      tags:
      - groups
      security:
      - groups_permissions: [can_add_group]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
               $ref: '#/components/schemas/UserSerializers'
          description: ''
  /en/api/groups/{g_name}/update/perms:
    post:
      operationId: api_groups_update_perms_create
      description: |-
        API for updating target group permissions with the information, that user provided
        :param request: request object
        :param g_name: target group name
        :return: JSON with serialized permissions data
        
        Permisions requred:
          - Can add group (can_add_group)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: g_name
        schema:
          type: string
        required: true
      tags:
      - groups
      security:
      - groups_permissions: [can_add_group]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ALLPermsSerializer'
          description: No response body
  /en/api/incident/category/:
    get:
      operationId: api_incident_category_list
      description: |-
        Return incident category
        Permisions requred:
          - Can view incident list (can_view_incidents_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - incident
      security:
      - incident_permissions: [can_view_incidents_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedIncidentCategoryList'
          description: ''
  /en/api/incident/effects/:
    get:
      operationId: api_incident_effects_list
      description: |-
        Return incident effects.
        Permisions requred:
          - Can view incident list (can_view_incidents_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - incident
      security:
      - incident_permissions: [can_view_incidents_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedIncidentEffectList'
          description: ''
  /en/api/incident/recommendations/:
    get:
      operationId: api_incident_recommendations_list
      description: |-
        Recommendations how to close incident
        
        Permisions requred:
          - Can work with incidents (can_work_with_incidents)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - incident
      security:
      - incident_permissions: [can_work_with_incidents]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedIncidentRecommendationsList'
          description: ''
  /en/api/incidents/:
    get:
      operationId: api_incidents_list
      description: |-
        Return incident list        
      
        Permisions requred:
          - Can view incident list(can_view_incidents_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - incident
      security:
      - incident_permissions: [can_view_incidents_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedIncidentList'
          description: ''
  /en/api/incidents/{incident_id}/:
    get:
      operationId: api_incidents_retrieve
      description: |-
        Retrieve incident data
        
         Permisions requred:
          - Can view incidents (can_view_incidents)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: incident_id
        schema:
          type: string
          format: uuid
          title: ID
          description: ID of incident
        required: true
      tags:
      - incident
      security:
      - incident_permissions: [Can view incidents]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
          description: ''
  /en/api/incidents/csv_export/:
    get:
      operationId: api_incidents_csv_export_retrieve
      description: |-
        Getting incident data for csv export
        
        Permisions requred:
          - Can export incident list(can_export_incidents_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - incident
      security:
      - incident_permissions: [can_export_incidents_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CeleryExport_Asset'
          description: ''
  /en/api/logstash/asset/:
    post:
      operationId: api_logstash_asset_create
      description: |
        Create asset view
        
        Permisions requred:
          - Can edit active(can_edit_asset)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssetCorrelation'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AssetCorrelation'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/AssetCorrelation'
        required: true
      security:
      - logstesh_permissions: [can_edit_asset]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssetCorrelation'
          description: ''
  /en/api/logstash/group/:
    get:
      operationId: api_logstash_group_list
      description: |-
        Need to set objects as string in restrict_objects

        This mixin check that `?pk=12` pk can be accessed.
        Name of `pk` is stored in request_pk_name.

        Example:
            class TestViewSet(RestrictByPKViewMixin, ...):
                restrict_objects = {
                    "delete": ["1"],
                    "post": ["1"]
                }

        Now, when post or delete requests are received,
        
        Permisions requred:
          - Can view input list(can_view_input_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - logstash
      security:
      - logstesh_permissions: [can_view_input_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedGroupList'
          description: ''
    post:
      operationId: api_logstash_group_create
      description: |-
        Need to set objects as string in restrict_objects

        This mixin check that `?pk=12` pk can be accessed.
        Name of `pk` is stored in request_pk_name.

        Example:
            class TestViewSet(RestrictByPKViewMixin, ...):
                restrict_objects = {
                    "delete": ["1"],
                    "post": ["1"]
                }

        Now, when post or delete requests are received,
        
        Permisions requred:
          - Can view input list (can_view_input_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Group'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Group'
        required: true
      security:
      - logstesh_permissions: [can_view_input_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
  /en/api/logstash/group/{id}/:
    get:
      operationId: api_logstash_group_retrieve
      description: |-
        Need to set objects as string in restrict_objects

        This mixin check that `?pk=12` pk can be accessed.
        Name of `pk` is stored in request_pk_name.

        Example:
            class TestViewSet(RestrictByPKViewMixin, ...):
                restrict_objects = {
                    "delete": ["1"],
                    "post": ["1"]
                }

        Now, when post or delete requests are received,
        
        Permisions requred:
          - Can view input list (can_view_input_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this group.
        required: true
      tags:
      - logstash
      security:
      - logstesh_permissions: [can_view_input_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
    put:
      operationId: api_logstash_group_update
      description: |-
        Need to set objects as string in restrict_objects

        This mixin check that `?pk=12` pk can be accessed.
        Name of `pk` is stored in request_pk_name.

        Example:
            class TestViewSet(RestrictByPKViewMixin, ...):
                restrict_objects = {
                    "delete": ["1"],
                    "post": ["1"]
                }

        Now, when post or delete requests are received,
        
        Permisions requred:
         - Can edit correlation groups (can_edit_correlation_groups)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this group.
        required: true
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Group'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Group'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Group'
        required: true
      security:
      - logstesh_permissions: [can_edit_correlation_groups]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
    patch:
      operationId: api_logstash_group_partial_update
      description: |-
        Need to set objects as string in restrict_objects

        This mixin check that `?pk=12` pk can be accessed.
        Name of `pk` is stored in request_pk_name.

        Example:
            class TestViewSet(RestrictByPKViewMixin, ...):
                restrict_objects = {
                    "delete": ["1"],
                    "post": ["1"]
                }

        Now, when post or delete requests are received,
        
        Permisions requred:
          - Can edit correlation groups (can_edit_correlation_groups)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this group.
        required: true
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedGroup'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedGroup'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedGroup'
      security:
      - logstesh_permissions: [can_edit_correlation_groups]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Group'
          description: ''
    delete:
      operationId: api_logstash_group_destroy
      description: |-
        Need to set objects as string in restrict_objects

        This mixin check that `?pk=12` pk can be accessed.
        Name of `pk` is stored in request_pk_name.

        Example:
            class TestViewSet(RestrictByPKViewMixin, ...):
                restrict_objects = {
                    "delete": ["1"],
                    "post": ["1"]
                }

        Now, when post or delete requests are received,
        
        Permisions requred:
          - Can view input list (can_view_input_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this group.
        required: true
      tags:
      - logstash
      security:
      - logstesh_permissions: [can_view_input_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/logstash/incident/:
    post:
      operationId: api_logstash_incident_create
      description: | 
        Create logstesh incident
        
        Permisions requred:
          - Can work with incidents (can_work_with_incidents)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Incident'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Incident'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Incident'
        required: true
      security:
      - logstesh_permissions: [can_work_with_incidents]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Incident'
          description: ''
  /en/api/logstash/input/:
    get:
      operationId: api_logstash_input_list
      description: | 
        Api for getting/creatin and edit log input data

        Permisions requred:
          - Can view input (listcan_view_input_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - logstash
      security:
      - logstesh_permissions: [listcan_view_input_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedInputList'
          description: ''
    post:
      operationId: api_logstash_input_create
      description: |
        Api for getting/creatin and edit log input data

        Permisions requred:
          - Can add input(can_add_input)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Input'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Input'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Input'
        required: true
      security:
      - logstesh_permissions: [can_add_input]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Input'
          description: ''
  /en/api/logstash/input/{id}/:
    get:
      operationId: api_logstash_input_retrieve
      description: |
        Api for getting/creatin and edit log input data

        Permisions requred:
          - Can view input list (can_view_input_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this log input.
        required: true
      tags:
      - logstash
      security:
      - logstesh_permissions: [can_view_input_list]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Input'
          description: ''
    put:
      operationId: api_logstash_input_update
      description: |
        Api for getting/creatin and edit log input data

        Permisions requred:
          - Can edit input (can_edit_input)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this log input.
        required: true
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Input'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Input'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Input'
        required: true
      security:
      - logstesh_permissions: [can_edit_input]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Input'
          description: ''
    patch:
      operationId: api_logstash_input_partial_update
      description: | 
        Api for getting/creatin and edit log input data

        Permisions requred:
          - Can edit input (can_edit_input)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this log input.
        required: true
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedInput'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedInput'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedInput'
      security:
      - logstesh_permissions: [can_edit_input]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Input'
          description: ''
    delete:
      operationId: api_logstash_input_destroy
      description: |
        Api for getting/creatin and edit log input data

        Permisions requred:
         - Can delete input(can_delete_input)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this log input.
        required: true
      tags:
      - logstash
      security:
      - logstesh_permissions: [can_delete_input]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/logstash/manufacturer/:
    get:
      operationId: api_logstash_manufacturer_list
      description: |
        Permisions requred:
          - Can edit active(can_edit_asset)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - logstash
      security:
      - logstesh_permissions: [can_edit_asset]
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedManufacturerList'
          description: ''
  /en/api/logstash/rule/data/:
    get:
      operationId: api_logstash_rule_data_list
      description: | 
        API For getting/creating/ and edding correlator rule
        
        Permisions requred:
          - Can view the list of correlation rules (can_view_correlation_rules_list)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - logstash
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedRuleList'
          description: ''
    post:
      operationId: api_logstash_rule_data_create
      description: |
        API For getting/creating/ and edding correlator rule

        Permisions requred:
         - Can create and edit correlation rules (can_create_and_edit_correlation_rule)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Rule'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Rule'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Rule'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
          description: ''
  /en/api/logstash/rule/data/{id}/:
    get:
      operationId: api_logstash_rule_data_retrieve
      description: |
        API For getting/creating/ and edding correlator rule
        
        Permisions requred:
          - Can view the correlation rule card (can_view_correlation_rule_card)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this rule.
        required: true
      tags:
      - logstash
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
          description: ''
    put:
      operationId: api_logstash_rule_data_update
      description: |
        API For getting/creating/ and edding correlator rule

        Permisions requred:
          - Can create and edit correlation rules (can_create_and_edit_correlation_rule)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this rule.
        required: true
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Rule'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Rule'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Rule'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
          description: ''
    patch:
      operationId: api_logstash_rule_data_partial_update
      description: |
        API For getting/creating/ and edding correlator rule

        Permisions requred:
          - Can create and edit correlation rules (can_create_and_edit_correlation_rule)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this rule.
        required: true
      tags:
      - logstash
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedRule'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedRule'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedRule'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Rule'
          description: ''
    delete:
      operationId: api_logstash_rule_data_destroy
      description: |
        API For getting/creating/ and edding correlator rule
        
        Permisions requred: 
          - Can delete correlation rules (can_delete_correlation_rules)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this rule.
        required: true
      tags:
      - logstash
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/logstash/rule/export/json_export/:
    get:
      operationId: api_logstash_rule_export_json_export_retrieve
      description: |
        Export Json file with ruel
        
        Permisions requred:
          - Can create and edit correlation rules(can_create_and_edit_correlation_rule)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - logstash
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RuleExport'
          description: ''
  /en/api/logstash/vulnerabilities/:
    get:
      operationId: api_logstash_vulnerabilities_list
      description: |
        Return list of vulnerabilities
        
        Permisions requred:  
          - Can view vulnerabilities (can_view_vulnerabilities)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - logstash
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedVulnerabilitiesList'
          description: ''
  /en/api/netmap/auto/connections/:
    get:
      operationId: api_netmap_auto_connections_list
      description: |-
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AutoNetmapConnections'
          description: ''
  /en/api/netmap/auto/elements/:
    get:
      operationId: api_netmap_auto_elements_list
      description: |-
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AutoNetmapElements'
          description: ''
  /en/api/netmap/background_image/get/{background_pk}:
    get:
      operationId: api_netmap_background_image_get_retrieve
      description: |
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: path
        name: background_pk
        schema:
          type: integer
        required: true
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /en/api/netmap/delete/{id}:
    delete:
      operationId: api_netmap_delete_destroy
      description: |
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        required: true
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/netmap/groups/:
    get:
      operationId: api_netmap_groups_list
      description: |-
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NetmapGroup'
          description: ''
  /en/api/netmap/images/:
    get:
      operationId: api_netmap_images_list
      description: |
        ViewSet for handling the networkmap background image data manipulation
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedNetworkMapBackgroundImagesList'
          description: ''
  /en/api/netmap/images/{id}/:
    get:
      operationId: api_netmap_images_retrieve
      description: |
        ViewSet for handling the networkmap background image data manipulation
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this network map background
          image.
        required: true
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapBackgroundImages'
          description: ''
    put:
      operationId: api_netmap_images_update
      description: |
        ViewSet for handling the networkmap background image data manipulation
        
        Permisions requred:
         - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this network map background
          image.
        required: true
      tags:
      - netmap
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkMapBackgroundImages'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NetworkMapBackgroundImages'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NetworkMapBackgroundImages'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapBackgroundImages'
          description: ''
    patch:
      operationId: api_netmap_images_partial_update
      description: | 
        ViewSet for handling the networkmap background image data manipulation
        Permisions requred:
          - Can view network structure (can_view_network)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this network map background
          image.
        required: true
      tags:
      - netmap
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedNetworkMapBackgroundImages'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedNetworkMapBackgroundImages'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedNetworkMapBackgroundImages'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapBackgroundImages'
          description: ''
  /en/api/netmap/images/delete_background_image/:
    post:
      operationId: api_netmap_images_delete_background_image_create
      description: |-
        Method for handling <router-url>-delete-background-image request for deleting existing background image
        for current network map. Request always should contain 'current_map_id' and 'image_data' fields.
        :param request: request instance that must contains 'current_map_id' and 'image_data' fields. Image_data must
            contain background image ID
        :return: JsonResponse with 'ok' status if everything works as expected, or with error message and 'err' status
            otherwise
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - netmap
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkMapBackgroundImages'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NetworkMapBackgroundImages'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NetworkMapBackgroundImages'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapBackgroundImages'
          description: ''
  /en/api/netmap/images/update_image_data/:
    post:
      operationId: api_netmap_images_update_image_data_create
      description: |-
        Method for handling <router-url>-update-image-data request for updating background image data fields value
        in Database. Request always should contain 'current_map_id' and 'image_data' fields.
        :param request: request instance that must contains 'current_map_id' and 'image_data' fields. Image_data should
            be in support images format (cytoscape framework that is used for managing network map background images)
        :return: JsonResponse with 'ok' status if everything works as expected, or with error message and 'err' status
            otherwise
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - netmap
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NetworkMapBackgroundImages'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/NetworkMapBackgroundImages'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/NetworkMapBackgroundImages'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NetworkMapBackgroundImages'
          description: ''
  /en/api/netmap/in-danger/:
    get:
      operationId: api_netmap_in_danger_list
      description: |-
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AssetDanger'
          description: ''
  /en/api/netmap/maps/:
    get:
      operationId: api_netmap_maps_list
      description: |-
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedUserMapList'
          description: ''
  /en/api/netmap/maps/{id}/:
    get:
      operationId: api_netmap_maps_retrieve
      description: |-
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this network map.
        required: true
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMap'
          description: ''
    put:
      operationId: api_netmap_maps_update
      description: |-
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this network map.
        required: true
      tags:
      - netmap
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserMap'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserMap'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserMap'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMap'
          description: ''
    patch:
      operationId: api_netmap_maps_partial_update
      description: |-
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this network map.
        required: true
      tags:
      - netmap
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedUserMap'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedUserMap'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedUserMap'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMap'
          description: ''
  /en/api/netmap/static/elements/:
    get:
      operationId: api_netmap_static_elements_list
      description: |-
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/NetmapElements'
          description: ''
  /en/api/netmap/user:
    get:
      operationId: api_netmap_user_retrieve
      description: |-
        API for getting network maps for specific user
        :param request: request object
        :return: list of group names for current user
        
        Permisions requred:
          - Can view network structure (can_view_network)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - netmap
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          description: No response body
  /en/api/sensors/sensor/info/:
    get:
      operationId: api_sensors_sensor_info_list
      description: |
        Permisions requred:
        - Can view sensors list (can_view_sensors_lis)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - sensors
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSensorInfoList'
          description: ''
  /en/api/sensors/sensor/info/{id}/:
    get:
      operationId: api_sensors_sensor_info_retrieve
      description: |
        Permisions requred:
          - Can view sensors list (can_view_sensors_lis)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this sensor info.
        required: true
      tags:
      - sensors
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SensorInfo'
          description: ''
  /en/api/sensors/sensors/:
    get:
      operationId: api_sensors_sensors_list
      description: |-
        Permisions requred:
          - Can view sensors list (can_view_sensors_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - sensors
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedSensorList'
          description: ''
    post:
      operationId: api_sensors_sensors_create
      description: |-
        Permisions requred:
          - Can add sensors (can_add_sensors)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - sensors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Sensor'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Sensor'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Sensor'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sensor'
          description: ''
  /en/api/sensors/sensors/{id}/:
    get:
      operationId: api_sensors_sensors_retrieve
      description: |-
        Permisions requred:
        - Can view sensor (can_view_sensors)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this sensor.
        required: true
      tags:
      - sensors
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sensor'
          description: ''
    put:
      operationId: api_sensors_sensors_update
      description: |-
        Permisions requred:
          - Can edit sensor (can_edit_sensor)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this sensor.
        required: true
      tags:
      - sensors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Sensor'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Sensor'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Sensor'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sensor'
          description: ''
    patch:
      operationId: api_sensors_sensors_partial_update
      description: |-
        Permisions requred:
          - Can edit sensor (can_edit_sensor)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this sensor.
        required: true
      tags:
      - sensors
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedSensor'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedSensor'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedSensor'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sensor'
          description: ''
    delete:
      operationId: api_sensors_sensors_destroy
      description: |-
        Permisions requred:
          - Can delete sensors (can_delete_sensors)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this sensor.
        required: true
      tags:
      - sensors
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/settings/events/set/:
    post:
      operationId: api_settings_events_set_create
      description: |
        Permisions requred:
          - can_change_rotation_settings        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - settings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RotationSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RotationSettings'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RotationSettings'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RotationSettings'
          description: ''
  /en/api/settings/incidents/set/:
    post:
      operationId: api_settings_incidents_set_create
      description: |
        Permisions requred:
          - can_change_rotation_settings        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - settings
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RotationSettings'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/RotationSettings'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/RotationSettings'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RotationSettings'
          description: ''
  /en/api/store/:
    get:
      operationId: api_store_list
      description: |-
        Permisions requred:
          - Can view storage (can_view_storage)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: page
        required: false
        in: query
        description: A page number within the paginated result set.
        schema:
          type: integer
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - store
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedStorageList'
          description: ''
    post:
      operationId: api_store_create
      description: |-
        Permisions requred:
          - Can view storage (can_view_storage)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - store
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Storage'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Storage'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Storage'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Storage'
          description: ''
  /en/api/store/{id}/:
    get:
      operationId: api_store_retrieve
      description: |-
        Permisions requred:
          - Can view storage (can_view_storage)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - store
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Storage'
          description: ''
    put:
      operationId: api_store_update
      description: |-
        Permisions requred:
          - Can view storage (can_view_storage)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - store
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Storage'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Storage'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Storage'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Storage'
          description: ''
    patch:
      operationId: api_store_partial_update
      description: |-
        Permisions requred:
          - Can view storage (can_view_storage)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - store
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedStorage'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedStorage'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedStorage'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Storage'
          description: ''
    delete:
      operationId: api_store_destroy
      description: |-
        Permisions requred:
          - Can view storage (can_view_storage)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: string
        required: true
      tags:
      - store
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '204':
          description: No response body
  /en/api/users/active/:
    get:
      operationId: api_users_active_list
      description: |
        ViewSet for handling all operations with dashboard layout
        
        Permisions requred:
          - Can view list of user (can_view_user_list)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - name: search
        required: false
        in: query
        description: A search term.
        schema:
          type: string
      tags:
      - users
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/UserSerializers'
          description: ''
    post:
      operationId: api_users_active_create
      description: | 
        ViewSet for handling all operations with dashboard layout
        
        Permisions requred:
          - Can add new users (can_add_user)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserSerializers'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSerializers'
          description: ''
  /en/api/users/active/{id}/:
    get:
      operationId: api_users_active_retrieve
      description: |
        ViewSet for handling all operations with dashboard layout
        Permisions requred:
          - Can view user credentials (can_view_user)        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this user.
        required: true
      tags:
      - users
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSerializers'
          description: ''
    put:
      operationId: api_users_active_update
      description: | 
        ViewSet for handling all operations with dashboard layout
        Permisions requred:
          - Can edit user credentials (can_edit_user)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this user.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserSerializers'
        required: true
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSerializers'
          description: ''
    patch:
      operationId: api_users_active_partial_update
      description: | 
        ViewSet for handling all operations with dashboard layout
        
        Permisions requred:
          - Can edit user credentials (can_edit_user)
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this user.
        required: true
      tags:
      - users
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedUserSerializers'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/PatchedUserSerializers'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/PatchedUserSerializers'
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserSerializers'
          description: ''
  /en/db/snapshot/download/:
    get:
      operationId: db_snapshot_download_retrieve
      description: |-
        Downloads fixture to restore current DB state, for test and dev purposes only
        request->models allow to control which tables would be downloaded, for example 'auth,console.userinfo        
      parameters:
      - in: query
        name: format
        schema:
          type: string
          enum:
          - datatables
          - json
      tags:
      - db
      security:
      - cookieAuth: []
      - tokenAuth: []
      responses:
        '200':
          description: No response body
components:
  schemas:
    ALLPermsSerializer:
      type: object
      properties:
        name:
          type: string
        codename:
          type: string
        content_type:
          type: integer
    ResponseOnlyName:
      type: object
      properties:
        name:
          type: string
    EndpointStatusInfo:
      type: object
      properties:
        endpoint_config_errors:
          type: object
        is_requested_config_correct:
          type: boolean
    EndpointReturnFile:
      type: string
      format: binary
    ResponseStatusOk:
      type: object
      properties:
        status:
          type: string
          default: ok
    ResponseStatusOkWithCommand:
      type: object
      properties:
        status:
          type: string
          default: ok
        command:
          type: string
          default: upload
    DashboardTOPIDs:
      type: object
      properties:
        top_ids_events:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              amount:
                type: integer
    DashboardSystemInfo:
      type: object
      properties:
        machine_name:
          type: string
          readOnly: true
        operating_system:
          type: string
          readOnly: true
        cpu_model:
          type: string
          readOnly: true
        total_cpu:
          type: number
          format: float
        machine_uptime:
          type: string
          readOnly: true
        server_time:
          type: string
          readOnly: true
        mem_total:
          type: integer
        mem_used:
          type: integer
        disk_total:
          type: integer
        disk_free:
          type: integer
        disk_used:
          type: integer
        console_version:
          type: string
        description:
          type: string
        lc_info:
          type: string
    DashboardSerivcesInfo:
      type: array
      items:
        type: object
        properties:
          user:
            type: string
            readOnly: true
          command:
            type: string
            readOnly: true
          cpu:
            type: string
            readOnly: true
            description: CPU %
    DashboardCorrelator:
      type: object
      properties:
        aggregator:
          type: object
          properties:
            events_processed:
              type: integer
              readOnly: true
            events_aggregated:
              type: integer
              readOnly: true
            average_iteration:
              type: object
              properties:
                value:
                  type: string
        correlator:
          type: object
          properties:
            rule_count:
              type: integer
              readOnly: true
            incident_count:
              type: integer
              readOnly: true
            events_count:
              type: integer
              readOnly: true
            errors:
              type: object
            average_time:
              type: object
              properties:
                value:
                  type: string
            average_rule_time:
              type: array
              items:
                type: object
                properties:
                  value:
                    type: string
                    readOnly: true
                  title:
                    type: string
                    readOnly: true
        status:
          type: boolean
          readOnly: true
    DashboardIncidentsByImportance:
      type: object
      properties:
        importance_none:
          type: integer
        importance_info:
          type: integer
        importance_low:
          type: integer
        importance_medium:
          type: integer
        importance_high:
          type: integer
        importance_critical:
          type: integer
    DashboardOpenIncident:
        type: object
        properties:
          inc_count:
            type: integer
            readOnly: true
    CeleryExport_Asset:
      type: object
      properties:
        task_id:
          type: string
          format: uuid
          readOnly: true
    CeleryTaskData:
      type: object
      properties:
        task_id:
          type: string
          format: uuid
          readOnly: true
        finished:
          type: boolean
          readOnly: true
        result:
          type: integer
          readOnly: true
      required:
        - task_id
    Asset:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        incidents:
          type: string
          readOnly: true
        vulnerabilities:
          type: string
          readOnly: true
        os:
          $ref: '#/components/schemas/Os'
        group:
          $ref: '#/components/schemas/AssetGroup'
        updated:
          type: string
          format: date-time
        asset_type:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
        sensor:
          type: string
          nullable: true
          title: Sensor name
          maxLength: 128
        model:
          type: string
          nullable: true
          description: Asset model
          maxLength: 150
        ip:
          type: string
          description: Asset's IP address
        mac:
          type: string
          nullable: true
          description: Asset's MAC address
          maxLength: 17
        ports:
          type: object
          additionalProperties: {}
          nullable: true
          description: List of open ports
        status:
          allOf:
          - $ref: '#/components/schemas/Status923Enum'
          title: Asset status
          description: Asset allow status
          minimum: -2147483648
          maximum: 2147483647
        manufacturer:
          type: integer
          nullable: true
      required:
      - asset_type
      - group
      - id
      - incidents
      - ip
      - name
      - os
      - updated
      - vulnerabilities
    AssetActiveProblems:
      type: object
      properties:
        incidents:
          type: string
          readOnly: true
        vulnerabilities:
          type: string
          readOnly: true
      required:
      - incidents
      - vulnerabilities
    AssetCorrelation:
      type: object
      properties:
        asset_type:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/AssetTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        description:
          type: string
          nullable: true
          description: Description
        group:
          type: integer
          nullable: true
        ip:
          type: string
          description: Asset's IP address
        manufacturer:
          type: integer
          nullable: true
        model:
          type: string
          nullable: true
          description: Asset model
          maxLength: 150
        name:
          type: string
          maxLength: 128
        os:
          type: integer
          nullable: true
          description: Operation systems, found on asset
        ports:
          type: object
          additionalProperties: {}
          nullable: true
          description: List of open ports
        sensor:
          type: string
          nullable: true
          title: Sensor name
          maxLength: 128
        status:
          allOf:
          - $ref: '#/components/schemas/Status923Enum'
          title: Asset status
          description: Asset allow status
          minimum: -2147483648
          maximum: 2147483647
      required:
      - ip
      - name
    AssetDanger:
      type: object
      properties:
        id:
          type: string
          readOnly: true
      required:
      - id
    AssetGroup:
      type: object
      properties:
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
        id:
          type: integer
          readOnly: true
      required:
      - id
      - name
    AssetInfo:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
        ip:
          type: string
          description: Asset's IP address
        os:
          $ref: '#/components/schemas/OsName'
        ports:
          type: object
          additionalProperties: {}
          nullable: true
          description: List of open ports
        updated:
          type: string
          format: date-time
        vulnerabilities:
          type: array
          items:
            $ref: '#/components/schemas/VulnerabilityTitle'
        incidents:
          type: string
          readOnly: true
        status:
          allOf:
          - $ref: '#/components/schemas/Status923Enum'
          title: Asset status
          description: Asset allow status
          minimum: -2147483648
          maximum: 2147483647
      required:
      - id
      - incidents
      - ip
      - name
      - os
      - updated
      - vulnerabilities
    AssetTypeEnum:
      enum:
      - user
      - arma_industrial_firewall
      - plc
      - pc
      - server
      - network_device
      type: string
    AssetsByIncidents:
      type: object
      description: Serializer for assets by incs widget
      properties:
        name:
          type: string
          maxLength: 128
        inc_count:
          type: string
          readOnly: true
      required:
      - inc_count
      - name
    AuthToken:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
      required:
      - password
      - username
    AutoNetmapConnections:
      type: object
      properties:
        source:
          type: string
          readOnly: true
        target:
          type: string
          readOnly: true
        id:
          type: string
          readOnly: true
      required:
      - id
      - source
      - target
    AutoNetmapElements:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 128
        group:
          type: integer
          nullable: true
        parent:
          type: string
          readOnly: true
        in_danger:
          type: string
          readOnly: true
        asset_type:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/AssetTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        incidents:
          type: array
          items:
            type: string
            format: uuid
            title: ID
        ip:
          type: string
          readOnly: true
      required:
      - id
      - in_danger
      - ip
      - name
      - parent
    BlankEnum:
      enum:
      - ''
    Connection:
      type: object
      properties:
        src_asset:
          $ref: '#/components/schemas/ConnectionAssetInfo'
        dst_asset:
          $ref: '#/components/schemas/ConnectionAssetInfo'
        connection_protocol:
          nullable: true
          description: Connection protocol type
          oneOf:
          - $ref: '#/components/schemas/ConnectionProtocolEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        created:
          type: string
          format: date-time
        updated:
          type: string
          format: date-time
      required:
      - created
      - dst_asset
      - src_asset
      - updated
    ConnectionAssetInfo:
      type: object
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          maxLength: 128
        ip:
          type: string
          description: Asset's IP address
      required:
      - ip
      - name
      - pk
    ConnectionProtocolEnum:
      enum:
      - TCP
      - UDP
      type: string
    Dashboard:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        widgets:
          type: object
          additionalProperties: {}
          description: Widgets
        user:
          type: integer
          description: Owner of dashboard
      required:
      - id
      - user
    Endpoint:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        updated:
          type: string
          format: date-time
          readOnly: true
        status:
          type: string
          readOnly: true
        ip:
          type: string
          description: Device IP address
        config_errors:
          type: object
          additionalProperties: {}
          nullable: true
          title: Endpoint config errors
          description: Full list of Endpoint config errors
      required:
      - id
      - ip
      - name
      - status
      - updated
    EndpointConfig:
      type: object
      properties:
        dc_enabled:
          type: boolean
          title: Enable device control
        ic_enabled:
          type: boolean
          title: Enable integrity control
        scan_folders:
          type: array
          items:
            type: string
            title: Folder
            description: Folder for integrity control
            maxLength: 1024
          nullable: true
        ic_timeout:
          type: integer
          maximum: 86400
          minimum: 0
          title: Event creation timeout
          description: How often we can get integrity control events. Value in seconds
        wl_enable:
          type: boolean
          title: Enable white list
        wl_admin:
          type: boolean
          title: Local admin ignores white list
        white_list:
          type: array
          items:
            type: string
            title: Folder
            description: Folder for white list
            maxLength: 1024
          nullable: true
        updated:
          type: string
          format: date-time
          readOnly: true
        ip:
          type: string
          description: Device IP address
        usb_allowed_storage:
          type: object
          additionalProperties: {}
          title: Allowed USB devices
          description: List of all allowed USB devices for this Endpoint
        usb_connected:
          type: object
          additionalProperties: {}
          nullable: true
          title: Connected USB devices
          description: List of all connected to Endpoint USB devices
        usb_control_enabled:
          type: boolean
          title: Enable USB control
      required:
      - ip
      - updated
    EndpointUpdateClassesSettings:
      type: object
      description: Serializer for USB device class
      properties:
        class_to_change:
          type: integer
          writeOnly: true
        allow_class:
          type: boolean
          writeOnly: true
        usb_allowed_classes:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Allowed USB devices classes
          description: List of all allowed device classes for USB control
      required:
      - allow_class
      - class_to_change
    EndpointUpdateHidSubclassesSettings:
      type: object
      description: Serializer for USB HID device subclass
      properties:
        subclass_to_change:
          type: integer
          writeOnly: true
        allow_subclass:
          type: boolean
          writeOnly: true
        usb_hid_deny_subclasses:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Prohibited USB devices hid subclasses
          description: List of all blocked USB devices hid subclasses for USB control
        usb_hid_allowed_subclasses:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Allowed USB devices hid subclasses
          description: List of all allowed USB devices hid subclasses for USB control
        usb_allowed_classes:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Allowed USB devices classes
          description: List of all allowed device classes for USB control
      required:
      - allow_subclass
      - subclass_to_change
    EndpointUsbClassesSetup:
      type: object
      description: Serializer for Endpoint USB device classes and subclasses data
      properties:
        usb_allowed_classes:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Allowed USB devices classes
          description: List of all allowed device classes for USB control
        usb_hid_deny_subclasses:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Prohibited USB devices hid subclasses
          description: List of all blocked USB devices hid subclasses for USB control
        usb_hid_allow_other_subclasses:
          type: boolean
          title: Allowed USB devices hid subclasses
        usb_hid_allowed_subclasses:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Allowed USB devices hid subclasses
          description: List of all allowed USB devices hid subclasses for USB control
    EndpointUsbDevices:
      type: object
      description: Serializer for parsing usb_devices_list that are we getting from
        user to prepare it for database
      properties:
        usb_devices_list:
          type: string
          readOnly: true
      required:
      - usb_devices_list
    EndpointUsbStorageDevice:
      type: object
      description: Serializer for USB storage device data from frontend
      properties:
        pid:
          type: integer
        vid:
          type: integer
        name:
          type: string
        class_value:
          type: integer
        subclass_value:
          type: integer
        serial_number:
          type: string
      required:
      - class_value
      - name
      - pid
      - serial_number
      - subclass_value
      - vid
    EndpointUsbStorageDevicesSettings:
      type: object
      description: Serializer for USB storage device
      properties:
        storage_device_data:
          allOf:
          - $ref: '#/components/schemas/EndpointUsbStorageDevice'
          writeOnly: true
        allow_storage:
          type: boolean
          writeOnly: true
        usb_allowed_storage:
          type: object
          additionalProperties: {}
          title: Allowed USB devices
          description: List of all allowed USB devices for this Endpoint
      required:
      - allow_storage
      - storage_device_data
    EventReceiver:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/EventReceiverTypeEnum'
          description: Type of receiver
        cef_format:
          type: boolean
          title: CEF formatting
          description: Format using CEF standard
        message_filter:
          type: string
          description: Regular expression for message filtering
          maxLength: 255
        message_min_severity:
          allOf:
          - $ref: '#/components/schemas/MessageMinSeverityEnum'
          title: Message minimum severity level
          description: Minimum event severity level to send
          minimum: -2147483648
          maximum: 2147483647
        export_status:
          type: boolean
          title: Event receiver export status. Could be on or off
          description: Set the event receiver status - on or off
      required:
      - id
    EventReceiverTypeEnum:
      enum:
      - syslog
      - OPC_UA
      type: string
    Group:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
      required:
      - id
      - name
    Incident:
      type: object
      properties:
        user_friendly_id:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          nullable: true
        timestamp:
          type: string
          format: date-time
          description: Date and time, when incident occurs
        incident_id:
          type: string
          format: uuid
          title: ID
          description: ID of incident
        title:
          type: string
          description: Title
          maxLength: 128
        category:
          $ref: '#/components/schemas/IncidentCategory'
        importance:
          type: integer
          maximum: 100
          minimum: 0
          description: Hazard level of incident
        status:
          allOf:
          - $ref: '#/components/schemas/IncidentStatusEnum'
          description: Incident status
          minimum: -2147483648
          maximum: 2147483647
        assigned_to:
          type: string
          readOnly: true
        event_count:
          type: integer
          maximum: 2147483647
          minimum: 1
          title: Event's number
          description: Amount of events in the incident
        created:
          type: string
          format: date-time
          readOnly: true
          description: Date and time, when incident was created
        updated:
          type: string
          format: date-time
          readOnly: true
          description: Date and time, when incident was updated
        events:
          type: object
          additionalProperties: {}
      required:
      - assigned_to
      - category
      - created
      - event_count
      - events
      - importance
      - title
      - updated
    IncidentCategory:
      type: object
      properties:
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
        id:
          type: integer
          readOnly: true
      required:
      - id
      - name
    IncidentEffect:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
      required:
      - id
      - name
    IncidentRecommendations:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
      required:
      - id
      - name
    IncidentStatusEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      type: integer
    IncidentsByCategory:
      type: object
      properties:
        name:
          type: string
          maxLength: 128
        inc_count:
          type: string
          readOnly: true
      required:
      - inc_count
      - name
    Input:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        label:
          type: string
          title: Name
          description: Name of the input
          maxLength: 128
        type:
          type: string
          readOnly: true
        can_delete:
          type: boolean
          description: Can user delete this input
      required:
      - id
      - label
      - type
    Manufacturer:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
      required:
      - id
      - name
    MessageMinSeverityEnum:
      enum:
      - 0
      - 10
      - 40
      - 70
      - 90
      - 100
      type: integer
    MonthEnum:
      enum:
      - january
      - february
      - march
      - april
      - may
      - june
      - july
      - august
      - september
      - october
      - november
      - december
      type: string
    NetmapElements:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 128
        group:
          type: integer
          nullable: true
        parent:
          type: string
          readOnly: true
        in_danger:
          type: string
          readOnly: true
        asset_type:
          nullable: true
          oneOf:
          - $ref: '#/components/schemas/AssetTypeEnum'
          - $ref: '#/components/schemas/BlankEnum'
          - $ref: '#/components/schemas/NullEnum'
        incidents:
          type: array
          items:
            type: string
            format: uuid
            title: ID
      required:
      - id
      - in_danger
      - name
      - parent
    NetmapGroup:
      type: object
      properties:
        id:
          type: string
          readOnly: true
        in_danger:
          type: integer
          default: 0
        description:
          type: string
          nullable: true
          description: Description
        name:
          type: string
          maxLength: 128
        collapsed:
          type: boolean
      required:
      - id
      - name
    NetworkMapBackgroundImages:
      type: object
      description: Serializer that are user to provide data for network map background
        images
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          readOnly: true
        network_map:
          type: integer
        bounds:
          type: object
          additionalProperties: {}
        locked:
          type: boolean
        visible:
          type: boolean
      required:
      - description
      - id
      - name
      - network_map
    NullEnum:
      enum:
      - null
    OpcuaReceiver:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        event_receiver:
          $ref: '#/components/schemas/EventReceiver'
        host:
          type: string
          title: Recipient's IP address
          description: Enter the recipient's IP address
          maxLength: 100
        port:
          type: integer
          maximum: 65535
          minimum: 0
          title: Destination port
          description: Enter destination port
        node_number:
          type: integer
          maximum: 254
          minimum: 1
          title: OPC UA node number
          description: Enter OPC UA node number
      required:
      - event_receiver
      - host
      - id
      - node_number
      - port
    Os:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        description:
          type: string
          nullable: true
          description: Description
        name:
          type: string
          maxLength: 128
      required:
      - id
      - name
    OsName:
      type: object
      properties:
        name:
          type: string
          maxLength: 128
      required:
      - name
    PaginatedAssetGroupList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/AssetGroup'
    PaginatedAssetInfoList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/AssetInfo'
    PaginatedAssetList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Asset'
    PaginatedConnectionList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Connection'
    PaginatedEndpointConfigList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/EndpointConfig'
    PaginatedEndpointList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Endpoint'
    PaginatedEndpointUpdateClassesSettingsList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/EndpointUpdateClassesSettings'
    PaginatedEndpointUpdateHidSubclassesSettingsList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/EndpointUpdateHidSubclassesSettings'
    PaginatedEndpointUsbClassesSetupList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/EndpointUsbClassesSetup'
    PaginatedEndpointUsbDevicesList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/EndpointUsbDevices'
    PaginatedEndpointUsbStorageDevicesSettingsList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/EndpointUsbStorageDevicesSettings'
    PaginatedGroupList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Group'
    PaginatedIncidentCategoryList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/IncidentCategory'
    PaginatedIncidentEffectList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/IncidentEffect'
    PaginatedIncidentList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Incident'
    PaginatedIncidentRecommendationsList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/IncidentRecommendations'
    PaginatedInputList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Input'
    PaginatedManufacturerList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Manufacturer'
    PaginatedNetworkMapBackgroundImagesList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/NetworkMapBackgroundImages'
    PaginatedOpcuaReceiverList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/OpcuaReceiver'
    PaginatedOsList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Os'
    PaginatedRuleExportList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/RuleExport'
    PaginatedRuleList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Rule'
    PaginatedSensorInfoList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/SensorInfo'
    PaginatedSensorList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Sensor'
    PaginatedStorageList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Storage'
    PaginatedSyslogReceiverList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/SyslogReceiver'
    PaginatedUserMapList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/UserMap'
    PaginatedVulnerabilitiesList:
      type: object
      properties:
        count:
          type: integer
          example: 123
        next:
          type: string
          nullable: true
        previous:
          type: string
          nullable: true
        results:
          type: array
          items:
            $ref: '#/components/schemas/Vulnerabilities'
    PatchedAssetGroup:
      type: object
      properties:
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
        id:
          type: integer
          readOnly: true
    PatchedDashboard:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        widgets:
          type: object
          additionalProperties: {}
          description: Widgets
        user:
          type: integer
          description: Owner of dashboard
    PatchedEndpoint:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        updated:
          type: string
          format: date-time
          readOnly: true
        status:
          type: string
          readOnly: true
        ip:
          type: string
          description: Device IP address
        config_errors:
          type: object
          additionalProperties: {}
          nullable: true
          title: Endpoint config errors
          description: Full list of Endpoint config errors
    PatchedEndpointConfig:
      type: object
      properties:
        dc_enabled:
          type: boolean
          title: Enable device control
        ic_enabled:
          type: boolean
          title: Enable integrity control
        scan_folders:
          type: array
          items:
            type: string
            title: Folder
            description: Folder for integrity control
            maxLength: 1024
          nullable: true
        ic_timeout:
          type: integer
          maximum: 86400
          minimum: 0
          title: Event creation timeout
          description: How often we can get integrity control events. Value in seconds
        wl_enable:
          type: boolean
          title: Enable white list
        wl_admin:
          type: boolean
          title: Local admin ignores white list
        white_list:
          type: array
          items:
            type: string
            title: Folder
            description: Folder for white list
            maxLength: 1024
          nullable: true
        updated:
          type: string
          format: date-time
          readOnly: true
        ip:
          type: string
          description: Device IP address
        usb_allowed_storage:
          type: object
          additionalProperties: {}
          title: Allowed USB devices
          description: List of all allowed USB devices for this Endpoint
        usb_connected:
          type: object
          additionalProperties: {}
          nullable: true
          title: Connected USB devices
          description: List of all connected to Endpoint USB devices
        usb_control_enabled:
          type: boolean
          title: Enable USB control
    PatchedEndpointUpdateClassesSettings:
      type: object
      description: Serializer for USB device class
      properties:
        class_to_change:
          type: integer
          writeOnly: true
        allow_class:
          type: boolean
          writeOnly: true
        usb_allowed_classes:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Allowed USB devices classes
          description: List of all allowed device classes for USB control
    PatchedEndpointUpdateHidSubclassesSettings:
      type: object
      description: Serializer for USB HID device subclass
      properties:
        subclass_to_change:
          type: integer
          writeOnly: true
        allow_subclass:
          type: boolean
          writeOnly: true
        usb_hid_deny_subclasses:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Prohibited USB devices hid subclasses
          description: List of all blocked USB devices hid subclasses for USB control
        usb_hid_allowed_subclasses:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Allowed USB devices hid subclasses
          description: List of all allowed USB devices hid subclasses for USB control
        usb_allowed_classes:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Allowed USB devices classes
          description: List of all allowed device classes for USB control
    PatchedEndpointUsbClassesSetup:
      type: object
      description: Serializer for Endpoint USB device classes and subclasses data
      properties:
        usb_allowed_classes:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Allowed USB devices classes
          description: List of all allowed device classes for USB control
        usb_hid_deny_subclasses:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Prohibited USB devices hid subclasses
          description: List of all blocked USB devices hid subclasses for USB control
        usb_hid_allow_other_subclasses:
          type: boolean
          title: Allowed USB devices hid subclasses
        usb_hid_allowed_subclasses:
          type: array
          items:
            type: integer
            maximum: 2147483647
            minimum: -2147483648
          title: Allowed USB devices hid subclasses
          description: List of all allowed USB devices hid subclasses for USB control
    PatchedEndpointUsbDevices:
      type: object
      description: Serializer for parsing usb_devices_list that are we getting from
        user to prepare it for database
      properties:
        usb_devices_list:
          type: string
          readOnly: true
    PatchedEndpointUsbStorageDevicesSettings:
      type: object
      description: Serializer for USB storage device
      properties:
        storage_device_data:
          allOf:
          - $ref: '#/components/schemas/EndpointUsbStorageDevice'
          writeOnly: true
        allow_storage:
          type: boolean
          writeOnly: true
        usb_allowed_storage:
          type: object
          additionalProperties: {}
          title: Allowed USB devices
          description: List of all allowed USB devices for this Endpoint
    PatchedGroup:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
    PatchedInput:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        label:
          type: string
          title: Name
          description: Name of the input
          maxLength: 128
        type:
          type: string
          readOnly: true
        can_delete:
          type: boolean
          description: Can user delete this input
    PatchedNetworkMapBackgroundImages:
      type: object
      description: Serializer that are user to provide data for network map background
        images
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          readOnly: true
        network_map:
          type: integer
        bounds:
          type: object
          additionalProperties: {}
        locked:
          type: boolean
        visible:
          type: boolean
    PatchedRule:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        sid:
          type: integer
          maximum: 2147483647
          minimum: 1
          title: Rule SID
          description: SID of correlation rule
        rev:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          default: 1
          title: Rule version
          description: Shows rule current version. Increments on change
        kind:
          type: string
        group:
          type: string
          readOnly: true
        status:
          type: boolean
          title: Enabled
          description: Is rule enabled?
        created:
          type: string
          format: date-time
          readOnly: true
        updated:
          type: string
          format: date-time
          readOnly: true
        multi:
          type: boolean
          title: Multi reaction
          description: Apply actions to every event that match the rule
        archived:
          type: boolean
          description: Is rule archived? If set - than rule can never be enabled again
        type:
          allOf:
          - $ref: '#/components/schemas/Type923Enum'
          minimum: -2147483648
          maximum: 2147483647
        depth:
          type: string
          description: Analize depth in format HH:MM:SS
        rule_json:
          type: object
          additionalProperties: {}
          title: Predicats
          description: JSON object with predicats description
        actions_json:
          type: object
          additionalProperties: {}
          title: Actions
          description: JSON object with actions description
    PatchedRuleExport:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        group:
          type: string
          readOnly: true
        actions_json:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
        multi:
          type: boolean
          title: Multi reaction
          description: Apply actions to every event that match the rule
        type:
          allOf:
          - $ref: '#/components/schemas/Type923Enum'
          minimum: -2147483648
          maximum: 2147483647
        status:
          type: boolean
          title: Enabled
          description: Is rule enabled?
        archived:
          type: boolean
          description: Is rule archived? If set - than rule can never be enabled again
        depth:
          type: string
          description: Analize depth in format HH:MM:SS
        created:
          type: string
          format: date-time
          readOnly: true
        updated:
          type: string
          format: date-time
          readOnly: true
        rule_json:
          type: object
          additionalProperties: {}
          title: Predicats
          description: JSON object with predicats description
        rev:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          default: 1
          title: Rule version
          description: Shows rule current version. Increments on change
        sid:
          type: integer
          maximum: 2147483647
          minimum: 1
          title: Rule SID
          description: SID of correlation rule
        is_active:
          type: boolean
          title: Is rule active
          description: Indicates if rule is activated or not
    PatchedSensor:
      type: object
      properties:
        sensor_info:
          type: string
          readOnly: true
        id:
          type: integer
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/SensorTypeEnum'
          description: Type of security device
        ip:
          type: string
          description: Device IP address
        scheme:
          allOf:
          - $ref: '#/components/schemas/SchemeEnum'
          title: Protocol scheme
          description: Protocol scheme
        key:
          type: string
          description: API key for device
          maxLength: 256
        secret:
          type: string
          description: Secret value for API key
          maxLength: 256
        name:
          type: string
          description: Device would be displayed under this name
          maxLength: 32
        comment:
          type: string
          description: Additional notes about device
          maxLength: 256
        link_addr:
          type: string
          readOnly: true
    PatchedStorage:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        format:
          type: string
        type:
          allOf:
          - $ref: '#/components/schemas/StorageTypeEnum'
          description: Type of storage record
          minimum: -2147483648
          maximum: 2147483647
        created:
          type: string
          format: date-time
          readOnly: true
          description: Date and time, when record was created
        last_access:
          type: string
          format: date-time
          readOnly: true
          description: Date and time, when record was downloaded last time
        size:
          type: integer
          maximum: 2147483647
          minimum: 0
          description: Size of record in MB
        crc:
          type: object
          additionalProperties: {}
          nullable: true
          description: Checksum of record
        description:
          type: string
          nullable: true
          description: Description
        free_date:
          type: string
          format: date
          nullable: true
          title: Remove date
          description: When record will be removed
        file:
          type: string
          format: uri
          description: Actual file name
        user:
          type: integer
          description: User, who own this record
    PatchedUserMap:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
        map_json:
          type: object
          additionalProperties: {}
        col_nodes:
          type: object
          additionalProperties: {}
          description: JSON for storing collapsed nodes on user graph
        shared_map:
          type: boolean
        user:
          type: integer
          nullable: true
    PatchedUserSerializers:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        username:
          type: string
          description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
            only.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        first_name:
          type: string
          maxLength: 30
        is_active:
          type: boolean
          title: Active
          description: Designates whether this user should be treated as active. Unselect
            this instead of deleting accounts.
    PeriodEnum:
      enum:
      - day
      - week
      - month
      type: string
    ProtocolEnum:
      enum:
      - UDP
      - TCP
      type: string
    RotationSettings:
      type: object
      properties:
        rotation_type:
          $ref: '#/components/schemas/RotationTypeEnum'
        size_rotation:
          type: integer
        schedule:
          $ref: '#/components/schemas/Schedule'
      required:
      - rotation_type
      - schedule
      - size_rotation
    RotationTypeEnum:
      enum:
      - 0
      - 1
      - 2
      type: integer
    Rule:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        sid:
          type: integer
          maximum: 2147483647
          minimum: 1
          title: Rule SID
          description: SID of correlation rule
        rev:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          default: 1
          title: Rule version
          description: Shows rule current version. Increments on change
        kind:
          type: string
        group:
          type: string
          readOnly: true
        status:
          type: boolean
          title: Enabled
          description: Is rule enabled?
        created:
          type: string
          format: date-time
          readOnly: true
        updated:
          type: string
          format: date-time
          readOnly: true
        multi:
          type: boolean
          title: Multi reaction
          description: Apply actions to every event that match the rule
        archived:
          type: boolean
          description: Is rule archived? If set - than rule can never be enabled again
        type:
          allOf:
          - $ref: '#/components/schemas/Type923Enum'
          minimum: -2147483648
          maximum: 2147483647
        depth:
          type: string
          description: Analize depth in format HH:MM:SS
        rule_json:
          type: object
          additionalProperties: {}
          title: Predicats
          description: JSON object with predicats description
        actions_json:
          type: object
          additionalProperties: {}
          title: Actions
          description: JSON object with actions description
      required:
      - actions_json
      - created
      - depth
      - group
      - id
      - kind
      - name
      - rule_json
      - sid
      - status
      - type
      - updated
    RuleExport:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        group:
          type: string
          readOnly: true
        actions_json:
          type: string
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
        multi:
          type: boolean
          title: Multi reaction
          description: Apply actions to every event that match the rule
        type:
          allOf:
          - $ref: '#/components/schemas/Type923Enum'
          minimum: -2147483648
          maximum: 2147483647
        status:
          type: boolean
          title: Enabled
          description: Is rule enabled?
        archived:
          type: boolean
          description: Is rule archived? If set - than rule can never be enabled again
        depth:
          type: string
          description: Analize depth in format HH:MM:SS
        created:
          type: string
          format: date-time
          readOnly: true
        updated:
          type: string
          format: date-time
          readOnly: true
        rule_json:
          type: object
          additionalProperties: {}
          title: Predicats
          description: JSON object with predicats description
        rev:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
          default: 1
          title: Rule version
          description: Shows rule current version. Increments on change
        sid:
          type: integer
          maximum: 2147483647
          minimum: 1
          title: Rule SID
          description: SID of correlation rule
        is_active:
          type: boolean
          title: Is rule active
          description: Indicates if rule is activated or not
      required:
      - actions_json
      - created
      - depth
      - group
      - id
      - name
      - rule_json
      - sid
      - status
      - type
      - updated
    Schedule:
      type: object
      properties:
        period:
          $ref: '#/components/schemas/PeriodEnum'
        time:
          type: string
          format: time
        week_day:
          type: array
          items:
            $ref: '#/components/schemas/WeekDayEnum'
        month:
          type: array
          items:
            $ref: '#/components/schemas/MonthEnum'
      required:
      - period
    SchemeEnum:
      enum:
      - http
      - https
      type: string
    Sensor:
      type: object
      properties:
        sensor_info:
          type: string
          readOnly: true
        id:
          type: integer
          readOnly: true
        type:
          allOf:
          - $ref: '#/components/schemas/SensorTypeEnum'
          description: Type of security device
        ip:
          type: string
          description: Device IP address
        scheme:
          allOf:
          - $ref: '#/components/schemas/SchemeEnum'
          title: Protocol scheme
          description: Protocol scheme
        key:
          type: string
          description: API key for device
          maxLength: 256
        secret:
          type: string
          description: Secret value for API key
          maxLength: 256
        name:
          type: string
          description: Device would be displayed under this name
          maxLength: 32
        comment:
          type: string
          description: Additional notes about device
          maxLength: 256
        link_addr:
          type: string
          readOnly: true
      required:
      - id
      - ip
      - link_addr
      - sensor_info
    SensorInfo:
      type: object
      properties:
        website:
          type: string
          description: Sensor website
          maxLength: 256
        version:
          type: string
          description: Sensor version
          maxLength: 128
        name:
          type: string
          description: Sensor name
          maxLength: 128
        identification_number:
          type: string
          description: Sensor ID
          maxLength: 128
        hash_number:
          type: string
          description: Sensor hash
          maxLength: 256
        flavour:
          type: string
          description: Sensor flavour
          maxLength: 128
        email:
          type: string
          description: Sensor email
          maxLength: 256
        copyright_years:
          type: string
          description: Sensor copyright years
          maxLength: 128
        copyright_url:
          type: string
          description: Sensor copyright url
          maxLength: 256
        copyright_owner:
          type: string
          description: Sensor copyright owner
          maxLength: 128
        architecture:
          type: string
          description: Sensor architecture
          maxLength: 128
        abi:
          type: string
          description: Sensor abi
          maxLength: 128
        updated:
          type: string
          format: date-time
      required:
      - updated
    SensorTypeEnum:
      enum:
      - ARMAIF
      type: string
    Status923Enum:
      enum:
      - 0
      - 1
      type: integer
    Storage:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        format:
          type: string
        type:
          allOf:
          - $ref: '#/components/schemas/StorageTypeEnum'
          description: Type of storage record
          minimum: -2147483648
          maximum: 2147483647
        created:
          type: string
          format: date-time
          readOnly: true
          description: Date and time, when record was created
        last_access:
          type: string
          format: date-time
          readOnly: true
          description: Date and time, when record was downloaded last time
        size:
          type: integer
          maximum: 2147483647
          minimum: 0
          description: Size of record in MB
        crc:
          type: object
          additionalProperties: {}
          nullable: true
          description: Checksum of record
        description:
          type: string
          nullable: true
          description: Description
        free_date:
          type: string
          format: date
          nullable: true
          title: Remove date
          description: When record will be removed
        file:
          type: string
          format: uri
          description: Actual file name
        user:
          type: integer
          description: User, who own this record
      required:
      - created
      - file
      - format
      - id
      - last_access
      - size
      - user
    StorageTypeEnum:
      enum:
      - 0
      - 1
      - 2
      - 3
      type: integer
    SyslogReceiver:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        event_receiver:
          $ref: '#/components/schemas/EventReceiver'
        protocol:
          allOf:
          - $ref: '#/components/schemas/ProtocolEnum'
          title: Send protocol
          description: Select send protocol
        host:
          type: string
          title: Recipient's IP address
          description: Enter the recipient's IP address
          maxLength: 100
        port:
          type: integer
          maximum: 65535
          minimum: 0
          title: Destination port
          description: Enter destination port
      required:
      - event_receiver
      - host
      - id
      - port
      - protocol
    Type923Enum:
      enum:
      - 0
      - 1
      type: integer
    UserMap:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
        map_json:
          type: object
          additionalProperties: {}
        col_nodes:
          type: object
          additionalProperties: {}
          description: JSON for storing collapsed nodes on user graph
        shared_map:
          type: boolean
        user:
          type: integer
          nullable: true
      required:
      - id
      - name
      - user
    UserSerializers:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        username:
          type: string
          description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_
            only.
          pattern: ^[\w.@+-]+$
          maxLength: 150
        first_name:
          type: string
          maxLength: 30
        is_active:
          type: boolean
          title: Active
          description: Designates whether this user should be treated as active. Unselect
            this instead of deleting accounts.
      required:
      - id
      - username
    Vulnerabilities:
      type: object
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 128
        description:
          type: string
          nullable: true
          description: Description
      required:
      - id
      - name
    VulnerabilityTitle:
      type: object
      properties:
        pk:
          type: integer
          readOnly: true
          title: ID
        name:
          type: string
          maxLength: 128
      required:
      - name
      - pk
    WeekDayEnum:
      enum:
      - sunday
      - monday
      - tuesday
      - wednesday
      - thursday
      - friday
      - saturday
      type: string
  securitySchemes:
    logstesh_permissions:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://local.com/auth
          tokenUrl: https://local.com/token
          scopes:
            can_view_input_list: Can view input list
            can_edit_asset: Can edit active
    groups_permissions:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://local.com/auth
          tokenUrl: https://local.com/token
          scopes:
            can_add_group: Can add group
    incident_permissions:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://local.com/auth
          tokenUrl: https://local.com/token
          scopes:
            can_view_incidents_list: Can view incident list
            can_view_incidents: Can view incidents
            can_assign_incidents: Can assign incidents
            can_work_with_incidents: Can work with incidents
            can_change_closed_incidents: Can change resolved incidents
            can_export_incidents_list: Can export incident list
    event_export_permissions:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://local.com/auth
          tokenUrl: https://local.com/token
          scopes:
            can_export_events: Can export journals
    endpoint_permissions:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://local.com/auth
          tokenUrl: https://local.com/token
          scopes:
            can_view_endpoints_list: Can view list of endpoints
            can_add_endpoint: Can add endpoint
            can_delete_endpoint: Can delete endpoint
            can_edit_endpoint: Can change endpoint config
            can_download_endpoint_config: Can download endpoint config
    dashboard_permissions:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://local.com/auth
          tokenUrl: https://local.com/token
          scopes:
            can_view_correlation_rules_list: Can view the list of correlation rules
            can_add_widgets: Can add widgets
            can_view_incidents: Can view incidents
            can_view_sys_info: Can view system information
            can_view_events: Can view event
    connection_permissions:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://local.com/auth
          tokenUrl: https://local.com/token
          scopes:
            can_view_network: Can view network structure
    asset_permissions:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://local.com/auth
          tokenUrl: https://local.com/token
          scopes:
            can_view_assets_list: Can view list active
            can_view_asset: Can view active
            can_export_assets: Can export actives
            can_delete_asset: Can delete active
            can_view_vulnerabilities:  Can view vulnerabilities
            can_view_correlation_rules_list: Can view the list of correlation rules
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"