• Overview
    • Enforce Policy as Code
    • Infrastructure as Code
    • Inject Secrets into Terraform
    • Integrate with Existing Workflows
    • Manage Kubernetes
    • Manage Virtual Machine Images
    • Multi-Cloud Deployment
    • Network Infrastructure Automation
    • Terraform CLI
    • Terraform Cloud
    • Terraform Enterprise
  • Registry
  • Tutorials
    • About the Docs
    • Intro to Terraform
    • Configuration Language
    • Terraform CLI
    • Terraform Cloud
    • Terraform Enterprise
    • Provider Use
    • Plugin Development
    • Registry Publishing
    • Integration Program
    • Terraform Tools
    • CDK for Terraform
    • Glossary
  • Community
GitHubTerraform Cloud
Download

    Terraform Cloud and Enterprise

  • Overview
  • Plans and Features
  • Getting Started
    • API Docs template
    • Overview
    • Account
    • Agent Pools
    • Agent Tokens
    • Applies
    • Audit Trails
    • Comments
    • Configuration Versions
    • Cost Estimates
    • Feature Sets
    • Invoices
    • IP Ranges
    • Notification Configurations
    • OAuth Clients
    • OAuth Tokens
    • Organizations
    • Organization Memberships
    • Organization Tags
    • Organization Tokens
    • Plan Exports
    • Plans
    • Policies
    • Policy Checks
    • Policy Sets
    • Policy Set Parameters
      • Modules
      • Providers
      • Private Provider Versions and Platforms
      • GPG Keys
    • Runs
      • Run Tasks
      • Stages and Results
      • Custom Integration
    • Run Triggers
    • SSH Keys
    • State Versions
    • State Version Outputs
    • Subscriptions
    • Team Access
    • Team Membership
    • Team Tokens
    • Teams
    • User Tokens
    • Users
    • Variables
    • VCS Events
    • Workspaces
    • Workspace-Specific Variables
    • Workspace Resources
    • Variable Sets
      • Overview
      • Module Sharing
      • Organizations
      • Runs
      • Settings
      • Terraform Versions
      • Users
      • Workspaces
    • Changelog
    • Stability Policy
    • Overview
    • Creating Workspaces
    • Naming
    • Terraform Configurations
      • Overview
      • Managing Variables
      • Overview
      • VCS Connections
      • Access
      • Drift Detection
      • Notifications
      • SSH Keys for Modules
      • Run Triggers
      • Run Tasks
    • Terraform State
    • JSON Filtering
    • Remote Operations
    • Viewing and Managing Runs
    • Run States and Stages
    • Run Modes and Options
    • UI/VCS-driven Runs
    • API-driven Runs
    • CLI-driven Runs
    • The Run Environment
    • Installing Software
    • Users
    • Teams
    • Organizations
    • Permissions
    • Two-factor Authentication
    • API Tokens
      • Overview
      • Microsoft Azure AD
      • Okta
      • SAML
      • Linking a User Account
      • Testing
    • Overview
    • GitHub.com
    • GitHub.com (OAuth)
    • GitHub Enterprise
    • GitLab.com
    • GitLab EE and CE
    • Bitbucket Cloud
    • Bitbucket Server and Data Center
    • Azure DevOps Services
    • Azure DevOps Server
    • Troubleshooting
    • Overview
    • Adding Public Providers and Modules
    • Publishing Private Providers
    • Publishing Private Modules
    • Using Providers and Modules
    • Configuration Designer
  • Migrating to Terraform Cloud
    • Overview
    • Using Sentinel with Terraform 0.12
    • Manage Policies
    • Enforce and Override Policies
    • Mocking Terraform Sentinel Data
    • Working With JSON Result Data
      • Overview
      • tfconfig
      • tfconfig/v2
      • tfplan
      • tfplan/v2
      • tfstate
      • tfstate/v2
      • tfrun
    • Example Policies
    • Overview
    • AWS
    • GCP
    • Azure
      • Overview
      • Service Catalog
      • Admin Guide
      • Developer Reference
      • Example Customizations
      • V1 Setup Instructions
    • Splunk Integration
    • Kubernetes Integration
    • Run Tasks Integration
    • Overview
    • IP Ranges
    • Data Security
    • Security Model
    • Overview
    • Part 1: Overview of Our Recommended Workflow
    • Part 2: Evaluating Your Current Provisioning Practices
    • Part 3: How to Evolve Your Provisioning Practices
    • Part 3.1: From Manual Changes to Semi-Automation
    • Part 3.2: From Semi-Automation to Infrastructure as Code
    • Part 3.3: From Infrastructure as Code to Collaborative Infrastructure as Code
    • Part 3.4: Advanced Workflow Improvements

  • Terraform Cloud Agents

  • Terraform Enterprise Admin

  • Other Docs

  • Intro to Terraform
  • Configuration Language
  • Terraform CLI
  • Terraform Cloud
  • Terraform Enterprise
  • Provider Use
  • Plugin Development
  • Registry Publishing
  • Integration Program
  • Terraform Tools
  • CDK for Terraform
  • Glossary
