Update a Gateway (rename)

Renames a Gateway. Gateways otherwise self-register their configuration (name, IP addresses) on first connect and can only be renamed, not fully edited, via this endpoint.

patch/sites/{site_id}/gateways/{id}

Path parameters

site_idstring required

Site ID

idstring required

Gateway ID

Request body

Example request

{
  "gateway": {
    "name": "vpc-us-east"
  }
}

Response

Gateway Response

Example response

{
  "data": {
    "id": "42a7f82f-831a-4a9d-8f17-c66c2bb6e205",
    "ipv4": "1.2.3.4",
    "ipv6": "",
    "name": "vpc-us-east",
    "online": true
  }
}

Changes

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