Gateway groups API

update values

PUT /api/rest/admin/gateway-groups/:id

Parameters

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

Request

Headers

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

Route

PUT /api/rest/admin/gateway-groups/18

Body

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

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/"592623c6717b116c7eb4aafa4352ce34"
cache-control: max-age=0, private, must-revalidate
x-request-id: 3d848a72-d7a7-4fdf-9944-52d7d3a7f351
x-runtime: 0.014431
content-length: 425

Status

200 OK

Body

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