Terraform
Feature sets API reference
Note: The feature sets API is only available in HCP Terraform.
Feature sets represent the different pricing plans available to HCP Terraform 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 HCP Terraform.
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.
| Parameter | Description |
|---|---|
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
Sample Response
{
"data": [
{
"id": "fs-GN3kSR1GqWNfcFaW",
"type": "feature-sets",
"attributes": {
"assessments": false,
"audit-logging": false,
"comparison-description": "",
"concurrency-override": false,
"cost-estimation": true,
"cost": 0,
"default-agents-ceiling": 1,
"default-runs-ceiling": 1,
"description": "Free 500 managed resources, then downgrade to limited features",
"global-run-tasks": false,
"identifier": "free_standard",
"is-current": true,
"is-free-tier": true,
"module-tests-generation": false,
"name": "Free",
"no-code-modules": false,
"plan": null,
"policy-enforcement": true,
"policy-limit": null,
"policy-mandatory-enforcement-limit": null,
"policy-set-limit": null,
"private-networking": true,
"private-policy-agents": false,
"private-vcs": false,
"run-task-limit": null,
"run-task-mandatory-enforcement-limit": null,
"run-task-workspace-limit": null,
"run-tasks": true,
"self-serve-billing": true,
"sentinel": true,
"sso": true,
"teams": false,
"user-limit": null,
"versioned-policy-set-limit": null
}
},
{
"id": "fs-f3xYUkkXwY8ZGP9g",
"type": "feature-sets",
"attributes": {
"assessments": false,
"audit-logging": false,
"comparison-description": "",
"concurrency-override": true,
"cost-estimation": true,
"cost": 0,
"default-agents-ceiling": 10,
"default-runs-ceiling": 10,
"description": "Automated infrastructure provisioning at any scale. First 500 free managed resources included.",
"global-run-tasks": false,
"identifier": "standard",
"is-current": true,
"is-free-tier": true,
"module-tests-generation": false,
"name": "Standard",
"no-code-modules": false,
"plan": null,
"policy-enforcement": true,
"policy-limit": null,
"policy-mandatory-enforcement-limit": null,
"policy-set-limit": null,
"private-networking": true,
"private-policy-agents": false,
"private-vcs": false,
"run-task-limit": null,
"run-task-mandatory-enforcement-limit": null,
"run-task-workspace-limit": null,
"run-tasks": true,
"self-serve-billing": true,
"sentinel": true,
"sso": true,
"teams": false,
"user-limit": null,
"versioned-policy-set-limit": null
}
},
{
"id": "fs-JhVd6dwBSZ3THzHV",
"type": "feature-sets",
"attributes": {
"assessments": true,
"audit-logging": true,
"comparison-description": "",
"concurrency-override": true,
"cost-estimation": true,
"cost": 0,
"default-agents-ceiling": 10,
"default-runs-ceiling": 10,
"description": "Automated infrastructure provisioning and management at any scale",
"global-run-tasks": true,
"identifier": "plus",
"is-current": true,
"is-free-tier": true,
"module-tests-generation": true,
"name": "Plus",
"no-code-modules": true,
"plan": null,
"policy-enforcement": true,
"policy-limit": null,
"policy-mandatory-enforcement-limit": null,
"policy-set-limit": null,
"private-networking": true,
"private-policy-agents": false,
"private-vcs": false,
"run-task-limit": null,
"run-task-mandatory-enforcement-limit": null,
"run-task-workspace-limit": null,
"run-tasks": true,
"self-serve-billing": true,
"sentinel": true,
"sso": true,
"teams": true,
"user-limit": null,
"versioned-policy-set-limit": null
}
}
]
}
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
| Parameter | Description |
|---|---|
organization_name | The 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.
| Parameter | Description |
|---|---|
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
Sample Response
{
"data": [
{
"id": "fs-GN3kSR1GqWNfcFaW",
"type": "feature-sets",
"attributes": {
"assessments": false,
"audit-logging": false,
"comparison-description": "",
"concurrency-override": false,
"cost-estimation": true,
"cost": 0,
"default-agents-ceiling": 1,
"default-runs-ceiling": 1,
"description": "Free 500 managed resources, then downgrade to limited features",
"global-run-tasks": false,
"identifier": "free_standard",
"is-current": true,
"is-free-tier": true,
"module-tests-generation": false,
"name": "Free",
"no-code-modules": false,
"plan": null,
"policy-enforcement": true,
"policy-limit": 5,
"policy-mandatory-enforcement-limit": 1,
"policy-set-limit": 1,
"private-networking": true,
"private-policy-agents": false,
"private-vcs": false,
"run-task-limit": 1,
"run-task-mandatory-enforcement-limit": 1,
"run-task-workspace-limit": 10,
"run-tasks": true,
"self-serve-billing": true,
"sentinel": true,
"sso": true,
"teams": false,
"user-limit": null,
"versioned-policy-set-limit": 0
}
},
{
"id": "fs-f3xYUkkXwY8ZGP9g",
"type": "feature-sets",
"attributes": {
"assessments": false,
"audit-logging": false,
"comparison-description": "",
"concurrency-override": true,
"cost-estimation": true,
"cost": 0,
"default-agents-ceiling": 10,
"default-runs-ceiling": 10,
"description": "Automated infrastructure provisioning at any scale. First 500 free managed resources included.",
"global-run-tasks": false,
"identifier": "standard",
"is-current": true,
"is-free-tier": true,
"module-tests-generation": false,
"name": "Standard",
"no-code-modules": false,
"plan": null,
"policy-enforcement": true,
"policy-limit": null,
"policy-mandatory-enforcement-limit": null,
"policy-set-limit": null,
"private-networking": true,
"private-policy-agents": false,
"private-vcs": false,
"run-task-limit": null,
"run-task-mandatory-enforcement-limit": null,
"run-task-workspace-limit": null,
"run-tasks": true,
"self-serve-billing": true,
"sentinel": true,
"sso": true,
"teams": false,
"user-limit": null,
"versioned-policy-set-limit": null
}
},
{
"id": "fs-JhVd6dwBSZ3THzHV",
"type": "feature-sets",
"attributes": {
"assessments": true,
"audit-logging": true,
"comparison-description": "",
"concurrency-override": true,
"cost-estimation": true,
"cost": 0,
"default-agents-ceiling": 10,
"default-runs-ceiling": 10,
"description": "Automated infrastructure provisioning and management at any scale",
"global-run-tasks": true,
"identifier": "plus",
"is-current": true,
"is-free-tier": true,
"module-tests-generation": true,
"name": "Plus",
"no-code-modules": true,
"plan": null,
"policy-enforcement": true,
"policy-limit": null,
"policy-mandatory-enforcement-limit": null,
"policy-set-limit": null,
"private-networking": true,
"private-policy-agents": false,
"private-vcs": false,
"run-task-limit": null,
"run-task-mandatory-enforcement-limit": null,
"run-task-workspace-limit": null,
"run-tasks": true,
"self-serve-billing": true,
"sentinel": true,
"sso": true,
"teams": true,
"user-limit": null,
"versioned-policy-set-limit": null
}
}
]
}