Type '/' to Search

»Feature Sets API

Note: The feature sets API is only available in Terraform Cloud.

Feature sets represent the different pricing plans available to Terraform Cloud organizations. An organization's entitlement set is calculated using its subscription and feature set.

»List Feature Sets

This endpoint lists the feature sets available in Terraform Cloud.

GET /feature-sets

»Query Parameters

This endpoint supports pagination with standard URL query parameters. Remember to percent-encode [ as %5B and ] as %5D if your tooling doesn't automatically encode URLs. If neither pagination query parameters are provided, the endpoint will not be paginated and will return all results.

ParameterDescription
page[number]Optional. If omitted, the endpoint will return the first page.
page[size]Optional. If omitted, the endpoint will return 20 feature sets per page.

»Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  https://app.terraform.io/api/v2/feature-sets
curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  https://app.terraform.io/api/v2/feature-sets

»Sample Response

{
  "data": [
    {
      "id": "fs-g5jeyzSkqsK5p3CT",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Additional oversight and control for organizations.",
        "cost": 2000,
        "description": "Multiple teams with role-based access control",
        "identifier": "team",
        "is-current": true,
        "is-free-tier": false,
        "name": "Team",
        "plan": "plan_G13GVoKwS5xDEW",
        "self-serve-billing": true,
        "cost-estimation": false,
        "sentinel": false,
        "run-tasks": false,
        "teams": true,
        "user-limit": null,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    },
    {
      "id": "fs-EP5Niczf2xKUFDXt",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Policy management and cost insights for runs and workspaces.",
        "cost": 7000,
        "description": "Team plan features plus Sentinel policy as code framework",
        "identifier": "governance",
        "is-current": true,
        "is-free-tier": false,
        "name": "Team & Governance",
        "plan": "plan_G13T64ifEk3z92",
        "self-serve-billing": true,
        "cost-estimation": true,
        "sentinel": true,
        "run-tasks": true,
        "teams": true,
        "user-limit": null,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    },
    {
      "id": "fs-4ec3b3RVJWsBkst3",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Gain additional features built for larger teams and enterprise environments.",
        "cost": 0,
        "description": "Full access to Terraform Cloud's enterprise features",
        "identifier": "business",
        "is-current": true,
        "is-free-tier": true,
        "name": "Business",
        "plan": null,
        "self-serve-billing": false,
        "cost-estimation": true,
        "sentinel": true,
        "run-tasks": true,
        "teams": true,
        "user-limit": null,
        "audit-logging": true,
        "sso": true,
        "private-networking": true
      }
    },
    {
      "id": "fs-T9BCyZi3KJyWHebk",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Try out the Team & Governance plan features for 30 days. No credit card required.",
        "cost": 0,
        "description": "Try out the Team & Governance plan features for 30 days",
        "identifier": "trial",
        "is-current": true,
        "is-free-tier": true,
        "name": "Trial",
        "plan": null,
        "self-serve-billing": true,
        "cost-estimation": true,
        "sentinel": true,
        "run-tasks": true,
        "teams": true,
        "user-limit": null,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    },
    {
      "id": "fs-EvCGYfpx9CVRzteA",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Essential collaboration features for practitioners and small teams.",
        "cost": 0,
        "description": "State storage, locking, run history, VCS integration, private module registry, and remote operations",
        "identifier": "free",
        "is-current": true,
        "is-free-tier": true,
        "name": "Free",
        "plan": null,
        "self-serve-billing": true,
        "cost-estimation": false,
        "sentinel": false,
        "run-tasks": false,
        "teams": false,
        "user-limit": 5.0,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    }
  ]
}
{
  "data": [
    {
      "id": "fs-g5jeyzSkqsK5p3CT",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Additional oversight and control for organizations.",
        "cost": 2000,
        "description": "Multiple teams with role-based access control",
        "identifier": "team",
        "is-current": true,
        "is-free-tier": false,
        "name": "Team",
        "plan": "plan_G13GVoKwS5xDEW",
        "self-serve-billing": true,
        "cost-estimation": false,
        "sentinel": false,
        "run-tasks": false,
        "teams": true,
        "user-limit": null,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    },
    {
      "id": "fs-EP5Niczf2xKUFDXt",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Policy management and cost insights for runs and workspaces.",
        "cost": 7000,
        "description": "Team plan features plus Sentinel policy as code framework",
        "identifier": "governance",
        "is-current": true,
        "is-free-tier": false,
        "name": "Team & Governance",
        "plan": "plan_G13T64ifEk3z92",
        "self-serve-billing": true,
        "cost-estimation": true,
        "sentinel": true,
        "run-tasks": true,
        "teams": true,
        "user-limit": null,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    },
    {
      "id": "fs-4ec3b3RVJWsBkst3",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Gain additional features built for larger teams and enterprise environments.",
        "cost": 0,
        "description": "Full access to Terraform Cloud's enterprise features",
        "identifier": "business",
        "is-current": true,
        "is-free-tier": true,
        "name": "Business",
        "plan": null,
        "self-serve-billing": false,
        "cost-estimation": true,
        "sentinel": true,
        "run-tasks": true,
        "teams": true,
        "user-limit": null,
        "audit-logging": true,
        "sso": true,
        "private-networking": true
      }
    },
    {
      "id": "fs-T9BCyZi3KJyWHebk",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Try out the Team & Governance plan features for 30 days. No credit card required.",
        "cost": 0,
        "description": "Try out the Team & Governance plan features for 30 days",
        "identifier": "trial",
        "is-current": true,
        "is-free-tier": true,
        "name": "Trial",
        "plan": null,
        "self-serve-billing": true,
        "cost-estimation": true,
        "sentinel": true,
        "run-tasks": true,
        "teams": true,
        "user-limit": null,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    },
    {
      "id": "fs-EvCGYfpx9CVRzteA",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Essential collaboration features for practitioners and small teams.",
        "cost": 0,
        "description": "State storage, locking, run history, VCS integration, private module registry, and remote operations",
        "identifier": "free",
        "is-current": true,
        "is-free-tier": true,
        "name": "Free",
        "plan": null,
        "self-serve-billing": true,
        "cost-estimation": false,
        "sentinel": false,
        "run-tasks": false,
        "teams": false,
        "user-limit": 5.0,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    }
  ]
}

