Sensors API

get listing

GET /api/rest/admin/system/sensors

Parameters

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

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MzE1Nzg3NjQsInN1YiI6MjI5fQ.t9oAg7RvG4SHLKb9-UdSXZw-QW04PbrlHSEFz7Cpq-c
Host: example.org
Cookie: 

Route

GET /api/rest/admin/system/sensors

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 0
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"57cdfbff4c2dd04aa8ffdbe7e61408be"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 53cfac5a-444b-45d8-8f87-8a484bf343c5
X-Runtime: 0.007989
Content-Length: 748

Status

200 OK

Body

{
  "data": [
    {
      "id": "1",
      "type": "sensors",
      "links": {
        "self": "http://example.org/api/rest/admin/system/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/system/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/system/sensors?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/system/sensors?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}