<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <!-- The above 3 meta tags *must* come first in the head; any other head content must come *after* these tags -->

  <title>appsensor-ws-rest-server</title>

  <!-- Mobile viewport optimized: j.mp/bplateviewport -->
  <meta name="viewport" content="width=device-width, initial-scale=1.0">

  <!-- Bootstrap core CSS -->
  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/css/bootstrap.min.css">

  <!--custom css for these pages-->
  <link rel="stylesheet" href="css/style.css">

  <link href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.css" type="text/css">

  <!-- HTML5 shim and Respond.js for IE8 support of HTML5 elements and media queries -->
  <!--[if lt IE 9]>
  <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
  <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
  <![endif]-->
</head>

<body data-spy="scroll" data-target="#apinav">

  <nav class="navbar navbar-inverse navbar-fixed-top">
    <div class="container-fluid">
      <div class="navbar-header">
        <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#navbar">
          <span class="sr-only">Toggle navigation</span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
          <span class="icon-bar"></span>
        </button>
        <a class="navbar-brand" href="index.html">appsensor-ws-rest-server</a>
      </div>
      <div id="navbar" class="navbar-collapse collapse">
        <ul class="nav navbar-nav navbar-right">
          <li><a href="resources.html">Resources</a></li>
          <li><a href="data.html">Data Types</a></li>
          <li><a href="downloads.html">Files and Libraries</a></li>
        </ul>
      </div>
    </div>
  </nav>

  <div class="container-fluid">
    <div class="row">
      <div class="col-sm-3 col-md-2 sidebar" id="apinav">
        <ul class="nav nav-sidebar">
          <li><a href="#resources">Resources</a></li>
          <li><a href="#syntax_json">JSON</a></li>
          <li class="divider"></li>
          <li class="text-right"><a href="#top"><small>Back to Top</small></a></li>
        </ul>
      </div>

      <div class="col-sm-9 col-sm-offset-3 col-md-10 col-md-offset-2 main">
        <ol class="breadcrumb" id="top">
          <li class="dropdown"><a href="index.html">Home</a></li>
        </ol>

  <div class="jumbotron">
    <div class="container">
      <h1>appsensor-ws-rest-server</h1><p>The AppSensor project is an OWASP project to create a knowledge base as well as 
        practical implementations for intrusion detection within applications.</p>
    </div>
  </div>

  <h1 class="page-header" id="resources">Resources</h1>

  <p>
    The resources use a data model that is supported by a set of client-side libraries that are made available on the
    <a href="downloads.html">files and libraries</a> page.
  </p>

  <p>
    There is a <a href="application.wadl">WADL document</a> available that describes the resources API.
  </p>

  <p>
    You may also enjoy the <a href="ui/index.html">Swagger UI</a> provided for this API.
  </p>

  <table class="table table-hover">
    <thead>
    <tr>
      <th align="center">name</th>
      <th align="center">path</th>
      <th align="center">methods</th>
      <th align="center">description</th>
    </tr>
    </thead>
    <tbody data-link="row" class="rowlink">
    <tr class="clickable-row" data-href="resource_RestReportingEngine.html">
      <td>  RestReportingEngine
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  /api/v1.0/reports/attacks/count-by-user
</samp></li><li><samp>  /api/v1.0/reports/server-config-base64
</samp></li><li><samp>  /api/v1.0/reports/responses/count-by-user
</samp></li><li><samp>  /api/v1.0/reports/responses/count-by-label
</samp></li><li><samp>  /api/v1.0/reports/attacks/count-by-label
</samp></li><li><samp>  /api/v1.0/reports/attacks/count
</samp></li><li><samp>  /api/v1.0/reports/attacks
</samp></li><li><samp>  /api/v1.0/reports/events/count
</samp></li><li><samp>  /api/v1.0/reports/responses/count
</samp></li><li><samp>  /api/v1.0/reports/events/count-by-label
</samp></li><li><samp>  /api/v1.0/reports/events/count-by-user
</samp></li><li><samp>  /api/v1.0/reports/server-config
</samp></li><li><samp>  /api/v1.0/reports/events
</samp></li><li><samp>  /api/v1.0/reports/responses
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li><li><samp>  GET
</samp></li></ul></td>
      <td>  This is the restful endpoint that handles reporting requests on the server-side.

This simple RESTful implementation queries the appropriate *Store implementations
for matching entities.
</td>
    </tr>
    <tr class="clickable-row" data-href="resource_RestRequestHandler.html">
      <td>  RestRequestHandler
</td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  /api/v1.0/attacks
</samp></li><li><samp>  /api/v1.0/responses
</samp></li><li><samp>  /api/v1.0/events
</samp></li></ul></td>
      <td class="text-nowrap"><ul class="list-unstyled"><li><samp>  POST
</samp></li><li><samp>  GET
</samp></li><li><samp>  POST
</samp></li></ul></td>
      <td>  This is the restful endpoint that handles requests on the server-side.
</td>
    </tr>
    </tbody>
  </table>

  <h1 class="page-header" id="data">Data Types</h1>

  <h3 id="syntax_json">JSON</h3>

  <table class="table table-hover">
    <caption>Default Namespace </caption>
    <thead>
      <tr>
        <th align="center">type</th>
        <th align="center">description</th>
      </tr>
    </thead>
    <tbody data-link="row" class="rowlink">
    <tr class="clickable-row" data-href="json_attack.html">
      <td>  Attack
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_detectionpoint.html">
      <td>  DetectionPoint
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_detectionsystem.html">
      <td>  DetectionSystem
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_event.html">
      <td>  Event
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_geolocation.html">
      <td>  GeoLocation
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_ipaddress.html">
      <td>  IPAddress
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_interval.html">
      <td>  Interval
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_keyvaluepair.html">
      <td>  KeyValuePair
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_resource.html">
      <td>  Resource
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_response.html">
      <td>  Response
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_threshold.html">
      <td>  Threshold
</td>
      <td>  
</td>
    </tr>
    <tr class="clickable-row" data-href="json_user.html">
      <td>  User
</td>
      <td>  
</td>
    </tr>
    </tbody>
  </table>

        <footer class="footer">
          <div class="container">
            <p class="text-muted">Generated by <a href="http://enunciate.webcohesion.com">Enunciate</a>.</p>
          </div>
        </footer>

      </div>
    </div>
  </div>


  <!-- JavaScript placed at the end of the document so the pages load faster. -->
  <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>

  <!-- Bootstrap core JavaScript
  ================================================== -->
  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.4/js/bootstrap.min.js"></script>

  <!-- prettify code blocks. see http://code.google.com/p/google-code-prettify/ -->
  <script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/run_prettify.js" type="text/javascript"></script>
  <script>
    $(function() {
      $(".clickable-row").click(function() {
        window.document.location = $(this).data("href");
      });

      $('[data-toggle="tooltip"]').tooltip()
    });
  </script>

</body>
</html>
