Hetzner

Hetzner Cloud API

This is the official API documentation for the Public Hetzner Cloud. Introduction The Hetzner Cloud API operates over HTTPS and uses JSON as its data format.…

Developer tools#openapi#hosting

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the official API documentation for the Public Hetzner Cloud.

Introduction

The Hetzner Cloud API operates over HTTPS and uses JSON as its data format. The API is a RESTful API and utilizes HTTP methods and HTTP status codes to specify requests and responses.

As an alternative to working directly with our API you may also consider to use:

Also you can find a list of libraries, tools, and integrations on GitHub.

If you are developing integrations based on our API and your product is Open Source you may be eligible for a free one time €50 (excl. VAT) credit on your account. Please contact us via the the support page on your Cloud Console and let us know the following:

  • The type of integration you would like to develop
  • Link to the GitHub repo you will use for the Project
  • Link to some other Open Source work you have already done (if you have done so)

Getting Started

To get started using the API you first need an API token. Sign in into the Hetzner Cloud Console choose a Project, go to Security → API Tokens, and generate a new token. Make sure to copy the token because it won’t be shown to you again. A token is bound to a Project, to interact with the API of another Project you have to create a new token inside the Project. Let’s say your new token is jEheVytlAoFl7F8MqUQ7jAo2hOXASztX.

You’re now ready to do your first request against the API. To get a list of all Servers in your Project, issue the example request on the right side using curl.

Make sure to replace the token in the example command with the token you have just created. Since your Project probably does not contain any Servers yet, the example response will look like the response on the right side. We will almost always provide a resource root like servers inside the example response. A response can also contain a meta object with information like Pagination.

Example Request

curl -H "Authorization: Bearer jEheVytlAoFl7F8MqUQ7jAo2hOXASztX" \
    https://api.hetzner.cloud/v1/servers

Example Response

{
    "servers": [],
    "meta": {
        "pagination": {
            "page": 1,
            "per_page": 25,
            "previous_page": null,
            "next_page": null,
            "last_page": 1,
            "total_entries": 0
        }
    }
}

Authentication

All requests to the Hetzner Cloud API must be authenticated via a API token. Include your secret API token in every request you send to the API with the Authorization HTTP header.

To create a new API token for your Project, switch into the Hetzner Cloud Console choose a Project, go to Security → API Tokens, and generate a new token.

Example Authorization header

Authorization: Bearer LRK9DAWQ1ZAEFSrCNEEzLCUwhYX1U3g7wMg4dTlkkDC96fyDuyJ39nVbVjCKSDfj

Errors

Errors are indicated by HTTP status codes. Further, the response of the request which generated the error contains an error code, an error message, and, optionally, error details. The schema of the error details object depends on the error code.

The error response contains the following keys:

KeysMeaning
codeShort string indicating the type of error (machine-parsable)
messageTextual description on what has gone wrong
detailsAn object providing for details on the error (schema depends on code)

Example response

{
  "error": {
    "code": "invalid_input",
    "message": "invalid input in field 'broken_field': is too long",
    "details": {
      "fields": [
        {
          "name": "broken_field",
          "messages": ["is too long"]
        }
      ]
    }
  }
}

Error Codes

CodeDescription
forbiddenInsufficient permissions for this request
invalid_inputError while parsing or processing the input
json_errorInvalid JSON input in your request
lockedThe item you are trying to access is locked (there is already an Action running)
not_foundEntity not found …

Endpoints 144

Actions

  • GETGet all Actions/actions?id=0&sort=id&status=runningReturns all Action objects. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
  • GETGet an Action/actions/:idReturns a specific Action object.

Certificates

  • GETGet all Certificates/certificates?sort=id&name=string&label_selector=string&type=uploadedReturns all Certificate objects.
  • POSTCreate a Certificate/certificatesCreates a new Certificate. The default type uploaded allows for uploading your existing certificate and private_key in PEM format. You have to monitor its…
  • GETGet a Certificate/certificates/:idGets a specific Certificate object.
  • PUTUpdate a Certificate/certificates/:idUpdates the Certificate properties. Note that when updating labels, the Certificate’s current set of labels will be replaced with the labels provided in the…
  • DELETEDelete a Certificate/certificates/:idDeletes a Certificate.

