v47

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-181,0851,7264.5 MB

Networks

Create Default Gateway.

post/networks/{id}/default_gateway

Path parameters

idstring uuid required

Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the resource.

Request body

idstring uuid

Identifies the resource.

record_typestring

Identifies the type of the resource.

created_atstring

ISO 8601 formatted date-time indicating when the resource was created.

updated_atstring

ISO 8601 formatted date-time indicating when the resource was updated.

network_idstring uuid

Network ID.

wireguard_peer_idstring uuid

Wireguard peer ID.

status'created' | 'provisioning' | 'provisioned' | 'deleting'

The current status of the interface deployment.

Example request

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "sample_record_type",
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z",
  "network_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
  "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
  "status": "provisioned"
}

Response

Successful response

Example response

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sample_record_type",
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z",
      "network_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
      "wireguard_peer_id": "e66c496d-4a85-423b-8b2a-8e63fac20320",
      "status": "provisioned"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}