# Hetzner Cloud API ## API Docs - Actions [Get all Actions](https://306b3e51cy.apidog.io/api-3536472.md): Returns all Action objects. You can `sort` the results by using the sort URI parameter, and filter them with the `status` parameter. - Actions [Get an Action](https://306b3e51cy.apidog.io/api-3536466.md): Returns a specific Action object. - Certificates [Get all Certificates](https://306b3e51cy.apidog.io/api-3536480.md): Returns all Certificate objects. - Certificates [Create a Certificate](https://306b3e51cy.apidog.io/api-3536481.md): Creates a new Certificate. - Certificates [Delete a Certificate](https://306b3e51cy.apidog.io/api-3536464.md): Deletes a Certificate. - Certificates [Get a Certificate](https://306b3e51cy.apidog.io/api-3536471.md): Gets a specific Certificate object. - Certificates [Update a Certificate](https://306b3e51cy.apidog.io/api-3536474.md): Updates the Certificate properties. - Certificate Actions [Get all Actions for a Certificate](https://306b3e51cy.apidog.io/api-3536473.md): Returns all Action objects for a Certificate. You can sort the results by using the `sort` URI parameter, and filter them with the `status` parameter. - Certificate Actions [Retry Issuance or Renewal](https://306b3e51cy.apidog.io/api-3536467.md): Retry a failed Certificate issuance or renewal. - Certificate Actions [Get an Action for a Certificate](https://306b3e51cy.apidog.io/api-3536469.md): Returns a specific Action for a Certificate. Only type `managed` Certificates have Actions. - Datacenters [Get all Datacenters](https://306b3e51cy.apidog.io/api-3536470.md): Returns all Datacenter objects. - Datacenters [Get a Datacenter](https://306b3e51cy.apidog.io/api-3536468.md): Returns a specific Datacenter object. - Firewalls [Get all Firewalls](https://306b3e51cy.apidog.io/api-3536482.md): Returns all Firewall objects. - Firewalls [Create a Firewall](https://306b3e51cy.apidog.io/api-3536483.md): Creates a new Firewall. - Firewalls [Delete a Firewall](https://306b3e51cy.apidog.io/api-3536465.md): Deletes a Firewall. - Firewalls [Get a Firewall](https://306b3e51cy.apidog.io/api-3536476.md): Gets a specific Firewall object. - Firewalls [Update a Firewall](https://306b3e51cy.apidog.io/api-3536478.md): Updates the Firewall. - Firewall Actions [Get all Actions for a Firewall](https://306b3e51cy.apidog.io/api-3536475.md): Returns all Action objects for a Firewall. You can sort the results by using the `sort` URI parameter, and filter them with the `status` parameter. - Firewall Actions [Apply to Resources](https://306b3e51cy.apidog.io/api-3536477.md): Applies one Firewall to multiple resources. - Firewall Actions [Remove from Resources](https://306b3e51cy.apidog.io/api-3536479.md): Removes one Firewall from multiple resources. - Firewall Actions [Set Rules](https://306b3e51cy.apidog.io/api-3536484.md): Sets the rules of a Firewall. - Firewall Actions [Get an Action for a Firewall](https://306b3e51cy.apidog.io/api-3536485.md): Returns a specific Action for a Firewall. - Floating IPs [Get all Floating IPs](https://306b3e51cy.apidog.io/api-3536488.md): Returns all Floating IP objects. - Floating IPs [Create a Floating IP](https://306b3e51cy.apidog.io/api-3536487.md): Creates 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 instead of `server`. This can be either the ID or the name of the Location this IP shall be created in. Note that a Floating IP can be assigned to a Server in any Location later on. For optimal routing it is advised to use the Floating IP in the same Location it was created in. - Floating IPs [Delete a Floating IP](https://306b3e51cy.apidog.io/api-3536486.md): Deletes a Floating IP. If it is currently assigned to a Server it will automatically get unassigned. - Floating IPs [Get a Floating IP](https://306b3e51cy.apidog.io/api-3536489.md): Returns a specific Floating IP object. - Floating IPs [Update a Floating IP](https://306b3e51cy.apidog.io/api-3536492.md): Updates the description or labels of a Floating IP. - Floating IP Actions [Get all Actions for a Floating IP](https://306b3e51cy.apidog.io/api-3536490.md): Returns 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. - Floating IP Actions [Assign a Floating IP to a Server](https://306b3e51cy.apidog.io/api-3536491.md): Assigns a Floating IP to a Server. - Floating IP Actions [Change reverse DNS entry for a Floating IP](https://306b3e51cy.apidog.io/api-3536498.md): Changes the hostname that will appear when getting the hostname belonging to this Floating IP. - Floating IP Actions [Change Floating IP Protection](https://306b3e51cy.apidog.io/api-3536496.md): Changes the protection configuration of the Floating IP. - Floating IP Actions [Unassign a Floating IP](https://306b3e51cy.apidog.io/api-3536494.md): Unassigns a Floating IP, resulting in it being unreachable. You may assign it to a Server again at a later time. - Floating IP Actions [Get an Action for a Floating IP](https://306b3e51cy.apidog.io/api-3536495.md): Returns a specific Action object for a Floating IP. - Images [Get all Images](https://306b3e51cy.apidog.io/api-3536497.md): Returns all Image objects. You can select specific Image types only and sort the results by using URI parameters. - Images [Delete an Image](https://306b3e51cy.apidog.io/api-3536493.md): Deletes an Image. Only Images of type `snapshot` and `backup` can be deleted. - Images [Get an Image](https://306b3e51cy.apidog.io/api-3536500.md): Returns a specific Image object. - Images [Update an Image](https://306b3e51cy.apidog.io/api-3536501.md): Updates 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 `backup` can be updated. - Image Actions [Get all Actions for an Image](https://306b3e51cy.apidog.io/api-3536502.md): Returns all Action objects for an Image. You can sort the results by using the `sort` URI parameter, and filter them with the `status` parameter. - Image Actions [Change Image Protection](https://306b3e51cy.apidog.io/api-3536499.md): Changes the protection configuration of the Image. Can only be used on snapshots. - Image Actions [Get an Action for an Image](https://306b3e51cy.apidog.io/api-3536503.md): Returns a specific Action for an Image. - ISOs [Get all ISOs](https://306b3e51cy.apidog.io/api-3536505.md): Returns all available ISO objects. - ISOs [Get an ISO](https://306b3e51cy.apidog.io/api-3536504.md): Returns a specific ISO object. - Load Balancer Types [Get all Load Balancer Types](https://306b3e51cy.apidog.io/api-3536506.md): Gets all Load Balancer type objects. - Load Balancer Types [Get a Load Balancer Type](https://306b3e51cy.apidog.io/api-3536508.md): Gets a specific Load Balancer type object. - Load Balancers [Get all Load Balancers](https://306b3e51cy.apidog.io/api-3536507.md): Gets all existing Load Balancers that you have available. - Load Balancers [Create a Load Balancer](https://306b3e51cy.apidog.io/api-3536509.md): Creates a Load Balancer. - Load Balancers [Delete a Load Balancer](https://306b3e51cy.apidog.io/api-3536511.md): Deletes a Load Balancer. - Load Balancers [Get a Load Balancer](https://306b3e51cy.apidog.io/api-3536510.md): Gets a specific Load Balancer object. - Load Balancers [Update a Load Balancer](https://306b3e51cy.apidog.io/api-3536512.md): Updates a Load Balancer. You can update a Load Balancer’s name and a Load Balancer’s labels. - Load Balancers [Get Metrics for a LoadBalancer](https://306b3e51cy.apidog.io/api-3536513.md): You 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 type by comma separation, e.g. `requests_per_second,bandwidth`. - Load Balancer Actions [Get all Actions for a Load Balancer](https://306b3e51cy.apidog.io/api-3536514.md): Returns 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. - Load Balancer Actions [Add Service](https://306b3e51cy.apidog.io/api-3536515.md): Adds a service to a Load Balancer. - Load Balancer Actions [Add Target](https://306b3e51cy.apidog.io/api-3536516.md): Adds a target to a Load Balancer. - Load Balancer Actions [Attach a Load Balancer to a Network](https://306b3e51cy.apidog.io/api-3536518.md): Attach a Load Balancer to a Network. - Load Balancer Actions [Change Algorithm](https://306b3e51cy.apidog.io/api-3536517.md): Change the algorithm that determines to which target new requests are sent. - Load Balancer Actions [Change reverse DNS entry for this Load Balancer](https://306b3e51cy.apidog.io/api-3536519.md): Changes the hostname that will appear when getting the hostname belonging to the public IPs (IPv4 and IPv6) of this Load Balancer. - Load Balancer Actions [Change Load Balancer Protection](https://306b3e51cy.apidog.io/api-3536520.md): Changes the protection configuration of a Load Balancer. - Load Balancer Actions [Change the Type of a Load Balancer](https://306b3e51cy.apidog.io/api-3536522.md): Changes the type (Max Services, Max Targets and Max Connections) of a Load Balancer. - Load Balancer Actions [Delete Service](https://306b3e51cy.apidog.io/api-3536521.md): Delete a service of a Load Balancer. - Load Balancer Actions [Detach a Load Balancer from a Network](https://306b3e51cy.apidog.io/api-3536525.md): Detaches a Load Balancer from a network. - Load Balancer Actions [Disable the public interface of a Load Balancer](https://306b3e51cy.apidog.io/api-3536523.md): Disable the public interface of a Load Balancer. The Load Balancer will be not accessible from the internet via its public IPs. - Load Balancer Actions [Enable the public interface of a Load Balancer](https://306b3e51cy.apidog.io/api-3536524.md): Enable the public interface of a Load Balancer. The Load Balancer will be accessible from the internet via its public IPs. - Load Balancer Actions [Remove Target](https://306b3e51cy.apidog.io/api-3536526.md): Removes a target from a Load Balancer. - Load Balancer Actions [Update Service](https://306b3e51cy.apidog.io/api-3536527.md): Updates a Load Balancer Service. - Load Balancer Actions [Get an Action for a Load Balancer](https://306b3e51cy.apidog.io/api-3536528.md): Returns a specific Action for a Load Balancer. - Locations [Get all Locations](https://306b3e51cy.apidog.io/api-3536529.md): Returns all Location objects. - Locations [Get a Location](https://306b3e51cy.apidog.io/api-3536530.md): Returns a specific Location object. - Networks [Get all Networks](https://306b3e51cy.apidog.io/api-3536531.md): Gets all existing networks that you have available. - Networks [Create a Network](https://306b3e51cy.apidog.io/api-3536532.md): Creates a network with the specified `ip_range`. - Networks [Delete a Network](https://306b3e51cy.apidog.io/api-3536533.md): Deletes a network. If there are Servers attached they will be detached in the background. - Networks [Get a Network](https://306b3e51cy.apidog.io/api-3536534.md): Gets a specific network object. - Networks [Update a Network](https://306b3e51cy.apidog.io/api-3536537.md): Updates the network properties. - Network Actions [Get all Actions for a Network](https://306b3e51cy.apidog.io/api-3536536.md): Returns all Action objects for a Network. You can sort the results by using the `sort` URI parameter, and filter them with the `status` parameter. - Network Actions [Add a route to a Network](https://306b3e51cy.apidog.io/api-3536535.md): Adds a route entry to a Network. - Network Actions [Add a subnet to a Network](https://306b3e51cy.apidog.io/api-3536538.md): Adds 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 possible. - Network Actions [Change IP range of a Network](https://306b3e51cy.apidog.io/api-3536539.md): Changes 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 the IP part of your existing range must stay the same and you can only change its netmask. - Network Actions [Change Network Protection](https://306b3e51cy.apidog.io/api-3536540.md): Changes the protection configuration of a Network. - Network Actions [Delete a route from a Network](https://306b3e51cy.apidog.io/api-3536545.md): Delete a route entry from a Network. - Network Actions [Delete a subnet from a Network](https://306b3e51cy.apidog.io/api-3536544.md): Deletes 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 detach all Servers that use IPs from this subnet before you can delete the subnet. - Network Actions [Get an Action for a Network](https://306b3e51cy.apidog.io/api-3536543.md): Returns a specific Action for a Network. - Placement Groups [Get all PlacementGroups](https://306b3e51cy.apidog.io/api-3536546.md): Returns all PlacementGroup objects. - Placement Groups [Create a PlacementGroup](https://306b3e51cy.apidog.io/api-3536547.md): Creates a new PlacementGroup. - Placement Groups [Delete a PlacementGroup](https://306b3e51cy.apidog.io/api-3536541.md): Deletes a PlacementGroup. - Placement Groups [Get a PlacementGroup](https://306b3e51cy.apidog.io/api-3536548.md): Gets a specific PlacementGroup object. - Placement Groups [Update a PlacementGroup](https://306b3e51cy.apidog.io/api-3536542.md): Updates the PlacementGroup properties. - Pricing [Get all prices](https://306b3e51cy.apidog.io/api-3536551.md): Returns prices for all resources available on the platform. VAT and currency of the Project owner are used for calculations. - Server Types [Get all Server Types](https://306b3e51cy.apidog.io/api-3536550.md): Gets all Server type objects. - Server Types [Get a Server Type](https://306b3e51cy.apidog.io/api-3536549.md): Gets a specific Server type object. - Servers [Get all Servers](https://306b3e51cy.apidog.io/api-3536552.md): Returns all existing Server objects - Servers [Create a Server](https://306b3e51cy.apidog.io/api-3536553.md): Creates a new Server. Returns preliminary information about the Server as well as an Action that covers progress of creation. - Servers [Delete a Server](https://306b3e51cy.apidog.io/api-3536554.md): Deletes a Server. This immediately removes the Server from your account, and it is no longer accessible. - Servers [Get a Server](https://306b3e51cy.apidog.io/api-3536558.md): Returns a specific Server object. The Server must exist inside the Project - Servers [Update a Server](https://306b3e51cy.apidog.io/api-3536557.md): Updates a Server. You can update a Server’s name and a Server’s labels. - Servers [Get Metrics for a Server](https://306b3e51cy.apidog.io/api-3536556.md): Get Metrics for specified Server. - Server Actions [Get all Actions for a Server](https://306b3e51cy.apidog.io/api-3536555.md): Returns all Action objects for a Server. You can `sort` the results by using the sort URI parameter, and filter them with the `status` parameter. - Server Actions [Add a Server to a Placement Group](https://306b3e51cy.apidog.io/api-3536559.md): Adds a Server to a Placement Group. - Server Actions [Attach an ISO to a Server](https://306b3e51cy.apidog.io/api-3536560.md): Attaches 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 attached. - Server Actions [Attach a Server to a Network](https://306b3e51cy.apidog.io/api-3536561.md): Attaches a Server to a network. This will complement the fixed public Server interface by adding an additional ethernet interface to the Server which is connected to the specified network. - Server Actions [Change alias IPs of a Network](https://306b3e51cy.apidog.io/api-3536564.md): Changes 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 request body. So if you want to add an alias IP, you have to provide the existing ones from the Network plus the new alias IP in the request body. - Server Actions [Change reverse DNS entry for this Server](https://306b3e51cy.apidog.io/api-3536562.md): Changes the hostname that will appear when getting the hostname belonging to the primary IPs (IPv4 and IPv6) of this Server. - Server Actions [Change Server Protection](https://306b3e51cy.apidog.io/api-3536565.md): Changes the protection configuration of the Server. - Server Actions [Change the Type of a Server](https://306b3e51cy.apidog.io/api-3536563.md): Changes the type (Cores, RAM and disk sizes) of a Server. - Server Actions [Create Image from a Server](https://306b3e51cy.apidog.io/api-3536567.md): Creates 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 Image. If the Server is currently running you must make sure that its disk content is consistent. Otherwise, the created Image may not be readable. - Server Actions [Detach a Server from a Network](https://306b3e51cy.apidog.io/api-3536566.md): Detaches a Server from a network. The interface for this network will vanish. - Server Actions [Detach an ISO from a Server](https://306b3e51cy.apidog.io/api-3536568.md): Detaches 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` - Server Actions [Disable Backups for a Server](https://306b3e51cy.apidog.io/api-3536569.md): Disables the automatic backup option and deletes all existing Backups for a Server. No more additional charges for backups will be made. - Server Actions [Disable Rescue Mode for a Server](https://306b3e51cy.apidog.io/api-3536571.md): Disables the Hetzner Rescue System for a Server. This makes a Server start from its disks on next reboot. - Server Actions [Enable and Configure Backups for a Server](https://306b3e51cy.apidog.io/api-3536570.md): Enables and configures the automatic daily backup option for the Server. Enabling automatic backups will increase the price of the Server by 20%. In return, you will get seven slots where Images of type backup can be stored. - Server Actions [Enable Rescue Mode for a Server](https://306b3e51cy.apidog.io/api-3536572.md): Enable 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 designed for repair and reinstall. - Server Actions [Power off a Server](https://306b3e51cy.apidog.io/api-3536573.md): Cuts 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 pulling the power cord. Power off should only be used when shutdown does not work. - Server Actions [Power on a Server](https://306b3e51cy.apidog.io/api-3536574.md): Starts a Server by turning its power on. - Server Actions [Soft-reboot a Server](https://306b3e51cy.apidog.io/api-3536576.md): Reboots 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 reboot. - Server Actions [Rebuild a Server from an Image](https://306b3e51cy.apidog.io/api-3536577.md): Rebuilds a Server overwriting its disk with the content of an Image, thereby **destroying all data** on the target Server - Server Actions [Remove from Placement Group](https://306b3e51cy.apidog.io/api-3536575.md): Removes a Server from a Placement Group. - Server Actions [Request Console for a Server](https://306b3e51cy.apidog.io/api-3536578.md): Requests 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 period a new url needs to be created to connect to the Server. How long the connection is open after the initial connect is not subject to this timeout. - Server Actions [Reset a Server](https://306b3e51cy.apidog.io/api-3536579.md): Cuts 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 loss, it’s equivalent to pulling the power cord and plugging it in again. Reset should only be used when reboot does not work. - Server Actions [Reset root Password of a Server](https://306b3e51cy.apidog.io/api-3536580.md): Resets 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 operation to succeed. - Server Actions [Shutdown a Server](https://306b3e51cy.apidog.io/api-3536581.md): Shuts down a Server gracefully by sending an ACPI shutdown request. The Server operating system must support ACPI and react to the request, otherwise the Server will not shut down. - Server Actions [Get an Action for a Server](https://306b3e51cy.apidog.io/api-3536587.md): Returns a specific Action object for a Server. - SSH Keys [Get all SSH keys](https://306b3e51cy.apidog.io/api-3536586.md): Returns all SSH key objects. - SSH Keys [Create an SSH key](https://306b3e51cy.apidog.io/api-3536584.md): Creates 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. - SSH Keys [Delete an SSH key](https://306b3e51cy.apidog.io/api-3536582.md): Deletes an SSH key. It cannot be used anymore. - SSH Keys [Get a SSH key](https://306b3e51cy.apidog.io/api-3536583.md): Returns a specific SSH key object. - SSH Keys [Update an SSH key](https://306b3e51cy.apidog.io/api-3536585.md): Updates an SSH key. You can update an SSH key name and an SSH key labels. - Volumes [Get all Volumes](https://306b3e51cy.apidog.io/api-3536588.md): Gets all existing Volumes that you have available. - Volumes [Create a Volume](https://306b3e51cy.apidog.io/api-3536592.md): Creates 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 `server`. This can be either the ID or the name of the Location this Volume will be created in. Note that a Volume can be attached to a Server only in the same Location as the Volume itself. - Volumes [Delete a Volume](https://306b3e51cy.apidog.io/api-3536589.md): Deletes 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. - Volumes [Get a Volume](https://306b3e51cy.apidog.io/api-3536590.md): Gets a specific Volume object. - Volumes [Update a Volume](https://306b3e51cy.apidog.io/api-3536591.md): Updates the Volume properties. - Volume Actions [Get all Actions for a Volume](https://306b3e51cy.apidog.io/api-3536593.md): Returns all Action objects for a Volume. You can `sort` the results by using the sort URI parameter, and filter them with the `status` parameter. - Volume Actions [Attach Volume to a Server](https://306b3e51cy.apidog.io/api-3536594.md): Attaches a Volume to a Server. Works only if the Server is in the same Location as the Volume. - Volume Actions [Change Volume Protection](https://306b3e51cy.apidog.io/api-3536596.md): Changes the protection configuration of a Volume. - Volume Actions [Detach Volume](https://306b3e51cy.apidog.io/api-3536595.md): Detaches a Volume from the Server it’s attached to. You may attach it to a Server again at a later time. - Volume Actions [Resize Volume](https://306b3e51cy.apidog.io/api-3536597.md): Changes the size of a Volume. Note that downsizing a Volume is not possible. - Volume Actions [Get an Action for a Volume](https://306b3e51cy.apidog.io/api-3536598.md): Returns a specific Action for a Volume. - Primary IPs [Get all Primary IPs](https://306b3e51cy.apidog.io/api-4082499.md): Returns all Primary IP objects. - Primary IPs [Create a Primary IP](https://306b3e51cy.apidog.io/api-4082500.md): Creates a new Primary IP, optionally assigned to a Server. - Primary IPs [Delete a Primary IP](https://306b3e51cy.apidog.io/api-4082501.md): Deletes a Primary IP. - Primary IPs [Get a Primary IP](https://306b3e51cy.apidog.io/api-4082502.md): Returns a specific Primary IP object. - Primary IPs [Update a Primary IP](https://306b3e51cy.apidog.io/api-4082503.md): Updates the Primary IP. - Primary IP Actions [Assign a Primary IP to a resource](https://306b3e51cy.apidog.io/api-4082504.md): Assigns a Primary IP to a Server. - Primary IP Actions [Change reverse DNS entry for a Primary IP](https://306b3e51cy.apidog.io/api-4082505.md): Changes the hostname that will appear when getting the hostname belonging to this Primary IP. - Primary IP Actions [Change Primary IP Protection](https://306b3e51cy.apidog.io/api-4082506.md): Changes the protection configuration of a Primary IP. - Primary IP Actions [Unassign a Primary IP from a resource](https://306b3e51cy.apidog.io/api-4082507.md): Unassigns a Primary IP from a Server.