List Gateways

get/sites/{site_id}/gateways

Path parameters

site_idstring required

Site ID

Query parameters

limitinteger

Limit Gateways returned

page_cursorstring

Next/Prev page cursor

namestring

Filter to the Gateway with this exact name

ipv4string

Filter to the Gateway with this exact tunnel IPv4 address

ipv6string

Filter to the Gateway with this exact tunnel IPv6 address

Response

Gateway Response

Example response

{
  "data": [
    {
      "id": "42a7f82f-831a-4a9d-8f17-c66c2bb6e205",
      "ipv4": "1.2.3.4",
      "ipv6": "",
      "name": "vpc-us-east",
      "online": true
    },
    {
      "id": "6ecc106b-75c1-48a5-846c-14782180c1ff",
      "ipv4": "5.6.7.8",
      "ipv6": "",
      "name": "vpc-us-west",
      "online": true
    }
  ],
  "metadata": {
    "limit": 10,
    "next_page": "98776234123",
    "prev_page": "123123425",
    "total": 100
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.