VPC Public Gateway APIv1

Download OpenAPI

Introduction

The VPC Public Gateway is a building block for your infrastructure on Scaleway's shared public cloud. It provides a set of managed network services and features for Scaleway's Private Networks such as DHCP, NAT and routing.

Technical limitations

  • A maximum of eight (8) Private Networks can be plugged into a VPC Public Gateway

Step 0: Prerequisites

You need to have an HTTP client such as curl to use Scaleway API. It is also a good idea to have jq which will help you to read and parse JSON output. Make sure you have these two tools before you begin. Otherwise, use your package manager to install them.

To call Scaleway API, you need an X-Auth-Token. If you don't have one yet, refer to our doc about generating API keys.

Next, you will need your Project ID to create VPC resources in. If you don't have it, refer to our doc about creating a Project.

Finally, you will need to choose the Availability Zone in which to create your VPC Public Gateways. Keep in mind that VPC Public Gateways are per zone and not per region, thus you will only be able to connect instances to networks from the same Availability Zone.

export SECRET_KEY="<Secret key of your token>"
export PROJECT_ID="<Chosen Project ID>"
export ZONE="<Chosen zone (fr-par-1/fr-par-2/nl-ams-1/pl-waw-1)>"

Step 1: Choose a VPC Public Gateway type

VPC Public Gateways come in multiple shapes and size, with various network capabilities, scale and features. You can find out all about them with the following command:

curl -s -H "Content-Type: application/json" -H "X-Auth-Token: $SECRET_KEY" \
    https://api.scaleway.com/vpc-gw/v1/zones/$ZONE/gateway-types

Keep the name field from the response, as it contains information will need for the call to create your VPC Public Gateway.

Step 2: Create a VPC Public Gateway

You can customize the name, tags and project ID for the created VPC Public Gateway. There are other options, but they are out of the scope of this quickstart.

curl -s -H "Content-Type: application/json" -H "X-Auth-Token: $SECRET_KEY" \
    https://api.scaleway.com/vpc-gw/v1/zones/$ZONE/gateways \
    -d '{"name": "My awesome gateway", \
         "project_id": "'$PROJECT_ID'", \
         "tags": ["test", "step1"], \
         "type": "VPC-GW-S"}'

Keep the id field from the response: it is your VPC Public Gateway ID, and will be used in subsequent calls to the API. We will put it in a variable for the sake of readability:

export GW_ID="<Your VPC Public Gateway ID>"

To delete your VPC Public Gateway, you can use the following call:

curl -s -H "Content-Type: application/json" -H "X-Auth-Token: $SECRET_KEY" \
    https://api.scaleway.com/vpc-gw/v1/zones/$ZONE/gateways/$GW_ID \
    -X DELETE

Please note that the VPC Public Gateway takes some time to start up, and actions on it are impossible unless it is in the running state. To check the current state of a VPC Public Gateway, use the following command:

curl -s -H "Content-Type: application/json" -H "X-Auth-Token: $SECRET_KEY" \
    https://api.scaleway.com/vpc-gw/v1/zones/$ZONE/gateways/$GW_ID \
    | jq .status

Step 3: Attach Private Networks to the VPC Public Gateway

A gateway is useless unless attached to one or more Private Networks. With a gateway, services like DHCP are available to the attached Private Networks. If you don't already have Private Networks to attach to your gateway, please follow the Private Networks quickstart guide to create at least one Private Network and attach instances to it.

For the sake of readability, we will put the Private Network ID in a variable:

export PN_ID="<Your Private Network ID>"

Then, use the following call to attach the VPC Public Gateway to your Private Network using a pretty standard DHCP configuration

curl -s -H "Content-Type: application/json" -H "X-Auth-Token: $SECRET_KEY" \
    https://api.scaleway.com/vpc-gw/v1/zones/$ZONE/gateway-networks \
    -d '{"gateway_id": "'$GW_ID'", \
         "private_network_id": "'$PN_ID'", \
         "enable_masquerade": true, \
         "dhcp": {"project_id": "'$PROJECT_ID'", \
                  "subnet": "192.168.1.0/24"}}'

Keep the id field of the response: it is your Gateway Network ID, which represents the association between a VPC Public Gateway and a Private Network. It will allow you to manage such associations and to unplug the gateway from the Private Network.

You may also notice the DHCP object in the query. A DHCP configuration is a separate resource from the Gateway Network since it is optional, and as such is managed separately.

This configuration will setup the gateway as a NAT gateway, masquerading traffic sent to it to the outer internet to provide internet access to member instances of the Private Network, and serving IP addresses through DHCP to said instances, in the subnet 192.168.1.0/24.

To delete your Gateway Network, which equates to unplugging your VPC Public Gateway from the Private Network, you can use the following call:

curl -s -H "Content-Type: application/json" -H "X-Auth-Token: $SECRET_KEY" \
    https://api.scaleway.com/vpc-gw/v1/zones/$ZONE/gateway-networks/$GW_NET_ID \
    -d '{"gateway_network_id": "'$GW_NET_ID'"}'

As this is only a quickstart guide, we won't go much deeper into the usage of the gateway. Please refer to our API documentation to learn how to tweak your DHCP server, create static DHCP reservations, create PAT rules and more.

Gateways

The VPC Public Gateway is a building block for your infrastructure on Scaleway's shared public cloud. It provides a set of managed network services and features for Scaleway's Private Networks such as DHCP, NAT and routing.

List VPC Public Gateways

