Requests

The project uses Swagger to describe the REST interface. Swagger UI can be accessed at: <ip:port>/swagger-ui.html

E.g. http://localhost:8080/swagger-ui.html

Request example

Example 1, security:

{
  "clientId" : "13",
  "command" : "security ecrypt2lvl 192.168.0.102",
  "responseAddress" : "http://192.168.56.101:8008/jobFinished",
  "repetitions": 3,
  "repetitionInterval": 100,
  "processors" : [
    "XmlToJsonConverter", 
    "security.TlsCiphersuitesFilter",
    "security.TlsEcrypt2Level"
  ],
  "adapter" : "adapters.EventHubAdapter"
}

Example 2, availability:

{
  "clientId" : "13",
  "command" : "availability 192.168.0.102",
  "responseAddress" : "http://192.168.56.101:8008/jobFinished",
  "repetitions": 5,
  "repetitionInterval": 300,
  "processors" : [
    "availability.HttpStatusCodeFilter"
  ],
  "adapter" : "adapters.EventHubAdapter"
}

Possible commands and filters that should be used

Commands	Filters
availability <url>	HttpStatusCodeFilter | HttpBodyFilter | HttpStatusCodeAndBodyFilter
security tls <url>	XmlToJsonConverter & TlsCiphersuitesFilter
security ecrypt2lvl <url>	XmlToJsonConverter & TlsCiphersuitesFilter & TlsEcrypt2Level
security open_ports <url>	-

Response example

Example 1, security:

{
    "component": "514e2247-a4de-47b3-b233-f95dbea8aa1e",
    "data": {
        "weakestCipher": "RC4_128",
        "ecript2Level": 7
    },
    "type": "metric",
    "object": "security",
    "labels": [
        "userId-13",
        "jobId-564d7ecebee8e7369153707a"
    ],
    "timestamp": 1447919315,
    "token": null
}

Example 2, availability:

{
    "component": "5b3ed408-cb97-4ed0-bbc3-c38623a7010d",
    "data": {
        "url": "http://192.168.0.102",
        "httpStatusCode": "200"
    },
    "type": "metric",
    "object": "availability",
    "labels": [
        "userId-13",
        "jobId-564c64debee8ebc97150aa92"
    ],
    "timestamp": 1447847134,
    "token": null
}