Sensors API

get listing

GET /api/rest/admin/sensors

Parameters

Name Description
filter[id] id filter
filter[name] name filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjIyMSwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc3MjIxMjAxMH0.O__nDexXNcuGjNd0q90SZW5Ie05S-4zJjxZAXmpI5Ao
Host: example.org
Cookie: 

Route

GET /api/rest/admin/sensors

Response

Headers

x-frame-options: SAMEORIGIN
x-xss-protection: 0
x-content-type-options: nosniff
x-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
vary: Accept
etag: W/"49a274170a2e143d59f567519e185c26"
cache-control: max-age=0, private, must-revalidate
x-request-id: f6bd31f6-25ba-4160-9cb4-445e6577f1a3
x-runtime: 0.006362
content-length: 720

Status

200 OK

Body

{
  "data": [
    {
      "id": "1",
      "type": "sensors",
      "links": {
        "self": "http://example.org/api/rest/admin/sensors/1"
      },
      "attributes": {
        "name": "sensor1",
        "mode-id": 1,
        "source-interface": null,
        "target-mac": null,
        "use-routing": false,
        "target-ip": "192.168.0.2",
        "source-ip": "192.168.0.1"
      }
    },
    {
      "id": "2",
      "type": "sensors",
      "links": {
        "self": "http://example.org/api/rest/admin/sensors/2"
      },
      "attributes": {
        "name": "sensor2",
        "mode-id": 1,
        "source-interface": null,
        "target-mac": null,
        "use-routing": false,
        "target-ip": "192.168.0.2",
        "source-ip": "192.168.0.1"
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/sensors?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/sensors?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}