Certificate Actions

  • GETGet all Actions for a Certificate/certificates/:id/actions?sort=id&status=runningReturns all Action objects for a Certificate. You can sort the results by using the sort URI parameter, and filter them with the status parameter. Only type…
  • POSTRetry Issuance or Renewal/certificates/:id/actions/retryRetry a failed Certificate issuance or renewal. Only applicable if the type of the Certificate is managed and the issuance or renewal status is failed. Call…
  • GETGet an Action for a Certificate/certificates/:id/actions/:action_idReturns a specific Action for a Certificate. Only type managed Certificates have Actions.

Datacenters

  • GETGet all Datacenters/datacenters?name=stringReturns all Datacenter objects.
  • GETGet a Datacenter/datacenters/:idReturns a specific Datacenter object.

Firewalls

  • GETGet all Firewalls/firewalls?sort=id&name=string&label_selector=stringReturns all Firewall objects.
  • POSTCreate a Firewall/firewallsCreates a new Firewall. Call specific error codes
  • GETGet a Firewall/firewalls/:idGets a specific Firewall object.
  • PUTUpdate a Firewall/firewalls/:idUpdates the Firewall. Note that when updating labels, the Firewall's current set of labels will be replaced with the labels provided in the request body. So,…
  • DELETEDelete a Firewall/firewalls/:idDeletes a Firewall. Call specific error codes

Firewall Actions

  • GETGet all Actions for a Firewall/firewalls/:id/actions?sort=id&status=runningReturns all Action objects for a Firewall. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
  • POSTApply to Resources/firewalls/:id/actions/apply_to_resourcesApplies one Firewall to multiple resources. Currently servers (public network interface) and label selectors are supported. Call specific error codes
  • POSTRemove from Resources/firewalls/:id/actions/remove_from_resourcesRemoves one Firewall from multiple resources. Currently only Servers (and their public network interfaces) are supported. Call specific error codes
  • POSTSet Rules/firewalls/:id/actions/set_rulesSets the rules of a Firewall. All existing rules will be overwritten. Pass an empty rules array to remove all rules. The maximum amount of rules that can be…
  • GETGet an Action for a Firewall/firewalls/:id/actions/:action_idReturns a specific Action for a Firewall.

Floating IPs

  • GETGet all Floating IPs/floating_ips?name=string&label_selector=string&sort=idReturns all Floating IP objects.
  • POSTCreate a Floating IP/floating_ipsCreates a new Floating IP assigned to a Server. If you want to create a Floating IP that is not bound to a Server, you need to provide the home_location key…
  • GETGet a Floating IP/floating_ips/:idReturns a specific Floating IP object.
  • PUTUpdate a Floating IP/floating_ips/:idUpdates the description or labels of a Floating IP. Also note that when updating labels, the Floating IP’s current set of labels will be replaced with the…
  • DELETEDelete a Floating IP/floating_ips/:idDeletes a Floating IP. If it is currently assigned to a Server it will automatically get unassigned.

Floating IP Actions

  • GETGet all Actions for a Floating IP/floating_ips/:id/actions?sort=id&status=runningReturns all Action objects for a Floating IP. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
  • POSTAssign a Floating IP to a Server/floating_ips/:id/actions/assignAssigns a Floating IP to a Server.
  • POSTChange reverse DNS entry for a Floating IP/floating_ips/:id/actions/change_dns_ptrChanges the hostname that will appear when getting the hostname belonging to this Floating IP.
  • POSTChange Floating IP Protection/floating_ips/:id/actions/change_protectionChanges the protection configuration of the Floating IP.
  • POSTUnassign a Floating IP/floating_ips/:id/actions/unassignUnassigns a Floating IP, resulting in it being unreachable. You may assign it to a Server again at a later time.
  • GETGet an Action for a Floating IP/floating_ips/:id/actions/:action_idReturns a specific Action object for a Floating IP.

Images

  • GETGet all Images/images?sort=id&type=system&status=available&bound_to=string&include_deprecated=true&name=string&label_selector=stringReturns all Image objects. You can select specific Image types only and sort the results by using URI parameters.
  • GETGet an Image/images/:idReturns a specific Image object.
  • PUTUpdate an Image/images/:idUpdates the Image. You may change the description, convert a Backup Image to a Snapshot Image or change the Image labels. Only Images of type snapshot and…
  • DELETEDelete an Image/images/:idDeletes an Image. Only Images of type snapshot and backup can be deleted.

