Provision a Gateway

Creates a Gateway and mints its single-owner token in one call. The token is returned once here - store it securely. If it's lost, rotate it via POST /sites/{site_id}/gateways/{gateway_id}/token/rotate once the Gateway has connected, or delete and re-provision it.

name is optional; a random name is generated when omitted. ipv4 and ipv6 are the Gateway's tunnel addresses, allocated from the account's pool when the Gateway row is created - they are always present in this response, before the Gateway has ever connected.

post/sites/{site_id}/gateways

Path parameters

site_idstring required

Site ID

Request body

Example request

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

Response

Provisioned Gateway Response

Example response

{
  "data": {
    "id": "42a7f82f-831a-4a9d-8f17-c66c2bb6e205",
    "ipv4": null,
    "ipv6": null,
    "name": "vpc-us-east",
    "online": false,
    "token": "eyJhbGc..."
  }
}

Changes

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