github.com/rvichery/terraform@v0.11.10/website/docs/backends/types/terraform-enterprise.html.md (about) 1 --- 2 layout: "backend-types" 3 page_title: "Backend Type: terraform enterprise" 4 sidebar_current: "docs-backends-types-standard-terraform-enterprise" 5 description: |- 6 Terraform can store the state in Terraform Enterprise 7 --- 8 9 # terraform enterprise 10 11 **Kind: Standard (with no locking)** 12 13 Reads and writes state from a [Terraform Enterprise](/docs/enterprise/index.html) 14 workspace. 15 16 -> **Why is this called "atlas"?** Before it was a standalone offering, 17 Terraform Enterprise was part of an integrated suite of enterprise products 18 called Atlas. This backend predates the current version Terraform Enterprise, so 19 it uses the old name. 20 21 This backend is useful for uncommon tasks like migrating state into a Terraform 22 Enterprise workspace, but we no longer recommend using it as part of your 23 day-to-day Terraform workflow. Since it performs runs outside of Terraform 24 Enterprise and updates state directly, it does not support Terraform 25 Enterprise's collaborative features like [workspace 26 locking](/docs/enterprise/run/index.html). To perform Terraform Enterprise runs 27 from the command line, use [Terraform Enterprise's CLI-driven 28 workflow](/docs/enterprise/run/cli.html) instead. 29 30 ## Example Configuration 31 32 ```hcl 33 terraform { 34 backend "atlas" { 35 name = "example_corp/networking-prod" 36 address = "https://app.terraform.io" # optional 37 } 38 } 39 ``` 40 41 We recommend using a [partial configuration](/docs/backends/config.html) and 42 omitting the access token, which can be provided as an environment variable. 43 44 ## Example Referencing 45 46 ```hcl 47 data "terraform_remote_state" "foo" { 48 backend = "atlas" 49 config { 50 name = "example_corp/networking-prod" 51 } 52 } 53 ``` 54 55 ## Configuration variables 56 57 The following configuration options / environment variables are supported: 58 59 * `name` - (Required) Full name of the workspace (`<ORGANIZATION>/<WORKSPACE>`). 60 * `ATLAS_TOKEN`/ `access_token` - (Required) A Terraform Enterprise [user API 61 token](/docs/enterprise/users-teams-organizations/users.html#api-tokens). We 62 recommend using the `ATLAS_TOKEN` environment variable rather than setting 63 `access_token` in the configuration. 64 * `address` - (Optional) The URL of a Terraform Enterprise instance. Defaults to 65 the SaaS version of Terraform Enterprise, at `"https://app.terraform.io"`; if 66 you use a private install, provide its URL here.