»List Feature Sets for Organization

This endpoint lists the feature sets a particular organization is eligible to access. The results may differ from the previous global endpoint - for instance, if the organization has already had a free trial, the trial feature set will not appear in this list.

GET /organizations/:organization_name/feature-sets

ParameterDescription
organization_nameThe name of the organization

»Query Parameters

This endpoint supports pagination with standard URL query parameters. Remember to percent-encode [ as %5B and ] as %5D if your tooling doesn't automatically encode URLs. If neither pagination query parameters are provided, the endpoint will not be paginated and will return all results.

ParameterDescription
page[number]Optional. If omitted, the endpoint will return the first page.
page[size]Optional. If omitted, the endpoint will return 20 organization feature sets per page.

»Sample Request

curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  https://app.terraform.io/api/v2/organizations/hashicorp/feature-sets
curl \
  --header "Authorization: Bearer $TOKEN" \
  --header "Content-Type: application/vnd.api+json" \
  https://app.terraform.io/api/v2/organizations/hashicorp/feature-sets

»Sample Response

{
  "data": [
    {
      "id": "fs-g5jeyzSkqsK5p3CT",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Additional oversight and control for organizations.",
        "cost": 2000,
        "description": "Multiple teams with role-based access control",
        "identifier": "team",
        "is-current": true,
        "is-free-tier": false,
        "name": "Team",
        "plan": "plan_G13GVoKwS5xDEW",
        "self-serve-billing": true,
        "cost-estimation": false,
        "sentinel": false,
        "run-tasks": false,
        "teams": true,
        "user-limit": null,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    },
    {
      "id": "fs-EP5Niczf2xKUFDXt",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Policy management and cost insights for runs and workspaces.",
        "cost": 7000,
        "description": "Team plan features plus Sentinel policy as code framework",
        "identifier": "governance",
        "is-current": true,
        "is-free-tier": false,
        "name": "Team & Governance",
        "plan": "plan_G13T64ifEk3z92",
        "self-serve-billing": true,
        "cost-estimation": true,
        "sentinel": true,
        "run-tasks": true,
        "teams": true,
        "user-limit": null,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    },
    {
      "id": "fs-4ec3b3RVJWsBkst3",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Gain additional features built for larger teams and enterprise environments.",
        "cost": 0,
        "description": "Full access to Terraform Cloud's enterprise features",
        "identifier": "business",
        "is-current": true,
        "is-free-tier": true,
        "name": "Business",
        "plan": null,
        "self-serve-billing": false,
        "cost-estimation": true,
        "sentinel": true,
        "run-tasks": true,
        "teams": true,
        "user-limit": null,
        "audit-logging": true,
        "sso": true,
        "private-networking": true
      }
    },
    {
      "id": "fs-EvCGYfpx9CVRzteA",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Essential collaboration features for practitioners and small teams.",
        "cost": 0,
        "description": "State storage, locking, run history, VCS integration, private module registry, and remote operations",
        "identifier": "free",
        "is-current": true,
        "is-free-tier": true,
        "name": "Free",
        "plan": null,
        "self-serve-billing": true,
        "cost-estimation": false,
        "sentinel": false,
        "run-tasks": false,
        "teams": false,
        "user-limit": 5.0,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    }
  ]
}
{
  "data": [
    {
      "id": "fs-g5jeyzSkqsK5p3CT",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Additional oversight and control for organizations.",
        "cost": 2000,
        "description": "Multiple teams with role-based access control",
        "identifier": "team",
        "is-current": true,
        "is-free-tier": false,
        "name": "Team",
        "plan": "plan_G13GVoKwS5xDEW",
        "self-serve-billing": true,
        "cost-estimation": false,
        "sentinel": false,
        "run-tasks": false,
        "teams": true,
        "user-limit": null,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    },
    {
      "id": "fs-EP5Niczf2xKUFDXt",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Policy management and cost insights for runs and workspaces.",
        "cost": 7000,
        "description": "Team plan features plus Sentinel policy as code framework",
        "identifier": "governance",
        "is-current": true,
        "is-free-tier": false,
        "name": "Team & Governance",
        "plan": "plan_G13T64ifEk3z92",
        "self-serve-billing": true,
        "cost-estimation": true,
        "sentinel": true,
        "run-tasks": true,
        "teams": true,
        "user-limit": null,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    },
    {
      "id": "fs-4ec3b3RVJWsBkst3",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Gain additional features built for larger teams and enterprise environments.",
        "cost": 0,
        "description": "Full access to Terraform Cloud's enterprise features",
        "identifier": "business",
        "is-current": true,
        "is-free-tier": true,
        "name": "Business",
        "plan": null,
        "self-serve-billing": false,
        "cost-estimation": true,
        "sentinel": true,
        "run-tasks": true,
        "teams": true,
        "user-limit": null,
        "audit-logging": true,
        "sso": true,
        "private-networking": true
      }
    },
    {
      "id": "fs-EvCGYfpx9CVRzteA",
      "type": "feature-sets",
      "attributes": {
        "comparison-description": "Essential collaboration features for practitioners and small teams.",
        "cost": 0,
        "description": "State storage, locking, run history, VCS integration, private module registry, and remote operations",
        "identifier": "free",
        "is-current": true,
        "is-free-tier": true,
        "name": "Free",
        "plan": null,
        "self-serve-billing": true,
        "cost-estimation": false,
        "sentinel": false,
        "run-tasks": false,
        "teams": false,
        "user-limit": 5.0,
        "audit-logging": false,
        "sso": false,
        "private-networking": false
      }
    }
  ]
}
github logoEdit this page
  • Overview
  • Docs
  • Extend
  • Privacy
  • Security
  • Press Kit
  • Consent Manager