Image Actions

  • GETGet all Actions for an Image/images/:id/actions?sort=id&status=runningReturns all Action objects for an Image. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
  • POSTChange Image Protection/images/:id/actions/change_protectionChanges the protection configuration of the Image. Can only be used on snapshots.
  • GETGet an Action for an Image/images/:id/actions/:action_idReturns a specific Action for an Image.

ISOs

  • GETGet all ISOs/isos?name=stringReturns all available ISO objects.
  • GETGet an ISO/isos/:idReturns a specific ISO object.

Load Balancers

  • GETGet all Load Balancers/load_balancers?sort=id&name=string&label_selector=stringGets all existing Load Balancers that you have available.
  • POSTCreate a Load Balancer/load_balancersCreates a Load Balancer. Call specific error codes
  • GETGet a Load Balancer/load_balancers/:idGets a specific Load Balancer object.
  • PUTUpdate a Load Balancer/load_balancers/:idUpdates a Load Balancer. You can update a Load Balancer’s name and a Load Balancer’s labels. Note that when updating labels, the Load Balancer’s current set…
  • DELETEDelete a Load Balancer/load_balancers/:idDeletes a Load Balancer.
  • GETGet Metrics for a LoadBalancer/load_balancers/:id/metrics?type=open_connections&start=string&end=string&step=stringYou must specify the type of metric to get: open_connections, connections_per_second, requests_per_second or bandwidth. You can also specify more than one…

Load Balancer Actions

  • GETGet all Actions for a Load Balancer/load_balancers/:id/actions?sort=id&status=runningReturns all Action objects for a Load Balancer. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
  • POSTAdd Service/load_balancers/:id/actions/add_serviceAdds a service to a Load Balancer. Call specific error codes
  • POSTAdd Target/load_balancers/:id/actions/add_targetAdds a target to a Load Balancer. Call specific error codes
  • POSTAttach a Load Balancer to a Network/load_balancers/:id/actions/attach_to_networkAttach a Load Balancer to a Network. Call specific error codes
  • POSTChange Algorithm/load_balancers/:id/actions/change_algorithmChange the algorithm that determines to which target new requests are sent.
  • POSTChange reverse DNS entry for this Load Balancer/load_balancers/:id/actions/change_dns_ptrChanges the hostname that will appear when getting the hostname belonging to the public IPs (IPv4 and IPv6) of this Load Balancer. Floating IPs assigned to…
  • POSTChange Load Balancer Protection/load_balancers/:id/actions/change_protectionChanges the protection configuration of a Load Balancer.
  • POSTChange the Type of a Load Balancer/load_balancers/:id/actions/change_typeChanges the type (Max Services, Max Targets and Max Connections) of a Load Balancer. Call specific error codes
  • POSTDelete Service/load_balancers/:id/actions/delete_serviceDelete a service of a Load Balancer.
  • POSTDetach a Load Balancer from a Network/load_balancers/:id/actions/detach_from_networkDetaches a Load Balancer from a network.
  • POSTDisable the public interface of a Load Balancer/load_balancers/:id/actions/disable_public_interfaceDisable the public interface of a Load Balancer. The Load Balancer will be not accessible from the internet via its public IPs. Call specific error codes
  • POSTEnable the public interface of a Load Balancer/load_balancers/:id/actions/enable_public_interfaceEnable the public interface of a Load Balancer. The Load Balancer will be accessible from the internet via its public IPs.
  • POSTRemove Target/load_balancers/:id/actions/remove_targetRemoves a target from a Load Balancer.
  • POSTUpdate Service/load_balancers/:id/actions/update_serviceUpdates a Load Balancer Service. Call specific error codes
  • GETGet an Action for a Load Balancer/load_balancers/:id/actions/:action_idReturns a specific Action for a Load Balancer.

Load Balancer Types

  • GETGet all Load Balancer Types/load_balancer_types?name=stringGets all Load Balancer type objects.
  • GETGet a Load Balancer Type/load_balancer_types/:idGets a specific Load Balancer type object.

Locations

  • GETGet all Locations/locations?name=stringReturns all Location objects.
  • GETGet a Location/locations/:idReturns a specific Location object.

Primary IPs

  • GETGet all Primary IPs/primary_ips?name=string&label_selector=string&ip=127.0.0.1&sort=idReturns all Primary IP objects.
  • POSTCreate a Primary IP/primary_ipsCreates a new Primary IP, optionally assigned to a Server. If you want to create a Primary IP that is not assigned to a Server, you need to provide the…
  • GETGet a Primary IP/primary_ips/:idReturns a specific Primary IP object.
  • PUTUpdate a Primary IP/primary_ips/:idUpdates the Primary IP. Note that when updating labels, the Primary IP's current set of labels will be replaced with the labels provided in the request body.…
  • DELETEDelete a Primary IP/primary_ips/:idDeletes a Primary IP. The Primary IP may be assigned to a Server. In this case it is unassigned automatically. The Server must be powered off (status off) in…