GET
/vpc-gw/v1/zones/{zone}/gateways
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
Query Parameters
order_by
string
Order in which to return results. Possible values are created_at_asc, created_at_desc, name_asc, name_desc, type_asc, type_desc, status_asc and status_desc. The default value is created_at_asc.
page
number
Page number. The default value is 1.
page_size
number
Gateways per page. The default value is 20.
organization_id
nullable string
Include only gateways in this organization (UUID format).
project_id
nullable string
Include only gateways in this project (UUID format).
name
nullable string
Filter gateways including this name.
tags
array
Filter gateways with these tags.
type
nullable string
Filter gateways of this type.
status
string
Filter gateways in this status (unknown for any). Possible values are unknown, stopped, allocating, configuring, running, stopping, failed, deleting, deleted and locked. The default value is unknown.
private_network_id
nullable string
Filter gateways attached to this private network (UUID format).
200 Response
gateways
array
Gateways in this page.
id
string
ID of the gateway (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Gateway creation date.
updated_at
string
Gateway last modification date.
type
object
Gateway type.
name
string
Type name.
bandwidth
number
Bandwidth, in bps, the gateway has. This is the public bandwidth to the outer internet, and the internal bandwidth to each connected Private Networks. .
zone
string
Zone the type is available in.
status
string
Gateway's current status. Possible values are unknown, stopped, allocating, configuring, running, stopping, failed, deleting, deleted and locked. The default value is unknown.
name
string
Name of the gateway.
tags
array
Tags of the gateway.
ip
object
Public IP of the gateway.
id
string
IP ID (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
tags
array
Tags associated with the IP.
address
string
The IP itself (IP address).
reverse
nullable string
Reverse domain name for the IP address.
gateway_id
nullable string
Gateway associated to the IP (UUID format).
zone
string
Zone this IP is available in.
gateway_networks
array
GatewayNetworks attached to the gateway.
id
string
ID of the connection (UUID format).
created_at
string
Connection creation date.
updated_at
string
Connection last modification date.
gateway_id
string
ID of the connected gateway (UUID format).
private_network_id
string
ID of the connected private network (UUID format).
mac_address
nullable string
MAC address of the gateway in the network (if the gateway is up and running).
enable_masquerade
boolean
Whether the gateway masquerades traffic for this network.
status
string
Current status of the gateway network connection. Possible values are unknown, created, attaching, configuring, ready, detaching and deleted. The default value is unknown.
dhcp
object
DHCP configuration for the connected private network.
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
enable_dhcp
boolean
Whether DHCP is enabled on the connected Private Network.
address
nullable string
Address of the Gateway in CIDR form to use when DHCP is not used (IP network).
zone
string
Zone the connection lives in.
upstream_dns_servers
array
Override the gateway's default recursive DNS servers.
version
nullable string
Version of the running gateway software.
can_upgrade_to
nullable string
Newly available gateway software version that can be updated to.
bastion_enabled
boolean
Whether SSH bastion is enabled on the gateway.
bastion_port
number
Port of the SSH bastion.
smtp_enabled
boolean
Whether SMTP traffic is allowed to pass through the gateway.
zone
string
Zone the gateway is available in.
total_count
number
Total count of gateways matching the filter.
Response Example
{
  "gateways": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "string",
      "updated_at": "string",
      "type": {
        "name": "string",
        "bandwidth": 42,
        "zone": "string"
      },
      "status": "unknown",
      "name": "string",
      "tags": [
        "string"
      ],
      "ip": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
        "project_id": "6170692e-7363-616c-6577-61792e636f6d",
        "created_at": "string",
        "updated_at": "string",
        "tags": [
          "string"
        ],
        "address": "1.2.3.4",
        "reverse": "string",
        "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
        "zone": "string"
      },
      "gateway_networks": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "created_at": "string",
          "updated_at": "string",
          "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
          "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
          "mac_address": "string",
          "enable_masquerade": "boolean",
          "status": "unknown",
          "dhcp": {
            "id": "6170692e-7363-616c-6577-61792e636f6d",
            "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
            "project_id": "6170692e-7363-616c-6577-61792e636f6d",
            "created_at": "string",
            "updated_at": "string",
            "subnet": "1.2.3.4/32",
            "address": "1.2.3.4",
            "pool_low": "1.2.3.4",
            "pool_high": "1.2.3.4",
            "enable_dynamic": "boolean",
            "valid_lifetime": "2.5s",
            "renew_timer": "2.5s",
            "rebind_timer": "2.5s",
            "push_default_route": "boolean",
            "push_dns_server": "boolean",
            "dns_servers_override": [
              "string"
            ],
            "dns_search": [
              "string"
            ],
            "dns_local_name": "string",
            "zone": "string"
          },
          "enable_dhcp": "boolean",
          "address": "1.2.3.4/32",
          "zone": "string"
        }
      ],
      "upstream_dns_servers": [
        "string"
      ],
      "version": "string",
      "can_upgrade_to": "string",
      "bastion_enabled": "boolean",
      "bastion_port": 42,
      "smtp_enabled": "boolean",
      "zone": "string"
    }
  ],
  "total_count": 42
}

Create a VPC Public Gateway

