Gateway groups API

create new entry

POST /api/rest/admin/gateway-groups

Parameters

Name Description
data[type] Resource type (gateway-groups)
data[attributes][name] Name
data[relationships][vendor] Vendor

Request

Headers

Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOjEwOCwiYXVkIjpbImFkbWluIl0sImV4cCI6MTc3MjIxMjAwNH0.JQ6yC0TVnNQS0AKs2gVQ4DGo6Dx1oOsrQAxs_5MNroA
Host: example.org
Cookie: 

Route

POST /api/rest/admin/gateway-groups

Body

{"data":{"type":"gateway-groups","attributes":{"name":"name"},"relationships":{"vendor":{"data":{"type":"contractors","id":57}}}}}

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
location: http://example.org/api/rest/admin/gateway-groups/17
vary: Accept
etag: W/"be29bc14d26db99bb238573043bf9d86"
cache-control: max-age=0, private, must-revalidate
x-request-id: 44ca7fe0-35ef-45e2-86e7-47643a9c8e93
x-runtime: 0.013018
content-length: 426

Status

201 Created

Body

{
  "data": {
    "id": "17",
    "type": "gateway-groups",
    "links": {
      "self": "http://example.org/api/rest/admin/gateway-groups/17"
    },
    "attributes": {
      "name": "name",
      "balancing-mode-id": 1,
      "max-rerouting-attempts": 10
    },
    "relationships": {
      "vendor": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateway-groups/17/relationships/vendor",
          "related": "http://example.org/api/rest/admin/gateway-groups/17/vendor"
        },
        "data": {
          "type": "contractors",
          "id": "57"
        }
      }
    }
  }
}