Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Hetzner Primary IPs API

Primary IPs help you to create more flexible networking setups. You can assign at most one Primary IP of type `ipv4` and one of type `ipv6` per Server. This Server then uses these IPs.You can only unassign a Primary IP from a Server when it's powered off. This Primary IP can then be assigned to a different powered off Server, or you can keep it around for later use.Primary IPs are bound to a specific Location. You can not assign a Primary IP from one Location to a Server in a different Location. If you need this capability use Floating IPs instead.If your Server's operating system supports cloud-init there is no further configuration needed to make Primary IPs work.Primary IPs of type `ipv4` use a single IPv4 address as their `ip` property. Primary IPs of type `ipv6` use a /64 network such as `fc00::/64` as their `ip` property. Any IP address within that network can be used on your host.Primary IPs are billed on an hourly basis.

Hetzner Primary IPs API is one of 32 APIs that Hetzner publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Primary IPs. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.

This API exposes 5 operations across 2 paths. It is described by OpenAPI 3.0.3, at version 1.0.0.

Requests are made against a single base URL, https://api.hetzner.cloud/v1.

5 operations 2 paths 0 schemas 1 DELETE2 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.0
Base URL
https://api.hetzner.cloud/v1
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Hetzner Primary IPs API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (APIToken). By default, every request must be authenticated.

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Primary IPs 5

Primary IPs help you to create more flexible networking setups. You can assign at most one Primary IP of type ipv4 and one of type ipv6 per Server. This Server then uses these IPs…

GET
/primary_ips
List Primary IPs
list_primary_ips 6 params → 2004xx5xx
POST
/primary_ips
Create a Primary IP
create_primary_ip body → 2014xx5xx
GET
/primary_ips/{id}
Get a Primary IP
get_primary_ip 1 param → 2004xx5xx
PUT
/primary_ips/{id}
Update a Primary IP
update_primary_ip 1 param body → 2004xx5xx
DELETE
/primary_ips/{id}
Delete a Primary IP
delete_primary_ip 1 param → 2044xx5xx

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hetzner-primary-ips-api-openapi.yml Raw ↑

Other APIs Hetzner publishes across the network.

Hetzner DNS API
Hetzner Actions API
Hetzner Certificate Actions API
Hetzner Certificates API
Hetzner Data Centers API
Hetzner Firewall Actions API
Hetzner Firewalls API
Hetzner Floating IP Actions API
Hetzner Floating IPs API
Hetzner Image Actions API
Hetzner Images API
Hetzner ISOs API