POST
/vpc-gw/v1/zones/{zone}/gateways
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
Body
project_id
string
Project to create the gateway into (UUID format).
name
string
Name of the gateway.
tags
array
Tags for the gateway.
type
string
Gateway type.
upstream_dns_servers
array
Override the gateway's default recursive DNS servers, if DNS features are enabled.
ip_id
nullable string
Attach an existing IP to the gateway (UUID format).
enable_smtp
boolean
Allow SMTP traffic to pass through the gateway.
enable_bastion
boolean
Enable SSH bastion on the gateway.
bastion_port
nullable number
Port of the SSH bastion.
Request Example
{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "name": "string",
  "tags": [
    "string"
  ],
  "type": "string",
  "upstream_dns_servers": [
    "string"
  ],
  "ip_id": "6170692e-7363-616c-6577-61792e636f6d",
  "enable_smtp": "boolean",
  "enable_bastion": "boolean",
  "bastion_port": 42
}
200 Response
id
string
ID of the gateway (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Gateway creation date.
updated_at
string
Gateway last modification date.
type
object
Gateway type.
name
string
Type name.
bandwidth
number
Bandwidth, in bps, the gateway has. This is the public bandwidth to the outer internet, and the internal bandwidth to each connected Private Networks. .
zone
string
Zone the type is available in.
status
string
Gateway's current status. Possible values are unknown, stopped, allocating, configuring, running, stopping, failed, deleting, deleted and locked. The default value is unknown.
name
string
Name of the gateway.
tags
array
Tags of the gateway.
ip
object
Public IP of the gateway.
id
string
IP ID (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
tags
array
Tags associated with the IP.
address
string
The IP itself (IP address).
reverse
nullable string
Reverse domain name for the IP address.
gateway_id
nullable string
Gateway associated to the IP (UUID format).
zone
string
Zone this IP is available in.
gateway_networks
array
GatewayNetworks attached to the gateway.
id
string
ID of the connection (UUID format).
created_at
string
Connection creation date.
updated_at
string
Connection last modification date.
gateway_id
string
ID of the connected gateway (UUID format).
private_network_id
string
ID of the connected private network (UUID format).
mac_address
nullable string
MAC address of the gateway in the network (if the gateway is up and running).
enable_masquerade
boolean
Whether the gateway masquerades traffic for this network.
status
string
Current status of the gateway network connection. Possible values are unknown, created, attaching, configuring, ready, detaching and deleted. The default value is unknown.
dhcp
object
DHCP configuration for the connected private network.
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
enable_dhcp
boolean
Whether DHCP is enabled on the connected Private Network.
address
nullable string
Address of the Gateway in CIDR form to use when DHCP is not used (IP network).
zone
string
Zone the connection lives in.
upstream_dns_servers
array
Override the gateway's default recursive DNS servers.
version
nullable string
Version of the running gateway software.
can_upgrade_to
nullable string
Newly available gateway software version that can be updated to.
bastion_enabled
boolean
Whether SSH bastion is enabled on the gateway.
bastion_port
number
Port of the SSH bastion.
smtp_enabled
boolean
Whether SMTP traffic is allowed to pass through the gateway.
zone
string
Zone the gateway is available in.
Response Example
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "string",
  "updated_at": "string",
  "type": {
    "name": "string",
    "bandwidth": 42,
    "zone": "string"
  },
  "status": "unknown",
  "name": "string",
  "tags": [
    "string"
  ],
  "ip": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "string",
    "updated_at": "string",
    "tags": [
      "string"
    ],
    "address": "1.2.3.4",
    "reverse": "string",
    "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
    "zone": "string"
  },
  "gateway_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "string",
      "updated_at": "string",
      "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "mac_address": "string",
      "enable_masquerade": "boolean",
      "status": "unknown",
      "dhcp": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
        "project_id": "6170692e-7363-616c-6577-61792e636f6d",
        "created_at": "string",
        "updated_at": "string",
        "subnet": "1.2.3.4/32",
        "address": "1.2.3.4",
        "pool_low": "1.2.3.4",
        "pool_high": "1.2.3.4",
        "enable_dynamic": "boolean",
        "valid_lifetime": "2.5s",
        "renew_timer": "2.5s",
        "rebind_timer": "2.5s",
        "push_default_route": "boolean",
        "push_dns_server": "boolean",
        "dns_servers_override": [
          "string"
        ],
        "dns_search": [
          "string"
        ],
        "dns_local_name": "string",
        "zone": "string"
      },
      "enable_dhcp": "boolean",
      "address": "1.2.3.4/32",
      "zone": "string"
    }
  ],
  "upstream_dns_servers": [
    "string"
  ],
  "version": "string",
  "can_upgrade_to": "string",
  "bastion_enabled": "boolean",
  "bastion_port": 42,
  "smtp_enabled": "boolean",
  "zone": "string"
}

Get a VPC Public Gateway

GET
/vpc-gw/v1/zones/{zone}/gateways/{gateway_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
gateway_id
required string
ID of the gateway to fetch (UUID format).
200 Response
id
string
ID of the gateway (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Gateway creation date.
updated_at
string
Gateway last modification date.
type
object
Gateway type.
name
string
Type name.
bandwidth
number
Bandwidth, in bps, the gateway has. This is the public bandwidth to the outer internet, and the internal bandwidth to each connected Private Networks. .
zone
string
Zone the type is available in.
status
string
Gateway's current status. Possible values are unknown, stopped, allocating, configuring, running, stopping, failed, deleting, deleted and locked. The default value is unknown.
name
string
Name of the gateway.
tags
array
Tags of the gateway.
ip
object
Public IP of the gateway.
id
string
IP ID (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
tags
array
Tags associated with the IP.
address
string
The IP itself (IP address).
reverse
nullable string
Reverse domain name for the IP address.
gateway_id
nullable string
Gateway associated to the IP (UUID format).
zone
string
Zone this IP is available in.
gateway_networks
array
GatewayNetworks attached to the gateway.
id
string
ID of the connection (UUID format).
created_at
string
Connection creation date.
updated_at
string
Connection last modification date.
gateway_id
string
ID of the connected gateway (UUID format).
private_network_id
string
ID of the connected private network (UUID format).
mac_address
nullable string
MAC address of the gateway in the network (if the gateway is up and running).
enable_masquerade
boolean
Whether the gateway masquerades traffic for this network.
status
string
Current status of the gateway network connection. Possible values are unknown, created, attaching, configuring, ready, detaching and deleted. The default value is unknown.
dhcp
object
DHCP configuration for the connected private network.
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
enable_dhcp
boolean
Whether DHCP is enabled on the connected Private Network.
address
nullable string
Address of the Gateway in CIDR form to use when DHCP is not used (IP network).
zone
string
Zone the connection lives in.
upstream_dns_servers
array
Override the gateway's default recursive DNS servers.
version
nullable string
Version of the running gateway software.
can_upgrade_to
nullable string
Newly available gateway software version that can be updated to.
bastion_enabled
boolean
Whether SSH bastion is enabled on the gateway.
bastion_port
number
Port of the SSH bastion.
smtp_enabled
boolean
Whether SMTP traffic is allowed to pass through the gateway.
zone
string
Zone the gateway is available in.
Response Example
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "string",
  "updated_at": "string",
  "type": {
    "name": "string",
    "bandwidth": 42,
    "zone": "string"
  },
  "status": "unknown",
  "name": "string",
  "tags": [
    "string"
  ],
  "ip": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "string",
    "updated_at": "string",
    "tags": [
      "string"
    ],
    "address": "1.2.3.4",
    "reverse": "string",
    "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
    "zone": "string"
  },
  "gateway_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "string",
      "updated_at": "string",
      "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "mac_address": "string",
      "enable_masquerade": "boolean",
      "status": "unknown",
      "dhcp": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
        "project_id": "6170692e-7363-616c-6577-61792e636f6d",
        "created_at": "string",
        "updated_at": "string",
        "subnet": "1.2.3.4/32",
        "address": "1.2.3.4",
        "pool_low": "1.2.3.4",
        "pool_high": "1.2.3.4",
        "enable_dynamic": "boolean",
        "valid_lifetime": "2.5s",
        "renew_timer": "2.5s",
        "rebind_timer": "2.5s",
        "push_default_route": "boolean",
        "push_dns_server": "boolean",
        "dns_servers_override": [
          "string"
        ],
        "dns_search": [
          "string"
        ],
        "dns_local_name": "string",
        "zone": "string"
      },
      "enable_dhcp": "boolean",
      "address": "1.2.3.4/32",
      "zone": "string"
    }
  ],
  "upstream_dns_servers": [
    "string"
  ],
  "version": "string",
  "can_upgrade_to": "string",
  "bastion_enabled": "boolean",
  "bastion_port": 42,
  "smtp_enabled": "boolean",
  "zone": "string"
}

