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
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://api.hetzner.cloud/v1
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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/h
| method | path | what the vendor says it does |
|---|---|---|
GET | /actions | Get all Actions Returns all Action objects. You can `sort` the results by using the sort URI parameter, and fi |
GET | /actions/{id} | Get an Action Returns a specific Action object. Actions |
GET | /certificates | Get all Certificates Returns all Certificate objects. Certificates |
POST | /certificates | Create a Certificate Creates a new Certificate. The default type **uploaded** allows for uploading your exist |
GET | /certificates/{id} | Get a Certificate Gets a specific Certificate object. Certificates |
PUT | /certificates/{id} | Update a Certificate Updates the Certificate properties. Note that when updating labels, the Certificate’s cu |
DELETE | /certificates/{id} | Delete a Certificate Deletes a Certificate. Certificates |
GET | /certificates/{id}/actions | Get all Actions for a Certificate Returns all Action objects for a Certificate. You can sort the results by us |
POST | /certificates/{id}/actions/retry | Retry Issuance or Renewal Retry a failed Certificate issuance or renewal. Only applicable if the type of the |
GET | /certificates/{id}/actions/{action_id} | Get an Action for a Certificate Returns a specific Action for a Certificate. Only type `managed` Certificates |
GET | /datacenters | Get all Datacenters Returns all Datacenter objects. Datacenters |
GET | /datacenters/{id} | Get a Datacenter Returns a specific Datacenter object. Datacenters |
GET | /firewalls | Get all Firewalls Returns all Firewall objects. Firewalls |
POST | /firewalls | Create a Firewall Creates a new Firewall. #### Call specific error codes | Code | D |
GET | /firewalls/{id} | Get a Firewall Gets a specific Firewall object. Firewalls |
PUT | /firewalls/{id} | Update a Firewall Updates the Firewall. Note that when updating labels, the Firewall's current set of labels |
DELETE | /firewalls/{id} | Delete a Firewall Deletes a Firewall. #### Call specific error codes | Code | Description |
GET | /firewalls/{id}/actions | Get all Actions for a Firewall Returns all Action objects for a Firewall. You can sort the results by using th |
POST | /firewalls/{id}/actions/apply_to_resources | Apply to Resources Applies one Firewall to multiple resources. Currently servers (public network interface) a |
POST | /firewalls/{id}/actions/remove_from_resources | Remove from Resources Removes one Firewall from multiple resources. Currently only Servers (and their public |
POST | /firewalls/{id}/actions/set_rules | Set Rules Sets the rules of a Firewall. All existing rules will be overwritten. Pass an empty `rules` array t |
GET | /firewalls/{id}/actions/{action_id} | Get an Action for a Firewall Returns a specific Action for a Firewall. Firewall Actions |
GET | /floating_ips | Get all Floating IPs Returns all Floating IP objects. Floating IPs |
POST | /floating_ips | Create a Floating IP Creates a new Floating IP assigned to a Server. If you want to create a Floating IP that |
GET | /floating_ips/{id} | Get a Floating IP Returns a specific Floating IP object. Floating IPs |
PUT | /floating_ips/{id} | Update a Floating IP Updates the description or labels of a Floating IP. Also note that when updating labels, |
DELETE | /floating_ips/{id} | Delete a Floating IP Deletes a Floating IP. If it is currently assigned to a Server it will automatically get |
GET | /floating_ips/{id}/actions | Get all Actions for a Floating IP Returns all Action objects for a Floating IP. You can sort the results by us |
POST | /floating_ips/{id}/actions/assign | Assign a Floating IP to a Server Assigns a Floating IP to a Server. Floating IP Actions |
POST | /floating_ips/{id}/actions/change_dns_ptr | Change reverse DNS entry for a Floating IP Changes the hostname that will appear when getting the hostname bel |
POST | /floating_ips/{id}/actions/change_protection | Change Floating IP Protection Changes the protection configuration of the Floating IP. Floating IP Actions |
POST | /floating_ips/{id}/actions/unassign | Unassign a Floating IP Unassigns a Floating IP, resulting in it being unreachable. You may assign it to a Serv |
GET | /floating_ips/{id}/actions/{action_id} | Get an Action for a Floating IP Returns a specific Action object for a Floating IP. Floating IP Actions |
GET | /images | Get all Images Returns all Image objects. You can select specific Image types only and sort the results by usi |
GET | /images/{id} | Get an Image Returns a specific Image object. Images |
PUT | /images/{id} | Update an Image Updates the Image. You may change the description, convert a Backup Image to a Snapshot Image |
DELETE | /images/{id} | Delete an Image Deletes an Image. Only Images of type `snapshot` and `backup` can be deleted. Images |
GET | /images/{id}/actions | Get all Actions for an Image Returns all Action objects for an Image. You can sort the results by using the `s |
POST | /images/{id}/actions/change_protection | Change Image Protection Changes the protection configuration of the Image. Can only be used on snapshots. Imag |
GET | /images/{id}/actions/{action_id} | Get an Action for an Image Returns a specific Action for an Image. Image Actions |
and 104 more operation(s) in this specification, all searchable.
specification origin: https://docs.hetzner.cloud/spec.json
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.