Gateways API

get specific entry

GET /api/rest/admin/gateways/:id

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MzE1Nzg3NTcsInN1YiI6MTMwfQ.1Ew3isu-tbZ2LIJWu93VNZPfN9LcAcS7sL2tBFMLdX4
Host: example.org
Cookie: 

Route

GET /api/rest/admin/gateways/24

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/"46f459cc812a2467d52595fdce1d396e"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: a272b9d7-794d-4914-ae75-51cd3eb996d5
X-Runtime: 0.014600
Content-Length: 7084

Status

200 OK

Body

{
  "data": {
    "id": "24",
    "type": "gateways",
    "links": {
      "self": "http://example.org/api/rest/admin/gateways/24"
    },
    "attributes": {
      "name": "gateway9",
      "enabled": true,
      "priority": 122,
      "weight": 220,
      "acd-limit": 0.0,
      "asr-limit": 0.0,
      "allow-origination": true,
      "allow-termination": true,
      "sst-enabled": false,
      "host": "test.example.com",
      "port": null,
      "resolve-ruri": false,
      "diversion-domain": null,
      "diversion-rewrite-rule": null,
      "diversion-rewrite-result": null,
      "src-name-rewrite-rule": null,
      "src-name-rewrite-result": null,
      "src-rewrite-rule": null,
      "src-rewrite-result": null,
      "dst-rewrite-rule": null,
      "dst-rewrite-result": null,
      "auth-enabled": false,
      "auth-user": null,
      "auth-password": null,
      "auth-from-user": null,
      "auth-from-domain": null,
      "term-use-outbound-proxy": false,
      "term-force-outbound-proxy": false,
      "term-outbound-proxy": null,
      "term-next-hop-for-replies": false,
      "term-next-hop": null,
      "term-append-headers-req": [

      ],
      "orig-append-headers-req": [

      ],
      "orig-append-headers-reply": [

      ],
      "sdp-alines-filter-list": null,
      "ringing-timeout": null,
      "relay-options": false,
      "relay-reinvite": false,
      "relay-hold": false,
      "relay-prack": false,
      "relay-update": false,
      "suppress-early-media": false,
      "fake-180-timer": null,
      "transit-headers-from-origination": null,
      "transit-headers-from-termination": null,
      "sip-interface-name": null,
      "allow-1xx-without-to-tag": false,
      "sip-timer-b": 8000,
      "dns-srv-failover-timer": 2000,
      "proxy-media": true,
      "single-codec-in-200ok": false,
      "force-symmetric-rtp": true,
      "symmetric-rtp-nonstop": false,
      "force-dtmf-relay": false,
      "rtp-ping": false,
      "rtp-timeout": 30,
      "filter-noaudio-streams": false,
      "rtp-relay-timestamp-aligning": false,
      "rtp-force-relay-cn": true,
      "preserve-anonymous-from-domain": false,
      "registered-aor-mode-id": 1,
      "incoming-auth-username": null,
      "incoming-auth-password": null,
      "origination-capacity": 1,
      "termination-capacity": 1,
      "force-cancel-routeset": false,
      "sip-schema-id": 1
    },
    "relationships": {
      "contractor": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/contractor",
          "related": "http://example.org/api/rest/admin/gateways/24/contractor"
        },
        "data": {
          "type": "contractors",
          "id": "85"
        }
      },
      "session-refresh-method": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/session-refresh-method",
          "related": "http://example.org/api/rest/admin/gateways/24/session-refresh-method"
        },
        "data": {
          "type": "session-refresh-methods",
          "id": "1"
        }
      },
      "sdp-alines-filter-type": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/sdp-alines-filter-type",
          "related": "http://example.org/api/rest/admin/gateways/24/sdp-alines-filter-type"
        },
        "data": {
          "type": "filter-types",
          "id": "0"
        }
      },
      "term-disconnect-policy": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/term-disconnect-policy",
          "related": "http://example.org/api/rest/admin/gateways/24/term-disconnect-policy"
        },
        "data": null
      },
      "orig-disconnect-policy": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/orig-disconnect-policy",
          "related": "http://example.org/api/rest/admin/gateways/24/orig-disconnect-policy"
        },
        "data": null
      },
      "gateway-group": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/gateway-group",
          "related": "http://example.org/api/rest/admin/gateways/24/gateway-group"
        },
        "data": null
      },
      "diversion-send-mode": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/diversion-send-mode",
          "related": "http://example.org/api/rest/admin/gateways/24/diversion-send-mode"
        },
        "data": {
          "type": "gateway-diversion-send-modes",
          "id": "1"
        }
      },
      "pop": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/pop",
          "related": "http://example.org/api/rest/admin/gateways/24/pop"
        },
        "data": null
      },
      "codec-group": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/codec-group",
          "related": "http://example.org/api/rest/admin/gateways/24/codec-group"
        },
        "data": {
          "type": "codec-groups",
          "id": "1"
        }
      },
      "sdp-c-location": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/sdp-c-location",
          "related": "http://example.org/api/rest/admin/gateways/24/sdp-c-location"
        },
        "data": {
          "type": "sdp-c-locations",
          "id": "2"
        }
      },
      "sensor": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/sensor",
          "related": "http://example.org/api/rest/admin/gateways/24/sensor"
        },
        "data": null
      },
      "sensor-level": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/sensor-level",
          "related": "http://example.org/api/rest/admin/gateways/24/sensor-level"
        },
        "data": {
          "type": "sensor-levels",
          "id": "1"
        }
      },
      "dtmf-receive-mode": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/dtmf-receive-mode",
          "related": "http://example.org/api/rest/admin/gateways/24/dtmf-receive-mode"
        },
        "data": {
          "type": "dtmf-receive-modes",
          "id": "1"
        }
      },
      "dtmf-send-mode": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/dtmf-send-mode",
          "related": "http://example.org/api/rest/admin/gateways/24/dtmf-send-mode"
        },
        "data": {
          "type": "dtmf-send-modes",
          "id": "1"
        }
      },
      "transport-protocol": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/transport-protocol",
          "related": "http://example.org/api/rest/admin/gateways/24/transport-protocol"
        },
        "data": {
          "type": "transport-protocols",
          "id": "1"
        }
      },
      "term-proxy-transport-protocol": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/term-proxy-transport-protocol",
          "related": "http://example.org/api/rest/admin/gateways/24/term-proxy-transport-protocol"
        },
        "data": {
          "type": "transport-protocols",
          "id": "1"
        }
      },
      "orig-proxy-transport-protocol": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/orig-proxy-transport-protocol",
          "related": "http://example.org/api/rest/admin/gateways/24/orig-proxy-transport-protocol"
        },
        "data": {
          "type": "transport-protocols",
          "id": "1"
        }
      },
      "rel100-mode": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/rel100-mode",
          "related": "http://example.org/api/rest/admin/gateways/24/rel100-mode"
        },
        "data": {
          "type": "gateway-rel100-modes",
          "id": "1"
        }
      },
      "rx-inband-dtmf-filtering-mode": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/rx-inband-dtmf-filtering-mode",
          "related": "http://example.org/api/rest/admin/gateways/24/rx-inband-dtmf-filtering-mode"
        },
        "data": {
          "type": "gateway-inband-dtmf-filtering-modes",
          "id": "1"
        }
      },
      "tx-inband-dtmf-filtering-mode": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/tx-inband-dtmf-filtering-mode",
          "related": "http://example.org/api/rest/admin/gateways/24/tx-inband-dtmf-filtering-mode"
        },
        "data": {
          "type": "gateway-inband-dtmf-filtering-modes",
          "id": "1"
        }
      },
      "network-protocol-priority": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/network-protocol-priority",
          "related": "http://example.org/api/rest/admin/gateways/24/network-protocol-priority"
        },
        "data": {
          "type": "gateway-network-protocol-priorities",
          "id": "1"
        }
      },
      "media-encryption-mode": {
        "links": {
          "self": "http://example.org/api/rest/admin/gateways/24/relationships/media-encryption-mode",
          "related": "http://example.org/api/rest/admin/gateways/24/media-encryption-mode"
        },
        "data": {
          "type": "gateway-media-encryption-modes",
          "id": "1"
        }
      }
    }
  }
}