Primary IP Actions

  • POSTAssign a Primary IP to a resource/primary_ips/:id/actions/assignAssigns a Primary IP to a Server. A Server can only have one Primary IP of type ipv4 and one of type ipv6 assigned. If you need more IPs use Floating IPs. The…
  • POSTChange reverse DNS entry for a Primary IP/primary_ips/:id/actions/change_dns_ptrChanges the hostname that will appear when getting the hostname belonging to this Primary IP.
  • POSTChange Primary IP Protection/primary_ips/:id/actions/change_protectionChanges the protection configuration of a Primary IP. A Primary IP can only be delete protected if its auto_delete property is set to false.
  • POSTUnassign a Primary IP from a resource/primary_ips/:id/actions/unassignUnassigns a Primary IP from a Server. The Server must be powered off (status off) in order for this operation to succeed. Note that only Servers that have at…

Networks

  • GETGet all Networks/networks?name=string&label_selector=stringGets all existing networks that you have available.
  • POSTCreate a Network/networksCreates a network with the specified ip_range. You may specify one or more subnets. You can also add more Subnets later by using the add subnet action. If you…
  • GETGet a Network/networks/:idGets a specific network object.
  • PUTUpdate a Network/networks/:idUpdates the network properties. Note that when updating labels, the network’s current set of labels will be replaced with the labels provided in the request…
  • DELETEDelete a Network/networks/:idDeletes a network. If there are Servers attached they will be detached in the background. Note: if the network object changes during the request, the response…

Network Actions

  • GETGet all Actions for a Network/networks/:id/actions?sort=id&status=runningReturns all Action objects for a Network. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
  • POSTAdd a route to a Network/networks/:id/actions/add_routeAdds a route entry to a Network. Note: if the Network object changes during the request, the response will be a “conflict” error.
  • POSTAdd a subnet to a Network/networks/:id/actions/add_subnetAdds a new subnet object to the Network. If you do not specify an ip_range for the subnet we will automatically pick the first available /24 range for you if…
  • POSTChange IP range of a Network/networks/:id/actions/change_ip_rangeChanges the IP range of a Network. IP ranges can only be extended and never shrunk. You can only add IPs at the end of an existing IP range. This means that…
  • POSTChange Network Protection/networks/:id/actions/change_protectionChanges the protection configuration of a Network. Note: if the Network object changes during the request, the response will be a “conflict” error.
  • POSTDelete a route from a Network/networks/:id/actions/delete_routeDelete a route entry from a Network. Note: if the Network object changes during the request, the response will be a “conflict” error.
  • POSTDelete a subnet from a Network/networks/:id/actions/delete_subnetDeletes a single subnet entry from a Network. You cannot delete subnets which still have Servers attached. If you have Servers attached you first need to…
  • GETGet an Action for a Network/networks/:id/actions/:action_idReturns a specific Action for a Network.

Placement Groups

  • GETGet all PlacementGroups/placement_groups?sort=id&name=string&label_selector=string&type=spreadReturns all PlacementGroup objects.
  • POSTCreate a PlacementGroup/placement_groupsCreates a new PlacementGroup.
  • GETGet a PlacementGroup/placement_groups/:idGets a specific PlacementGroup object.
  • PUTUpdate a PlacementGroup/placement_groups/:idUpdates the PlacementGroup properties. Note that when updating labels, the PlacementGroup’s current set of labels will be replaced with the labels provided in…
  • DELETEDelete a PlacementGroup/placement_groups/:idDeletes a PlacementGroup.

Pricing

  • GETGet all prices/pricingReturns prices for all resources available on the platform. VAT and currency of the Project owner are used for calculations. Both net and gross prices are…

