Hetzner Cloud Provider

https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs
Admin
The Hetzner Cloud (hcloud) provider is used to interact with and manage resources supported by...
Tokens:1,243
Snippets:9
Trust Score:10
Update:11 months ago
Show doc for...
Tokens:
Raw
### Experimental Feature Documentation Placeholder

Source: https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs/index

This is a placeholder indicating how experimental features are documented. It shows a template string that would be dynamically updated to reflect the product, maturity level, and a link to changelog details for experimental features.

```text
Experimental: $PRODUCT is $MATURITY, breaking changes may occur within minor releases. See https://docs.hetzner.cloud/changelog#$SLUG for more details.
```

--------------------------------

### Hetzner Cloud Provider Arguments

Source: https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs/index

Details on the supported arguments for configuring the Hetzner Cloud provider.

```APIDOC
## Argument Reference

The following arguments are supported:

*   **token** (Required, string) - This is the Hetzner Cloud API Token, can also be specified with the `HCLOUD_TOKEN` environment variable.
*   **endpoint** (Optional, string) - Hetzner Cloud API endpoint, can be used to override the default API Endpoint `https://api.hetzner.cloud/v1`.
*   **poll_interval** (Optional, string) - Configures the interval in which actions are polled by the client. Default `500ms`. Increase this interval if you run into rate limiting errors.
*   **poll_function** (Optional, string) - Configures the type of function to be used during the polling. Valid values are `constant` and `exponential`. Default `exponential`.
```

--------------------------------

### Hetzner Cloud Experimental Features

Source: https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs/index

Information regarding experimental features in the Hetzner Cloud provider.

```APIDOC
## Experimental features

Experimental features are published as part of our regular releases (e.g. a product public beta). During an experimental phase, breaking changes on those features may occur within minor releases.
The stability of experimental features is not related to the stability of its upstream API.
Experimental features have different levels of maturity (e.g. experimental, alpha, beta) based on the maturity of the upstream API.
While experimental features will be announced in the release notes, you can also find whether a resource, datasource or function is experimental in its documentation:

```
Experimental: $PRODUCT is $MATURITY, breaking changes may occur within minor releases. See https://docs.hetzner.cloud/changelog#$SLUG for more details.
```
```

--------------------------------

### Hetzner Cloud Delete Protection

Source: https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs/index

Explanation of how delete protection works with the Hetzner Cloud provider and Terraform.

```APIDOC
## Delete Protection

The Hetzner Cloud API allows to protect resources from deletion by putting a "lock" on them. This can also be configured through Terraform through the `delete_protection` argument on resources that support it.

Please note, that this does not protect deletion from Terraform itself, as the Provider will lift the lock in that case. If you also want to protect your resources from deletion by Terraform, you can use the `prevent_destroy` lifecycle attribute.
```

--------------------------------

### Hetzner Cloud Provider Configuration

Source: https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs/index

Configuration details for the Hetzner Cloud provider, including authentication and API endpoint settings.

```APIDOC
## Provider: hcloud

### Description
The Hetzner Cloud (hcloud) provider is used to interact with the resources supported by Hetzner Cloud. The provider needs to be configured with the proper credentials before it can be used.

### Method
Not applicable (Configuration block)

### Endpoint
Not applicable (Configuration block)

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```terraform
terraform {
  required_providers {
    hcloud = {
      source  = "hetznercloud/hcloud"
      version = "~> 1.45"
    }
  }
}

variable "hcloud_token" {
  sensitive = true
}

provider "hcloud" {
  token = var.hcloud_token
  endpoint = "https://api.hetzner.cloud/v1"
  poll_interval = "500ms"
  poll_function = "exponential"
}
```

### Response
#### Success Response (200)
None (This is a configuration block)

#### Response Example
None
```

--------------------------------

### Configure Hetzner Cloud Terraform Provider

Source: https://registry.terraform.io/providers/hetznercloud/hcloud/latest/docs/index

This snippet shows how to configure the Hetzner Cloud provider in Terraform. It specifies the provider source and version, defines the API token as a sensitive variable, and configures the provider with the token. The token can be provided via a .tfvars file or CLI option.

```terraform
terraform {
  required_providers {
    hcloud = {
      source  = "hetznercloud/hcloud"
      version = "~> 1.45"
    }
  }
}


variable "hcloud_token" {
  sensitive = true
}

provider "hcloud" {
  token = var.hcloud_token
}
```
Tokens:
Raw