Gateway groups API

get listing

GET /api/rest/admin/gateway-groups

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
filter[balancing-mode-id-eq]	balancing mode id eq filter
filter[balancing-mode-id-not-eq]	balancing mode id not eq filter
filter[balancing-mode-id-gt]	balancing mode id gt filter
filter[balancing-mode-id-gteq]	balancing mode id gteq filter
filter[balancing-mode-id-lt]	balancing mode id lt filter
filter[balancing-mode-id-lteq]	balancing mode id lteq filter
filter[balancing-mode-id-in]	balancing mode id in filter
filter[balancing-mode-id-not-in]	balancing mode id not in filter
filter[max-rerouting-attempts-eq]	max rerouting attempts eq filter
filter[max-rerouting-attempts-not-eq]	max rerouting attempts not eq filter
filter[max-rerouting-attempts-gt]	max rerouting attempts gt filter
filter[max-rerouting-attempts-gteq]	max rerouting attempts gteq filter
filter[max-rerouting-attempts-lt]	max rerouting attempts lt filter
filter[max-rerouting-attempts-lteq]	max rerouting attempts lteq filter
filter[max-rerouting-attempts-in]	max rerouting attempts in filter
filter[max-rerouting-attempts-not-in]	max rerouting attempts not in filter

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEwNCwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc2NzM1ODU2NX0.nyHMzI2pVwbj-cXlm_fWfv3Zm220OCJgJyeF3tK52GA
Host: example.org
Cookie: 

Route

GET /api/rest/admin/gateway-groups

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/"f3dac130eccae0096e652ccaf8f00250"
cache-control: max-age=0, private, must-revalidate
x-request-id: bcbb2fd7-96ce-4cfa-9e7d-bc89e1e38dc3
x-runtime: 0.007049
content-length: 1094

Status

200 OK

Body

{
  "data": [
    {
      "id": "14",
      "type": "gateway-groups",
      "links": {
        "self": "http://example.org/api/rest/admin/gateway-groups/14"
      },
      "attributes": {
        "name": "gateway_group_12",
        "balancing-mode-id": 2,
        "max-rerouting-attempts": 5
      },
      "relationships": {
        "vendor": {
          "links": {
            "self": "http://example.org/api/rest/admin/gateway-groups/14/relationships/vendor",
            "related": "http://example.org/api/rest/admin/gateway-groups/14/vendor"
          },
          "data": {
            "type": "contractors",
            "id": "52"
          }
        }
      }
    },
    {
      "id": "15",
      "type": "gateway-groups",
      "links": {
        "self": "http://example.org/api/rest/admin/gateway-groups/15"
      },
      "attributes": {
        "name": "gateway_group_13",
        "balancing-mode-id": 2,
        "max-rerouting-attempts": 5
      },
      "relationships": {
        "vendor": {
          "links": {
            "self": "http://example.org/api/rest/admin/gateway-groups/15/relationships/vendor",
            "related": "http://example.org/api/rest/admin/gateway-groups/15/vendor"
          },
          "data": {
            "type": "contractors",
            "id": "53"
          }
        }
      }
    }
  ],
  "meta": {
    "total-count": 2
  },
  "links": {
    "first": "http://example.org/api/rest/admin/gateway-groups?page%5Bnumber%5D=1&page%5Bsize%5D=50",
    "last": "http://example.org/api/rest/admin/gateway-groups?page%5Bnumber%5D=1&page%5Bsize%5D=50"
  }
}