Keep track of changes to the API for HCP Terraform and Terraform Enterprise.
default-execution-mode
, default-agent-pool
, and settings-overwrites
for projects.agent-pool
relationship to the run task API, which you can use to assign a run task to an agent pool.tag-bindings
and effective-tag-bindings
on workspaces and projectsPATCH
ing tag bindings on projects and workspacesspeculative-plan-management-enabled
attribute, which controls automatic cancellation of plan-only runs triggered by outdated commits.This endpoint is exclusive to Terraform Enterprise, and not available in HCP Terraform.
terraform-build-worker-plan-timeout
and terraform-build-worker-apply-timeout
attributes are deprecated and will be replaced by plan-timeout
and apply-timeout
, respectively.allow-member-token-management
.sort
parameter to the Projects list API to allow sorting projects by name.description
attribute to the Projects API.project-count
and workspace-count
attributes to sample Projects API responses.private-vcs
to Feature Entitlements.organization-scoped
attribute to the OAuth Clients API.private-policy-agents
to Feature Entitlements.aggregated-commit-status-enabled
attribute, which controls whether Aggregated Status Checks are enabled.opa-versions
endpoint to allow administrators to manage available Open Policy Agent (OPA) versions.sentinel-versions
endpoint to allow administrators to manage available Sentinel versions.authenticated-resource
relationship to the account
API.auto_destroy_activity_duration
to the Workspaces API, which allows Terraform Cloud to schedule auto-destroy runs based on workspace inactivity.auto-apply-run-trigger
attribute, which controls if run trigger runs are auto-applied.priority
attribute to the Variable Sets API.policy-tool-version
attribute to Policy Set Outcomes.agent-enabled
and policy-tool-version
.policy-tool-version
.intermediate
boolean attribute to the State Versions API.auto-destroy-at
attribute to the Workspaces API.default-execution-mode
and default-agent-pool
.setting-overwrites
object to allow you to overwrite default-execution-mode
and default-agent-pool
.save-plan
attribute, planned_and_saved
status, and save_plan
operation type to Runs endpoints.provisional
to configuration-versions
endpoint.custom
option to the team_project
access level along with various customizable permissions. The project-access
permissions apply to the project itself, and workspace-access
permissions apply to all workspaces within the project. For more information, see Project Team Access.import
blocks.
configuration_version_download_url
, configuration_version_id
, and workspace_working_directory
properties for all stages of the Run Task Request.enforcement-level
property in the request and response of Policies endpoints.enforce
property in the request and response of Policies endpoints.version-id
property to the response for the Create, List, and Update Workspace Variables endpoints.sort
query parameter to the Workspaces API's list workspaces endpoint.vcs-repo.github-app-installation-id
to connect a workspace to a GitHub App Installation.vcs-repo.github-app-installation-id
to connect to a GitHub App Installation.vcs-repo.github-app-installation-id
to connect to a GitHub App Installation.manage-membership
to the organization access settings of the Team API.read-workspaces
and read-projects
permissions which grants teams view access to workspaces and projects.q
, so that teams can be searched by name.POST
.allow-force-delete-workspaces
, which controls whether workspace administrators can delete workspaces with resources under management.json-state-outputs
and json-state
attributes, which are base-64 encoded external JSON representations of the terraform state. The read-only hosted-json-state-download-url
attribute links to this version of the state file when available.detailed-type
attribute, which refines the output with the precise Terraform type.fetching
, queuing
, pre_plan_running
and pre_plan_completed
stages
attribute when attaching or updating workspace tasks.Added new query parameter(s) to List Runs endpoint.
workspace-limit
setting. This is available in Terraform Enterprise v202207-1 and later.filter[allowed_workspaces][name]
so that agent pools can be filtered by name of an associated workspace. The given workspace must be allowed to use the agent pool. Refer to Scoping Agent Pools to Specific Workspaces.organization-scoped
attribute and allowed-workspaces
relationship to the request/response body of the below endpoints. This is available in Terraform Enterprise v202207-1 and later.
q
, so that agent pools can be searched by name
. This is available in Terraform Enterprise v202207-1 and later.search[tags]
query parameter.search[exclude_tags]
query parameter. This is available in Terraform Enterprise v202207-1 and later.run-tasks
attribute.status
attribute values.filter[email]
query parameter.filter[names]
query parameter.fetching
and archived
states.fetching
state.enabled
attribute.variables
field for POST /runs and the run resource, enabling run-specific variable values.secret
and rsa_public_key
fields for POST/PUT.GET /feature-sets
GET /workspaces/:workspace_id/notification-configurations
GET /organizations/:organization_name/oauth-clients
GET /oauth-clients/:oauth_client_id/oauth-tokens
GET /organizations/:organization_name/feature-sets
GET /organizations
GET /runs/:run_id/policy-checks
GET /policy-sets/:policy_set_id/parameters
GET /organizations/:organization_name/ssh-keys
GET /users/:user_id/authentication-tokens
v202112-1
tag-names
attribute.POST /workspaces/:workspace_id/relationships/tags
DELETE /workspaces/:workspace_id/relationships/tags
tags
attribute to tfrun
locked_by
as an includable related resource.registry_name
scoped APIs.organization_name
scoped APIs.POST /registry-modules/actions/delete/:organization_name/:name/:provider/:version
replaced with DELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider/:version
POST /registry-modules/actions/delete/:organization_name/:name/:provider
replaced with DELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider
POST /registry-modules/actions/delete/:organization_name/:name
replaced with DELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name
POST /registry-modules
replaced with POST /organizations/:organization_name/registry-modules/vcs
POST /registry-modules/:organization_name/:name/:provider/versions
replaced with POST /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider/versions
GET /registry-modules/show/:organization_name/:name/:provider
replaced with GET /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider
refresh
, refresh-only
, and replace-addrs
attributes.default-remote-state-access
attribute.global-remote-state
attribute.manage-policy-overrides
property to the organization-access
attribute.v202103-1
Introduced Share Modules Across Organizations with Terraform Enterprise.
relationships
responseresource-count
and updated-at
attributes.apply-duration-average
, plan-duration-average
, policy-check-failures
, run-failures
, workspaces-kpis-run-count
).readme
and outputs
related resources.current_configuration_version
and current_configuration_version.ingress_attributes
as includable related resources.RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4