Servers

  • GETGet all Servers/servers?name=string&label_selector=string&sort=id&status=initializingReturns all existing Server objects
  • POSTCreate a Server/serversCreates a new Server. Returns preliminary information about the Server as well as an Action that covers progress of creation.
  • GETGet a Server/servers/:idReturns a specific Server object. The Server must exist inside the Project
  • PUTUpdate a Server/servers/:idUpdates a Server. You can update a Server’s name and a Server’s labels. Please note that Server names must be unique per Project and valid hostnames as per…
  • DELETEDelete a Server/servers/:idDeletes a Server. This immediately removes the Server from your account, and it is no longer accessible.
  • GETGet Metrics for a Server/servers/:id/metrics?type=cpu&start=string&end=string&step=stringGet Metrics for specified Server. You must specify the type of metric to get: cpu, disk or network. You can also specify more than one type by comma…

Server Actions

  • GETGet all Actions for a Server/servers/:id/actions?sort=id&status=runningReturns all Action objects for a Server. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
  • POSTAdd a Server to a Placement Group/servers/:id/actions/add_to_placement_groupAdds a Server to a Placement Group. Server must be powered off for this command to succeed. Call specific error codes
  • POSTAttach an ISO to a Server/servers/:id/actions/attach_isoAttaches an ISO to a Server. The Server will immediately see it as a new disk. An already attached ISO will automatically be detached before the new ISO is…
  • POSTAttach a Server to a Network/servers/:id/actions/attach_to_networkAttaches a Server to a network. This will complement the fixed public Server interface by adding an additional ethernet interface to the Server which is…
  • POSTChange alias IPs of a Network/servers/:id/actions/change_alias_ipsChanges the alias IPs of an already attached Network. Note that the existing aliases for the specified Network will be replaced with these provided in the…
  • POSTChange reverse DNS entry for this Server/servers/:id/actions/change_dns_ptrChanges the hostname that will appear when getting the hostname belonging to the primary IPs (IPv4 and IPv6) of this Server. Floating IPs assigned to the…
  • POSTChange Server Protection/servers/:id/actions/change_protectionChanges the protection configuration of the Server.
  • POSTChange the Type of a Server/servers/:id/actions/change_typeChanges the type (Cores, RAM and disk sizes) of a Server. Server must be powered off for this command to succeed. This copies the content of its disk, and…
  • POSTCreate Image from a Server/servers/:id/actions/create_imageCreates an Image (snapshot) from a Server by copying the contents of its disks. This creates a snapshot of the current state of the disk and copies it into an…
  • POSTDetach a Server from a Network/servers/:id/actions/detach_from_networkDetaches a Server from a network. The interface for this network will vanish.
  • POSTDetach an ISO from a Server/servers/:id/actions/detach_isoDetaches an ISO from a Server. In case no ISO Image is attached to the Server, the status of the returned Action is immediately set to success
  • POSTDisable Backups for a Server/servers/:id/actions/disable_backupDisables the automatic backup option and deletes all existing Backups for a Server. No more additional charges for backups will be made. Caution: This…
  • POSTDisable Rescue Mode for a Server/servers/:id/actions/disable_rescueDisables the Hetzner Rescue System for a Server. This makes a Server start from its disks on next reboot. Rescue Mode is automatically disabled when you first…
  • POSTEnable and Configure Backups for a Server/servers/:id/actions/enable_backupEnables and configures the automatic daily backup option for the Server. Enabling automatic backups will increase the price of the Server by 20%. In return,…
  • POSTEnable Rescue Mode for a Server/servers/:id/actions/enable_rescueEnable the Hetzner Rescue System for this Server. The next time a Server with enabled rescue mode boots it will start a special minimal Linux distribution…
  • POSTPower off a Server/servers/:id/actions/poweroffCuts power to the Server. This forcefully stops it without giving the Server operating system time to gracefully stop. May lead to data loss, equivalent to…
  • POSTPower on a Server/servers/:id/actions/poweronStarts a Server by turning its power on.
  • POSTSoft-reboot a Server/servers/:id/actions/rebootReboots a Server gracefully by sending an ACPI request. The Server operating system must support ACPI and react to the request, otherwise the Server will not…
  • POSTRebuild a Server from an Image/servers/:id/actions/rebuildRebuilds a Server overwriting its disk with the content of an Image, thereby destroying all data on the target Server The Image can either be one you have…
  • POSTRemove from Placement Group/servers/:id/actions/remove_from_placement_groupRemoves a Server from a Placement Group.
  • POSTRequest Console for a Server/servers/:id/actions/request_consoleRequests credentials for remote access via VNC over websocket to keyboard, monitor, and mouse for a Server. The provided URL is valid for 1 minute, after this…
  • POSTReset a Server/servers/:id/actions/resetCuts power to a Server and starts it again. This forcefully stops it without giving the Server operating system time to gracefully stop. This may lead to data…
  • POSTReset root Password of a Server/servers/:id/actions/reset_passwordResets the root password. Only works for Linux systems that are running the qemu guest agent. Server must be powered on (status running) in order for this…
  • POSTShutdown a Server/servers/:id/actions/shutdownShuts down a Server gracefully by sending an ACPI shutdown request. The Server operating system must support ACPI and react to the request, otherwise the…
  • GETGet an Action for a Server/servers/:id/actions/:action_idReturns a specific Action object for a Server.

