list

This method returns a list of Gateways resources.

URL

/gateways

Method

GET

Parameters

Parameter Name Type Value Description
filter query string Use filter to narrow the elements shown
page query number Pagination index
itemsPerPage query number Number of elements per request

Note: The filter parameter uses JsonPath format

Request body

Do not supply a request body with this method.

Response

If successful this method returns a list of Gateways resources.

Sample Call

GET /api/v1beta1/gateways
{

}

HTTP/1.1 200 OK
{
  "status": "200",
  "message": "Successful request",
  "meta": {
    "currentPage": 1,
    "totalPages": 1,
    "itemsPerPage": 30,
    "totalItems": 1
  },  
  "data" : [{
    "apiVersion": "v1beta1",
    "kind": "Gateway",
    "metadata": {
        "name": "Provider Inc.",
      "ref": "gw5c77t2"
    },
    "spec": {
        "host": "sip.provider.net",
        "credentials": {
            "username": "youruser",
            "secret": "yoursecret"
        },
        "transport": "udp"
    }
  }]
}