Update a VPC Public Gateway

PATCH
/vpc-gw/v1/zones/{zone}/gateways/{gateway_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
gateway_id
required string
ID of the gateway to update (UUID format).
Body
name
nullable string
Name fo the gateway.
tags
nullable array
Tags for the gateway.
upstream_dns_servers
nullable array
Override the gateway's default recursive DNS servers, if DNS features are enabled.
enable_bastion
nullable boolean
Enable SSH bastion on the gateway.
bastion_port
nullable number
Port of the SSH bastion.
enable_smtp
nullable boolean
Allow SMTP traffic to pass through the gateway.
Request Example
{
  "name": "string",
  "tags": [
    "string"
  ],
  "upstream_dns_servers": [
    "string"
  ],
  "enable_bastion": "boolean",
  "bastion_port": 42,
  "enable_smtp": "boolean"
}
200 Response
id
string
ID of the gateway (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Gateway creation date.
updated_at
string
Gateway last modification date.
type
object
Gateway type.
name
string
Type name.
bandwidth
number
Bandwidth, in bps, the gateway has. This is the public bandwidth to the outer internet, and the internal bandwidth to each connected Private Networks. .
zone
string
Zone the type is available in.
status
string
Gateway's current status. Possible values are unknown, stopped, allocating, configuring, running, stopping, failed, deleting, deleted and locked. The default value is unknown.
name
string
Name of the gateway.
tags
array
Tags of the gateway.
ip
object
Public IP of the gateway.
id
string
IP ID (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
tags
array
Tags associated with the IP.
address
string
The IP itself (IP address).
reverse
nullable string
Reverse domain name for the IP address.
gateway_id
nullable string
Gateway associated to the IP (UUID format).
zone
string
Zone this IP is available in.
gateway_networks
array
GatewayNetworks attached to the gateway.
id
string
ID of the connection (UUID format).
created_at
string
Connection creation date.
updated_at
string
Connection last modification date.
gateway_id
string
ID of the connected gateway (UUID format).
private_network_id
string
ID of the connected private network (UUID format).
mac_address
nullable string
MAC address of the gateway in the network (if the gateway is up and running).
enable_masquerade
boolean
Whether the gateway masquerades traffic for this network.
status
string
Current status of the gateway network connection. Possible values are unknown, created, attaching, configuring, ready, detaching and deleted. The default value is unknown.
dhcp
object
DHCP configuration for the connected private network.
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
enable_dhcp
boolean
Whether DHCP is enabled on the connected Private Network.
address
nullable string
Address of the Gateway in CIDR form to use when DHCP is not used (IP network).
zone
string
Zone the connection lives in.
upstream_dns_servers
array
Override the gateway's default recursive DNS servers.
version
nullable string
Version of the running gateway software.
can_upgrade_to
nullable string
Newly available gateway software version that can be updated to.
bastion_enabled
boolean
Whether SSH bastion is enabled on the gateway.
bastion_port
number
Port of the SSH bastion.
smtp_enabled
boolean
Whether SMTP traffic is allowed to pass through the gateway.
zone
string
Zone the gateway is available in.
Response Example
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "string",
  "updated_at": "string",
  "type": {
    "name": "string",
    "bandwidth": 42,
    "zone": "string"
  },
  "status": "unknown",
  "name": "string",
  "tags": [
    "string"
  ],
  "ip": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "string",
    "updated_at": "string",
    "tags": [
      "string"
    ],
    "address": "1.2.3.4",
    "reverse": "string",
    "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
    "zone": "string"
  },
  "gateway_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "string",
      "updated_at": "string",
      "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "mac_address": "string",
      "enable_masquerade": "boolean",
      "status": "unknown",
      "dhcp": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
        "project_id": "6170692e-7363-616c-6577-61792e636f6d",
        "created_at": "string",
        "updated_at": "string",
        "subnet": "1.2.3.4/32",
        "address": "1.2.3.4",
        "pool_low": "1.2.3.4",
        "pool_high": "1.2.3.4",
        "enable_dynamic": "boolean",
        "valid_lifetime": "2.5s",
        "renew_timer": "2.5s",
        "rebind_timer": "2.5s",
        "push_default_route": "boolean",
        "push_dns_server": "boolean",
        "dns_servers_override": [
          "string"
        ],
        "dns_search": [
          "string"
        ],
        "dns_local_name": "string",
        "zone": "string"
      },
      "enable_dhcp": "boolean",
      "address": "1.2.3.4/32",
      "zone": "string"
    }
  ],
  "upstream_dns_servers": [
    "string"
  ],
  "version": "string",
  "can_upgrade_to": "string",
  "bastion_enabled": "boolean",
  "bastion_port": 42,
  "smtp_enabled": "boolean",
  "zone": "string"
}

