cloudflare

cloudflare/terraform-provider-cloudflare

Cloudflare Terraform Provider

View on GitHub Website / Demo Back to listing

1.4kstars 903forks 97contributors Go

README.md

# Cloudflare Terraform Provider

The [Cloudflare Terraform provider](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs) provides convenient access to
the [Cloudflare REST API](https://developers.cloudflare.com/api) from Terraform.

## Requirements

This provider requires Terraform CLI 1.0 or later. You can [install it for your system](https://developer.hashicorp.com/terraform/install)
on Hashicorp's website.

## Usage

Add the following to your `main.tf` file:

```hcl
# Declare the provider and version
terraform {
  required_providers {
    cloudflare = {
      source  = "cloudflare/cloudflare"
      version = "~> 5.29.0"
    }
  }
}

# Initialize the provider
provider "cloudflare" {
  # The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/).
  api_token = "Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY" # or set CLOUDFLARE_API_TOKEN env variable
  # The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.
  api_key = "144c9defac04969c7bfad8efaa8ea194" # or set CLOUDFLARE_API_KEY env variable
  # The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.
  api_email = "user@example.com" # or set CLOUDFLARE_EMAIL env variable
  # Used when interacting with the Origin CA certificates API. [View/change your key](https://developers.cloudflare.com/fundamentals/api/get-started/ca-keys/#viewchange-your-origin-ca-keys).
  user_service_key = "v1.0-144c9defac04969c7bfad8ef-631a41d003a32d25fe878081ef365c49503f7fada600da935e2851a1c7326084b85cbf6429c4b859de8475731dc92a9c329631e6d59e6c73da7b198497172b4cefe071d90d0f5d2719" # or set CLOUDFLARE_API_USER_SERVICE_KEY env variable
  # Sets an account ID to be used with all account-scoped requests.
  account_id = "f037e56e89293a057740de681ac9accp" # or set CLOUDFLARE_ACCOUNT_ID env variable
  # Sets a zone ID to be used with all zone-scoped requests.
  zone_id = "f037e56e89293a057740de681ac9accp" # or set CLOUDFLARE_ZONE_ID env variable
}

# Configure a resource
resource "cloudflare_zone" "example_zone" {
  account = {
    id = "023e105f4ecef8ad9ca31a8372d0c353"
  }
  name = "example.com"
  type = "full"
}
```

Initialize your project by running `terraform init` in the directory.

Additional examples can be found in the [./examples](./examples) folder within this repository, and you can
refer to the full documentation on [the Terraform Registry](https://registry.terraform.io/providers/cloudflare/cloudflare/latest/docs).

### Provider Options

When you initialize the provider, the following options are supported. It is recommended to use environment variables for sensitive values like access tokens.
If an environment variable is provided, then the option does not need to be set in the terraform source.

| Property         | Environment variable              | Required | Default value |
| ---------------- | --------------------------------- | -------- | ------------- |
| zone_id          | `CLOUDFLARE_ZONE_ID`              | false    | —             |
| user_service_key | `CLOUDFLARE_API_USER_SERVICE_KEY` | false    | —             |
| api_token        | `CLOUDFLARE_API_TOKEN`            | false    | —             |
| api_key          | `CLOUDFLARE_API_KEY`              | false    | —             |
| api_email        | `CLOUDFLARE_EMAIL`                | false    | —             |
| account_id       | `CLOUDFLARE_ACCOUNT_ID`           | false    | —             |

## Semantic versioning

This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions, though certain backwards-incompatible changes may be released as minor versions:

1. Changes to library internals which are technically public but not intended or documented for external use. _(Please open a GitHub issue to let us know if you are relying on such internals.)_
2. Changes that we do not expect to impact the vast majority of users in practice.

We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.

We are keen for your feedback; please open an [issue](https://www.github.com/cloudflare/terraform-provider-cloudflare/issues) with questions, bugs, or suggestions.

## Maintenance

This SDK is actively maintained, however, it is **auto-generated** and maintained internally at Cloudflare, so **we are no longer accepting pull requests from the community.** Many issues are tracked outside of GitHub on internal Cloudflare systems. Please open an [issue](https://www.github.com/cloudflare/terraform-provider-cloudflare/issues) rather than a pull request. For urgent issues, please contact [Cloudflare support](https://developers.cloudflare.com/support/contacting-cloudflare-support/).

## Contributing

This repository is auto-generated, and **we are no longer accepting pull requests.** If you have a bug or feature request, please open an [issue](https://www.github.com/cloudflare/terraform-provider-cloudflare/issues).

That said, if you have a fix that is known to work, a pull request can still be helpful as a reference implementation for the team, even though it will not be merged directly. Please open an issue alongside it so we can track the change.

See [the contributing documentation](./CONTRIBUTING.md) for more details.

Repository info

Default branch: main
Latest version: v5.29.0
Created: 06/06/2017
Last activity: 12/11/2026
License: Apache-2.0
Open issues: 149
Watchers: 51

Topics

cloudflare terraform terraform-provider

Contributors

stainless-app[bot]

2.6k contributions

stainless-bot

1.7k contributions

vaishakdinesh

724 contributions

jacobbednarz

477 contributions

musa-cf

356 contributions