Nodes API

get listing

GET /api/rest/admin/nodes

Parameters

Name	Description
filter[id]	id filter
filter[name]	name filter
filter[name-eq]	name eq filter
filter[name-not-eq]	name not eq filter
filter[name-cont]	name cont filter
filter[name-start]	name start filter
filter[name-end]	name end filter
filter[name-in]	name in filter
filter[name-not-in]	name not in filter
filter[name-cont-any]	name cont any filter

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MTAyNTQ3MzIsInN1YiI6MTE1fQ.o3mWnvADbsxScEwdS7SoScN10FO80OQmXCNsxaIasgI
Host: example.org
Cookie: 

Route

GET /api/rest/admin/nodes

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/"b175903c8ecf425f20b04e7ee15ba5f4"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: b21dfd83-2ecf-4f35-bb5f-0c9b2ba42f0f
X-Runtime: 0.008910
Content-Length: 528

Status

200 OK

Body

{
  "data": [
    {
      "id": "5",
      "type": "nodes",
      "links": {
        "self": "http://example.org/api/rest/admin/nodes/5"
      },
      "attributes": {
        "name": "Node 5",
        "rpc-endpoint": "127.0.0.1:6"
      },
      "relationships": {
        "pop": {
          "links": {
            "self": "http://example.org/api/rest/admin/nodes/5/relationships/pop",
            "related": "http://example.org/api/rest/admin/nodes/5/pop"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 1
  },
  "links": {
    "first": "http://example.org/api/rest/admin/nodes?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/nodes?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}