Delete a VPC Public Gateway

DELETE
/vpc-gw/v1/zones/{zone}/gateways/{gateway_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
gateway_id
required string
ID of the gateway to delete (UUID format).
Query Parameters
cleanup_dhcp
boolean
Whether to cleanup attached DHCP configurations (if any, and if not attached to another Gateway Network). .
204 Response
Empty response

Upgrade a VPC Public Gateway to the latest version

POST
/vpc-gw/v1/zones/{zone}/gateways/{gateway_id}/upgrade
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
gateway_id
required string
ID of the gateway to upgrade (UUID format).
Body
Request Example
{}
200 Response
id
string
ID of the gateway (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Gateway creation date.
updated_at
string
Gateway last modification date.
type
object
Gateway type.
name
string
Type name.
bandwidth
number
Bandwidth, in bps, the gateway has. This is the public bandwidth to the outer internet, and the internal bandwidth to each connected Private Networks. .
zone
string
Zone the type is available in.
status
string
Gateway's current status. Possible values are unknown, stopped, allocating, configuring, running, stopping, failed, deleting, deleted and locked. The default value is unknown.
name
string
Name of the gateway.
tags
array
Tags of the gateway.
ip
object
Public IP of the gateway.
id
string
IP ID (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
tags
array
Tags associated with the IP.
address
string
The IP itself (IP address).
reverse
nullable string
Reverse domain name for the IP address.
gateway_id
nullable string
Gateway associated to the IP (UUID format).
zone
string
Zone this IP is available in.
gateway_networks
array
GatewayNetworks attached to the gateway.
id
string
ID of the connection (UUID format).
created_at
string
Connection creation date.
updated_at
string
Connection last modification date.
gateway_id
string
ID of the connected gateway (UUID format).
private_network_id
string
ID of the connected private network (UUID format).
mac_address
nullable string
MAC address of the gateway in the network (if the gateway is up and running).
enable_masquerade
boolean
Whether the gateway masquerades traffic for this network.
status
string
Current status of the gateway network connection. Possible values are unknown, created, attaching, configuring, ready, detaching and deleted. The default value is unknown.
dhcp
object
DHCP configuration for the connected private network.
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
enable_dhcp
boolean
Whether DHCP is enabled on the connected Private Network.
address
nullable string
Address of the Gateway in CIDR form to use when DHCP is not used (IP network).
zone
string
Zone the connection lives in.
upstream_dns_servers
array
Override the gateway's default recursive DNS servers.
version
nullable string
Version of the running gateway software.
can_upgrade_to
nullable string
Newly available gateway software version that can be updated to.
bastion_enabled
boolean
Whether SSH bastion is enabled on the gateway.
bastion_port
number
Port of the SSH bastion.
smtp_enabled
boolean
Whether SMTP traffic is allowed to pass through the gateway.
zone
string
Zone the gateway is available in.
Response Example
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "string",
  "updated_at": "string",
  "type": {
    "name": "string",
    "bandwidth": 42,
    "zone": "string"
  },
  "status": "unknown",
  "name": "string",
  "tags": [
    "string"
  ],
  "ip": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "string",
    "updated_at": "string",
    "tags": [
      "string"
    ],
    "address": "1.2.3.4",
    "reverse": "string",
    "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
    "zone": "string"
  },
  "gateway_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "string",
      "updated_at": "string",
      "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "mac_address": "string",
      "enable_masquerade": "boolean",
      "status": "unknown",
      "dhcp": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
        "project_id": "6170692e-7363-616c-6577-61792e636f6d",
        "created_at": "string",
        "updated_at": "string",
        "subnet": "1.2.3.4/32",
        "address": "1.2.3.4",
        "pool_low": "1.2.3.4",
        "pool_high": "1.2.3.4",
        "enable_dynamic": "boolean",
        "valid_lifetime": "2.5s",
        "renew_timer": "2.5s",
        "rebind_timer": "2.5s",
        "push_default_route": "boolean",
        "push_dns_server": "boolean",
        "dns_servers_override": [
          "string"
        ],
        "dns_search": [
          "string"
        ],
        "dns_local_name": "string",
        "zone": "string"
      },
      "enable_dhcp": "boolean",
      "address": "1.2.3.4/32",
      "zone": "string"
    }
  ],
  "upstream_dns_servers": [
    "string"
  ],
  "version": "string",
  "can_upgrade_to": "string",
  "bastion_enabled": "boolean",
  "bastion_port": 42,
  "smtp_enabled": "boolean",
  "zone": "string"
}

Gateway Networks

A Gateway Network represents the connection of a Private Network to a VPC Public Gateway. It holds configuration options relative to this specific connection, such as the DHCP configuration.

List gateway connections to Private Networks