Server Types

  • GETGet all Server Types/server_types?name=stringGets all Server type objects.
  • GETGet a Server Type/server_types/:idGets a specific Server type object.

SSH Keys

  • GETGet all SSH keys/ssh_keys?sort=id&name=string&fingerprint=string&label_selector=stringReturns all SSH key objects.
  • POSTCreate an SSH key/ssh_keysCreates a new SSH key with the given name and public_key. Once an SSH key is created, it can be used in other calls such as creating Servers.
  • GETGet a SSH key/ssh_keys/:idReturns a specific SSH key object.
  • PUTUpdate an SSH key/ssh_keys/:idUpdates an SSH key. You can update an SSH key name and an SSH key labels. Please note that when updating labels, the SSH key current set of labels will be…
  • DELETEDelete an SSH key/ssh_keys/:idDeletes an SSH key. It cannot be used anymore.

Volumes

  • GETGet all Volumes/volumes?status=available&sort=id&name=string&label_selector=stringGets all existing Volumes that you have available.
  • POSTCreate a Volume/volumesCreates a new Volume attached to a Server. If you want to create a Volume that is not attached to a Server, you need to provide the location key instead of…
  • GETGet a Volume/volumes/:idGets a specific Volume object.
  • PUTUpdate a Volume/volumes/:idUpdates the Volume properties. Note that when updating labels, the volume’s current set of labels will be replaced with the labels provided in the request…
  • DELETEDelete a Volume/volumes/:idDeletes a volume. All Volume data is irreversibly destroyed. The Volume must not be attached to a Server and it must not have delete protection enabled.

Volume Actions

  • GETGet all Actions for a Volume/volumes/:id/actions?sort=id&status=runningReturns all Action objects for a Volume. You can sort the results by using the sort URI parameter, and filter them with the status parameter.
  • POSTAttach Volume to a Server/volumes/:id/actions/attachAttaches a Volume to a Server. Works only if the Server is in the same Location as the Volume.
  • POSTChange Volume Protection/volumes/:id/actions/change_protectionChanges the protection configuration of a Volume.
  • POSTDetach Volume/volumes/:id/actions/detachDetaches a Volume from the Server it’s attached to. You may attach it to a Server again at a later time.
  • POSTResize Volume/volumes/:id/actions/resizeChanges the size of a Volume. Note that downsizing a Volume is not possible.
  • GETGet an Action for a Volume/volumes/:id/actions/:action_idReturns a specific Action for a Volume.

API details

Base URL
https://api.hetzner.cloud/v1
Authentication
None declared in the description
Operations
144 operations on 112 pathsPOST 69GET 53PUT 11DELETE 11
Main resources
Server Actions 25Load Balancer Actions 15Network Actions 8Floating IP Actions 6Load Balancers 6Servers 6Volume Actions 6Certificates 5Firewall Actions 5Firewalls 5
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Hetzner Cloud API in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Hetzner Cloud API collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “Get all Actions” (GET /actions?id=0&sort=id&status=running), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Hetzner Cloud API?

This is the official API documentation for the Public Hetzner Cloud. Introduction The Hetzner Cloud API operates over HTTPS and uses JSON as its data format.… It is listed under Developer tools and has 144 endpoints.

Who publishes the Hetzner Cloud API?

It is listed from Hetzner's public API description (an OpenAPI document), not published by Hetzner on Swastik Codes. Anyone who controls hetzner.cloud can claim the profile by adding a DNS TXT record.

What is the base URL of the Hetzner Cloud API?

Requests go to https://api.hetzner.cloud/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Hetzner Cloud API?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Hetzner Cloud API have?

144 operations on 112 paths (69 POST, 53 GET, 11 PUT, 11 DELETE). The largest groups are Server Actions, Load Balancer Actions, Network Actions, Floating IP Actions.

Is forking the Hetzner Cloud API free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.