Networks API

get listing

GET /api/rest/admin/system/networks

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.eyJleHAiOjE3MTAyNTQ3MzksInN1YiI6MjAyfQ.y8Fdc3gG0rUdxdLQ6b1LI2YkMhPkhT-0fCJ3dFtAMlM
Host: example.org
Cookie: 

Route

GET /api/rest/admin/system/networks

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/"dc7bce9c0cd6d88073f473945af4bf52"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 5c2e8bb1-c4d2-48a0-b007-62da168005ba
X-Runtime: 0.009121
Content-Length: 936

Status

200 OK

Body

{
  "data": [
    {
      "id": "2626",
      "type": "networks",
      "links": {
        "self": "http://example.org/api/rest/admin/system/networks/2626"
      },
      "attributes": {
        "name": "US"
      },
      "relationships": {
        "network-type": {
          "links": {
            "self": "http://example.org/api/rest/admin/system/networks/2626/relationships/network-type",
            "related": "http://example.org/api/rest/admin/system/networks/2626/network-type"
          }
        }
      }
    },
    {
      "id": "2627",
      "type": "networks",
      "links": {
        "self": "http://example.org/api/rest/admin/system/networks/2627"
      },
      "attributes": {
        "name": "CA"
      },
      "relationships": {
        "network-type": {
          "links": {
            "self": "http://example.org/api/rest/admin/system/networks/2627/relationships/network-type",
            "related": "http://example.org/api/rest/admin/system/networks/2627/network-type"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/system/networks?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/system/networks?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}