GET
/vpc-gw/v1/zones/{zone}/gateway-networks
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
Query Parameters
order_by
string
Order in which to return results. Possible values are created_at_asc, created_at_desc, status_asc and status_desc. The default value is created_at_asc.
page
number
Page number. The default value is 1.
page_size
number
GatewayNetworks per page. The default value is 20.
gateway_id
nullable string
Filter by gateway (UUID format).
private_network_id
nullable string
Filter by private network (UUID format).
enable_masquerade
nullable boolean
Filter by masquerade enablement.
dhcp_id
nullable string
Filter by DHCP configuration (UUID format).
status
string
Filter GatewayNetworks by this status (unknown for any). Possible values are unknown, created, attaching, configuring, ready, detaching and deleted. The default value is unknown.
200 Response
gateway_networks
array
GatewayNetworks in this page.
id
string
ID of the connection (UUID format).
created_at
string
Connection creation date.
updated_at
string
Connection last modification date.
gateway_id
string
ID of the connected gateway (UUID format).
private_network_id
string
ID of the connected private network (UUID format).
mac_address
nullable string
MAC address of the gateway in the network (if the gateway is up and running).
enable_masquerade
boolean
Whether the gateway masquerades traffic for this network.
status
string
Current status of the gateway network connection. Possible values are unknown, created, attaching, configuring, ready, detaching and deleted. The default value is unknown.
dhcp
object
DHCP configuration for the connected private network.
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
enable_dhcp
boolean
Whether DHCP is enabled on the connected Private Network.
address
nullable string
Address of the Gateway in CIDR form to use when DHCP is not used (IP network).
zone
string
Zone the connection lives in.
total_count
number
Total GatewayNetworks count matching the filter.
Response Example
{
  "gateway_networks": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "string",
      "updated_at": "string",
      "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
      "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
      "mac_address": "string",
      "enable_masquerade": "boolean",
      "status": "unknown",
      "dhcp": {
        "id": "6170692e-7363-616c-6577-61792e636f6d",
        "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
        "project_id": "6170692e-7363-616c-6577-61792e636f6d",
        "created_at": "string",
        "updated_at": "string",
        "subnet": "1.2.3.4/32",
        "address": "1.2.3.4",
        "pool_low": "1.2.3.4",
        "pool_high": "1.2.3.4",
        "enable_dynamic": "boolean",
        "valid_lifetime": "2.5s",
        "renew_timer": "2.5s",
        "rebind_timer": "2.5s",
        "push_default_route": "boolean",
        "push_dns_server": "boolean",
        "dns_servers_override": [
          "string"
        ],
        "dns_search": [
          "string"
        ],
        "dns_local_name": "string",
        "zone": "string"
      },
      "enable_dhcp": "boolean",
      "address": "1.2.3.4/32",
      "zone": "string"
    }
  ],
  "total_count": 42
}

Attach a gateway to a Private Network

POST
/vpc-gw/v1/zones/{zone}/gateway-networks
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
Body
gateway_id
string
Gateway to connect (UUID format).
private_network_id
string
Private Network to connect (UUID format).
enable_masquerade
boolean
Whether to enable masquerade on this network.
dhcp_id
string
Existing configuration (UUID format). Only one of dhcp_id and address may be set.
address
string
Static IP address in CIDR format to to use without DHCP (IP network). Only one of dhcp_id and address may be set.
enable_dhcp
nullable boolean
Whether to enable DHCP on this Private Network. Defaults to `true` if either `dhcp_id` or `dhcp` short: are present. If set to `true`, requires that either `dhcp_id` or `dhcp` to be present. .
Request Example
{
  "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "enable_masquerade": "boolean",
  "dhcp_id": "6170692e-7363-616c-6577-61792e636f6d",
  "address": "1.2.3.4/32",
  "enable_dhcp": "boolean"
}
200 Response
id
string
ID of the connection (UUID format).
created_at
string
Connection creation date.
updated_at
string
Connection last modification date.
gateway_id
string
ID of the connected gateway (UUID format).
private_network_id
string
ID of the connected private network (UUID format).
mac_address
nullable string
MAC address of the gateway in the network (if the gateway is up and running).
enable_masquerade
boolean
Whether the gateway masquerades traffic for this network.
status
string
Current status of the gateway network connection. Possible values are unknown, created, attaching, configuring, ready, detaching and deleted. The default value is unknown.
dhcp
object
DHCP configuration for the connected private network.
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
enable_dhcp
boolean
Whether DHCP is enabled on the connected Private Network.
address
nullable string
Address of the Gateway in CIDR form to use when DHCP is not used (IP network).
zone
string
Zone the connection lives in.
Response Example
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "string",
  "updated_at": "string",
  "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "mac_address": "string",
  "enable_masquerade": "boolean",
  "status": "unknown",
  "dhcp": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "string",
    "updated_at": "string",
    "subnet": "1.2.3.4/32",
    "address": "1.2.3.4",
    "pool_low": "1.2.3.4",
    "pool_high": "1.2.3.4",
    "enable_dynamic": "boolean",
    "valid_lifetime": "2.5s",
    "renew_timer": "2.5s",
    "rebind_timer": "2.5s",
    "push_default_route": "boolean",
    "push_dns_server": "boolean",
    "dns_servers_override": [
      "string"
    ],
    "dns_search": [
      "string"
    ],
    "dns_local_name": "string",
    "zone": "string"
  },
  "enable_dhcp": "boolean",
  "address": "1.2.3.4/32",
  "zone": "string"
}

Get a gateway connection to a Private Network

GET
/vpc-gw/v1/zones/{zone}/gateway-networks/{gateway_network_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
gateway_network_id
required string
ID of the GatewayNetwork to fetch (UUID format).
200 Response
id
string
ID of the connection (UUID format).
created_at
string
Connection creation date.
updated_at
string
Connection last modification date.
gateway_id
string
ID of the connected gateway (UUID format).
private_network_id
string
ID of the connected private network (UUID format).
mac_address
nullable string
MAC address of the gateway in the network (if the gateway is up and running).
enable_masquerade
boolean
Whether the gateway masquerades traffic for this network.
status
string
Current status of the gateway network connection. Possible values are unknown, created, attaching, configuring, ready, detaching and deleted. The default value is unknown.
dhcp
object
DHCP configuration for the connected private network.
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
enable_dhcp
boolean
Whether DHCP is enabled on the connected Private Network.
address
nullable string
Address of the Gateway in CIDR form to use when DHCP is not used (IP network).
zone
string
Zone the connection lives in.
Response Example
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "string",
  "updated_at": "string",
  "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "mac_address": "string",
  "enable_masquerade": "boolean",
  "status": "unknown",
  "dhcp": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "string",
    "updated_at": "string",
    "subnet": "1.2.3.4/32",
    "address": "1.2.3.4",
    "pool_low": "1.2.3.4",
    "pool_high": "1.2.3.4",
    "enable_dynamic": "boolean",
    "valid_lifetime": "2.5s",
    "renew_timer": "2.5s",
    "rebind_timer": "2.5s",
    "push_default_route": "boolean",
    "push_dns_server": "boolean",
    "dns_servers_override": [
      "string"
    ],
    "dns_search": [
      "string"
    ],
    "dns_local_name": "string",
    "zone": "string"
  },
  "enable_dhcp": "boolean",
  "address": "1.2.3.4/32",
  "zone": "string"
}

