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. 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: Our CLI program [hcloud](https://github.com/hetznercloud/cli) Our [library for Go](https://github.com/hetznercloud/hcloud-go) Our [library for Python](https://github.com/hetznercloud/hcloud-python) Also you can find a [list of libraries, tools, and integrations on GitHub](https://github.com/hetznercloud/awesome-hcloud). 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](https://console.hetzner.cloud/) 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](https://curl.haxx.se/). 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](https://docs.hetzner.cloud/ overview-pagination). Example Request bash curl -H "Authorization: Bearer jEheVytlAoFl7F8MqUQ7jAo2hOXASztX" \ https://api.hetzner.cloud/v1/servers Example Response json { "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](https://console.hetzner.cloud/) choose a Project, go to Security → API Tokens , and generate a new token. Example Authorization header html 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: Keys Meaning ----------- ----------------------------------------------------------------------- code Short string indicating the type of error (machine-parsable) message Textual description on what has gone wrong details An object providing for details on the error (schema depends on code) Example response json { "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 Code Description --------------------------- ---------------------------------------------------------------------------------- forbidden Insufficient permission…