# Hetzner Networks API **Canonical:** https://apis.io/apis/hetzner/hetzner-networks-api/ **Provider:** Hetzner — https://apis.io/providers/hetzner/ **Base URL:** https://api.hetzner.cloud/v1 **Documentation:** https://docs.hetzner.cloud/ Hetzner Networks API is one of 32 APIs that [Hetzner](https://apis.io/providers/hetzner/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Networks. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide. Networks is a private networks feature. These Networks are optional and they coexist with the public network that every Server has by default. They allow Servers to talk to each other over a dedicated network interface using private IP addresses not available publicly. The IP addresses are allocated and managed via the API, they must conform to [RFC1918](https://tools.ietf.org/html/rfc1918#section-3) standard. IPs and network interfaces defined under Networks do not provide public internet connectivity, you will need to use the already existing public network interface for that. Each network has a user selected `ip_range` which defines all available IP addresses which can be used for Subnets within the Network. To assign individual IPs to Servers you will need to create Network Subnets, described below. Currently Networks support IPv4 only. ### Subnets Subnets divide the `ip_range` from the parent Network object into multiple Subnetworks that you can use for different specific purposes. For each subnet you need to specify its own `ip_range` which must be contained within the parent Network’s `ip_range`. Additionally each subnet must belong to one of the available Network Zones described below. Subnets can not have overlapping IP ranges. Currently there are three types of subnet: - type `cloud` is used to connect cloud Resources into your Network. - type `server` was used to connect only cloud Servers into your Network. This type is deprecated and is replaced by type cloud. - type `vswitch` allows you to connect [Dedicated Server vSwitch](https://docs.hetzner.com/robot/dedicated-server/network/vswitch) - and all Dedicated Servers attached to it - into your Network Subnets of type `vswitch` must set a `vswitch_id` which is the ID of the existing vSwitch in Hetzner Robot that should be coupled. ### Network Zones Network Zones are groups of Locations which have special high-speed network connections between them. The [Location object](https://docs.hetzner.cloud/reference/cloud#locations-get-a-location) contains the `network_zone` property each Location belongs to. Currently these network zones exist: | Network Zone | Contains Locations | | ------------ | ------------------ | | eu-central | nbg1, fsn1, hel1 | | us-east | ash | | us-west | hil | | ap-southeast | sin | ### IP address management When a cloud Server is attached to a network without the user specifying an IP it automatically gets an IP address assigned from a subnet of type `server` in the same network zone. If you specify the optional `ip` parameter when attaching then we will try to assign that IP. Keep in mind that the Server’s location must be covered by the Subnet’s Network Zone if you specify an IP, or that at least one Subnet with the zone covering Server’s location must exist. A cloud Server can also have more than one IP address in a Network by specifying aliases. For details see the [attach to network action](https://docs.hetzner.cloud/reference/cloud#server-actions-attach-a-server-to-a-network). The following IP addresses are reserved in networks and can not be used: - the first IP of the network `ip_range` as it will be used as a default gateway for the private Network interface. - `172.31.1.1` as it is being used as default gateway for our public Network interfaces. ### Coupling Dedicated Servers By using subnets of type `vswitch` you can couple the Cloud Networks with an existing [Dedicated Server vSwitch](https://docs.hetzner.com/robot/dedicated-server/network/vswitch) and enable dedicated and cloud servers to talk to each other over the Network. In order for this to work the dedicated servers may only use IPs from the subnet and must have a special network configuration. Please refer to [FAQ](https://docs.hetzner.com/cloud/networks/connect-dedi-vswitch). vSwitch Layer 2 features are not supported. ### Routes Networks also support the notion of routes which are automatically applied to private traffic. A route makes sure that all packets for a given `destination` IP prefix will be sent to the address specified in its `gateway`. ## Machine-readable artifacts (3) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/hetzner/refs/heads/main/openapi/hetzner-networks-api-openapi.yml - **Documentation** — https://docs.hetzner.cloud/ - **GettingStarted** — https://docs.hetzner.cloud/#getting-started ## Other Hetzner APIs (12) - [Hetzner DNS API](https://apis.io/apis/hetzner/hetzner-dns-api/) - [Hetzner Actions API](https://apis.io/apis/hetzner/hetzner-actions-api/) - [Hetzner Certificate Actions API](https://apis.io/apis/hetzner/hetzner-certificate-actions-api/) - [Hetzner Certificates API](https://apis.io/apis/hetzner/hetzner-certificates-api/) - [Hetzner Data Centers API](https://apis.io/apis/hetzner/hetzner-data-centers-api/) - [Hetzner Firewall Actions API](https://apis.io/apis/hetzner/hetzner-firewall-actions-api/) - [Hetzner Firewalls API](https://apis.io/apis/hetzner/hetzner-firewalls-api/) - [Hetzner Floating IP Actions API](https://apis.io/apis/hetzner/hetzner-floating-ip-actions-api/) - [Hetzner Floating IPs API](https://apis.io/apis/hetzner/hetzner-floating-ips-api/) - [Hetzner Image Actions API](https://apis.io/apis/hetzner/hetzner-image-actions-api/) - [Hetzner Images API](https://apis.io/apis/hetzner/hetzner-images-api/) - [Hetzner ISOs API](https://apis.io/apis/hetzner/hetzner-isos-api/) ## Tags Networks --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/hetzner/hetzner-networks-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/hetzner/.