Update a gateway connection to a Private Network

PATCH
/vpc-gw/v1/zones/{zone}/gateway-networks/{gateway_network_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
gateway_network_id
required string
ID of the GatewayNetwork to update (UUID format).
Body
enable_masquerade
nullable boolean
New masquerade enablement.
dhcp_id
string
New DHCP configuration (UUID format). Only one of dhcp_id and address may be set.
enable_dhcp
nullable boolean
Whether to enable DHCP on the connected Private Network.
address
string
New static IP address (IP network). Only one of dhcp_id and address may be set.
Request Example
{
  "enable_masquerade": "boolean",
  "dhcp_id": "6170692e-7363-616c-6577-61792e636f6d",
  "enable_dhcp": "boolean",
  "address": "1.2.3.4/32"
}
200 Response
id
string
ID of the connection (UUID format).
created_at
string
Connection creation date.
updated_at
string
Connection last modification date.
gateway_id
string
ID of the connected gateway (UUID format).
private_network_id
string
ID of the connected private network (UUID format).
mac_address
nullable string
MAC address of the gateway in the network (if the gateway is up and running).
enable_masquerade
boolean
Whether the gateway masquerades traffic for this network.
status
string
Current status of the gateway network connection. Possible values are unknown, created, attaching, configuring, ready, detaching and deleted. The default value is unknown.
dhcp
object
DHCP configuration for the connected private network.
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
enable_dhcp
boolean
Whether DHCP is enabled on the connected Private Network.
address
nullable string
Address of the Gateway in CIDR form to use when DHCP is not used (IP network).
zone
string
Zone the connection lives in.
Response Example
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "string",
  "updated_at": "string",
  "gateway_id": "6170692e-7363-616c-6577-61792e636f6d",
  "private_network_id": "6170692e-7363-616c-6577-61792e636f6d",
  "mac_address": "string",
  "enable_masquerade": "boolean",
  "status": "unknown",
  "dhcp": {
    "id": "6170692e-7363-616c-6577-61792e636f6d",
    "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
    "project_id": "6170692e-7363-616c-6577-61792e636f6d",
    "created_at": "string",
    "updated_at": "string",
    "subnet": "1.2.3.4/32",
    "address": "1.2.3.4",
    "pool_low": "1.2.3.4",
    "pool_high": "1.2.3.4",
    "enable_dynamic": "boolean",
    "valid_lifetime": "2.5s",
    "renew_timer": "2.5s",
    "rebind_timer": "2.5s",
    "push_default_route": "boolean",
    "push_dns_server": "boolean",
    "dns_servers_override": [
      "string"
    ],
    "dns_search": [
      "string"
    ],
    "dns_local_name": "string",
    "zone": "string"
  },
  "enable_dhcp": "boolean",
  "address": "1.2.3.4/32",
  "zone": "string"
}

Detach a gateway from a Private Network

DELETE
/vpc-gw/v1/zones/{zone}/gateway-networks/{gateway_network_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
gateway_network_id
required string
GatewayNetwork to delete (UUID format).
Query Parameters
cleanup_dhcp
boolean
Whether to cleanup the attached DHCP configuration (if any, and if not attached to another gateway_network). .
204 Response
Empty response

DHCP

DHCP configuration allows you to set parameters for assignment of IP addresses to devices on a Private Network attached to a VPC Public Gateway (subnet, lease time etc).

List DHCP configurations

GET
/vpc-gw/v1/zones/{zone}/dhcps
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
Query Parameters
order_by
string
Order in which to return results. Possible values are created_at_asc, created_at_desc, subnet_asc and subnet_desc. The default value is created_at_asc.
page
number
Page number. The default value is 1.
page_size
number
DHCP configurations per page. The default value is 20.
organization_id
nullable string
Include only DHCPs in this organization (UUID format).
project_id
nullable string
Include only DHCPs in this project (UUID format).
address
nullable string
Filter on gateway address (IP address).
has_address
nullable string
Filter on subnets containing address (IP address).
200 Response
dhcps
array
First page of DHCP configs.
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
total_count
number
Total DHCP configs matching the filter.
Response Example
{
  "dhcps": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
      "project_id": "6170692e-7363-616c-6577-61792e636f6d",
      "created_at": "string",
      "updated_at": "string",
      "subnet": "1.2.3.4/32",
      "address": "1.2.3.4",
      "pool_low": "1.2.3.4",
      "pool_high": "1.2.3.4",
      "enable_dynamic": "boolean",
      "valid_lifetime": "2.5s",
      "renew_timer": "2.5s",
      "rebind_timer": "2.5s",
      "push_default_route": "boolean",
      "push_dns_server": "boolean",
      "dns_servers_override": [
        "string"
      ],
      "dns_search": [
        "string"
      ],
      "dns_local_name": "string",
      "zone": "string"
    }
  ],
  "total_count": 42
}

Create a DHCP configuration

