Nodes API

get listing

GET /api/rest/admin/nodes

Parameters

Name	Description
filter[id]	id filter
filter[pop-id-eq]	pop id eq filter
filter[pop-id-not-eq]	pop id not eq filter
filter[pop-id-in]	pop id in filter
filter[pop-id-not-in]	pop id not in filter
filter[id-eq]	id eq filter
filter[id-not-eq]	id not eq filter
filter[id-gt]	id gt filter
filter[id-gteq]	id gteq filter
filter[id-lt]	id lt filter
filter[id-lteq]	id lteq filter
filter[id-in]	id in filter
filter[id-not-in]	id not in 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
filter[rpc-endpoint-eq]	rpc endpoint eq filter
filter[rpc-endpoint-not-eq]	rpc endpoint not eq filter
filter[rpc-endpoint-cont]	rpc endpoint cont filter
filter[rpc-endpoint-start]	rpc endpoint start filter
filter[rpc-endpoint-end]	rpc endpoint end filter
filter[rpc-endpoint-in]	rpc endpoint in filter
filter[rpc-endpoint-not-in]	rpc endpoint not in filter
filter[rpc-endpoint-cont-any]	rpc endpoint cont any filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjE1MiwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU2OH0.8nnsPPU5LLL0kF1iIPJT7IxyV3X5VQr6ASvOYN0SzAk
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-permitted-cross-domain-policies: none
referrer-policy: strict-origin-when-cross-origin
content-type: application/vnd.api+json
vary: Accept
etag: W/"8f29835b2f03e180f46e72e13fd914c7"
cache-control: max-age=0, private, must-revalidate
x-request-id: 5ee26662-24e0-4d3c-9d62-a624a023d03b
x-runtime: 0.007473
content-length: 560

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"
          },
          "data": {
            "type": "pops",
            "id": "5"
          }
        }
      }
    }
  ],
  "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"
  }
}