POST
/vpc-gw/v1/zones/{zone}/dhcps
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
Body
project_id
string
Project to create the DHCP configuration in (UUID format).
subnet
string
Subnet for the DHCP server (IP network).
address
nullable string
Address of the DHCP server. This will be the gateway's address in the private network. Defaults to the first address of the subnet (IP address).
pool_low
nullable string
Low IP (included) of the dynamic address pool. Defaults to the second address of the subnet. (IP address).
pool_high
nullable string
High IP (included) of the dynamic address pool. Defaults to the last address of the subnet. (IP address).
enable_dynamic
nullable boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true. .
valid_lifetime
nullable string
For how long, in seconds, will DHCP entries will be valid. Defaults to 1h (3600s). (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. Defaults to 50m (3000s). (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. Defaults to 51m (3060s). (in seconds).
push_default_route
nullable boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs. Defaults to true.
push_dns_server
nullable boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. Defaults to true. .
dns_servers_override
nullable array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
nullable array
Additional DNS search paths.
dns_local_name
nullable string
TLD given to hostnames in the Private Network. Allowed characters are `a-z0-9-.`. Defaults to the slugified Private Network name if created along a GatewayNetwork, or else to `priv`. .
Request Example
{
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "subnet": "1.2.3.4/32",
  "address": "1.2.3.4",
  "pool_low": "1.2.3.4",
  "pool_high": "1.2.3.4",
  "enable_dynamic": "boolean",
  "valid_lifetime": "2.5s",
  "renew_timer": "2.5s",
  "rebind_timer": "2.5s",
  "push_default_route": "boolean",
  "push_dns_server": "boolean",
  "dns_servers_override": [
    "string"
  ],
  "dns_search": [
    "string"
  ],
  "dns_local_name": "string"
}
200 Response
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
Response Example
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "string",
  "updated_at": "string",
  "subnet": "1.2.3.4/32",
  "address": "1.2.3.4",
  "pool_low": "1.2.3.4",
  "pool_high": "1.2.3.4",
  "enable_dynamic": "boolean",
  "valid_lifetime": "2.5s",
  "renew_timer": "2.5s",
  "rebind_timer": "2.5s",
  "push_default_route": "boolean",
  "push_dns_server": "boolean",
  "dns_servers_override": [
    "string"
  ],
  "dns_search": [
    "string"
  ],
  "dns_local_name": "string",
  "zone": "string"
}

Get a DHCP configuration

GET
/vpc-gw/v1/zones/{zone}/dhcps/{dhcp_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
dhcp_id
required string
ID of the DHCP config to fetch (UUID format).
200 Response
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
array
Add search paths to the pushed DNS configuration.
dns_local_name
string
TLD given to hostnames in the Private Network. If an instance with hostname `foo` gets a lease, and this is set to `bar`, `foo.bar` will resolve. .
zone
string
Zone this configuration is available in.
Response Example
{
  "id": "6170692e-7363-616c-6577-61792e636f6d",
  "organization_id": "6170692e-7363-616c-6577-61792e636f6d",
  "project_id": "6170692e-7363-616c-6577-61792e636f6d",
  "created_at": "string",
  "updated_at": "string",
  "subnet": "1.2.3.4/32",
  "address": "1.2.3.4",
  "pool_low": "1.2.3.4",
  "pool_high": "1.2.3.4",
  "enable_dynamic": "boolean",
  "valid_lifetime": "2.5s",
  "renew_timer": "2.5s",
  "rebind_timer": "2.5s",
  "push_default_route": "boolean",
  "push_dns_server": "boolean",
  "dns_servers_override": [
    "string"
  ],
  "dns_search": [
    "string"
  ],
  "dns_local_name": "string",
  "zone": "string"
}

Update a DHCP configuration

PATCH
/vpc-gw/v1/zones/{zone}/dhcps/{dhcp_id}
Path Parameters
zone
required string
The zone you want to target. Possible values are fr-par-1, fr-par-2, nl-ams-1 and pl-waw-1.
dhcp_id
required string
DHCP config to update (UUID format).
Body
subnet
nullable string
Subnet for the DHCP server (IP network).
address
nullable string
Address of the DHCP server. This will be the gateway's address in the private network (IP address).
pool_low
nullable string
Low IP (included) of the dynamic address pool (IP address).
pool_high
nullable string
High IP (included) of the dynamic address pool (IP address).
enable_dynamic
nullable boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. Defaults to true. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
nullable boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
nullable boolean
Whether the gateway should push custom DNS servers to clients. This allows for instance hostname -> IP resolution. .
dns_servers_override
nullable array
Override the DNS server list pushed to DHCP clients, instead of the gateway itself.
dns_search
nullable array
Additional DNS search paths.
dns_local_name
nullable string
TLD given to hostnames in the Private Network. Allowed characters are `a-z0-9-.`.
Request Example
{
  "subnet": "1.2.3.4/32",
  "address": "1.2.3.4",
  "pool_low": "1.2.3.4",
  "pool_high": "1.2.3.4",
  "enable_dynamic": "boolean",
  "valid_lifetime": "2.5s",
  "renew_timer": "2.5s",
  "rebind_timer": "2.5s",
  "push_default_route": "boolean",
  "push_dns_server": "boolean",
  "dns_servers_override": [
    "string"
  ],
  "dns_search": [
    "string"
  ],
  "dns_local_name": "string"
}
200 Response
id
string
ID of the DHCP config (UUID format).
organization_id
string
Owning organization (UUID format).
project_id
string
Owning project (UUID format).
created_at
string
Configuration creation date.
updated_at
string
Configuration last modification date.
subnet
string
Subnet for the DHCP server (IP network).
address
string
Address of the DHCP server. This will be the gateway's address in the private network. It must be part of config's subnet. (IP address).
pool_low
string
Low IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
pool_high
string
High IP (included) of the dynamic address pool. Must be in the config's subnet (IP address).
enable_dynamic
boolean
Whether to enable dynamic pooling of IPs. By turning the dynamic pool off, only pre-existing DHCP reservations will be handed out. .
valid_lifetime
nullable string
How long, in seconds, DHCP entries will be valid for (in seconds).
renew_timer
nullable string
After how long, in seconds, a renew will be attempted. Must be 30s lower than `rebind_timer`. (in seconds).
rebind_timer
nullable string
After how long, in seconds, a DHCP client will query for a new lease if previous renews fail. Must be 30s lower than `valid_lifetime`. (in seconds).
push_default_route
boolean
Whether the gateway should push a default route to DHCP clients or only hand out IPs.
push_dns_server
boolean
Whether the gateway shou