API Changelog
Keep track of changes to the API for Terraform Cloud and Terraform Enterprise.
2023-01-12
- Added new rollback to previous state endpoint to State Versions API
2022-12-22
- Updated Safe Delete a workspace to fix HTTP verb as
POST
.
2022-11-18
- Update Policies API to fix policy enforcement level defaults. Enforcement level is a required field, so no defaults are available.
2022-11-03
- Update Policy Checks to fix policy set outcome return data type.
2022-10-17
- Updated the Organizations API with the
allow-force-delete-workspaces
, which controls whether workspace administrators can delete workspaces with resources under management. - Updated the Workspacess API with a safe delete endpoint that guards against deleting workspaces that are managing resources.
2022-10-12
- Update Policy Checks with result counts and support for filtering policy set outcomes.
- Update Team Membership API to include adding and removing users from teams using organization membership ID.
2022-09-21
- Update State Versions with optional
json-state-outputs
andjson-state
attributes, which are base-64 encoded external JSON representations of the terraform state. The read-onlyhosted-json-state-download-url
attribute links to this version of the state file when available. - Update State Version Outputs with a
detailed-type
attribute, which refines the output with the precise Terraform type.
2022-07-26
- Updated the Run status list with
fetching
,queuing
,pre_plan_running
andpre_plan_completed
- Update Run Tasks to include the new
stages
attribute when attaching or updating workspace tasks. - Updated Run Tasks Integration to specify the different request payloads for different stages.
2022-06-23
- Added new query parameter(s) to List Runs endpoint.
2022-06-21
- Updated Admin Organizations endpoints with new
workspace-limit
setting. This is available in Terraform Enterprise v202207-1 and later. - Updated List Agent Pools to accept a filter parameter
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. - Added new
organization-scoped
attribute andallowed-workspaces
relationship to the request/response body of the below endpoints. This is available in Terraform Enterprise v202207-1 and later.
2022-06-17
- Updated Creating a Run Task section to include the new description information for the run task to be configured.
- Update Run Tasks to include the new description attribute.
2022-06-09
- Updated List Agent Pools to accept a search parameter
q
, so that agent pools can be searched byname
. This is available in Terraform Enterprise v202207-1 and later. - Fixed List Workspaces to add missing
search[tags]
query parameter. - Updated List Workspaces to add new
search[exclude_tags]
query parameter. This is available in Terraform Enterprise v202207-1 and later.
2022-05-11
- Updated Run Tasks permission to the following endpoints:
2022-05-04
- Updated Feature Sets to add new
run-tasks
attribute.
2022-05-03
- Added Run Tasks permission to the following endpoints:
2022-04-29
- Updated Run Tasks Integration to specify the allowed
status
attribute values. - Updated Organization Memberships to add new
filter[email]
query parameter. - Updated Teams to add new
filter[names]
query parameter.
2022-04-04
- Added the Run Tasks Integration endpoint.
2022-03-14
- Added the Download Configuration Files endpoints.
2022-03-11
- Introduced Archiving Configuration Versions.
- Updated Configuration Versions to add new
fetching
andarchived
states. - Updated Runs to add new
fetching
state. - Added the Archive a Configuration Version endpoint.
- Updated Configuration Versions to add new
2022-02-25
- Updated Workspace Run Tasks to add new
enabled
attribute.
2022-02-28
- Introduced the Registry Providers endpoints to manage private providers for a private registry.
2021-12-09
- Added
variables
field for POST /runs and the run resource, enabling run-specific variable values.
2021-12-03
- OAuth API updated to handle
secret
andrsa_public_key
fields for POST/PUT.
2021-11-17
- Added pagination support to the following endpoints:
- Feature Sets -
GET /feature-sets
- Notification Configurations -
GET /workspaces/:workspace_id/notification-configurations
- Oauth Clients -
GET /organizations/:organization_name/oauth-clients
- Oauth Tokens -
GET /oauth-clients/:oauth_client_id/oauth-tokens
- Organization Feature Sets -
GET /organizations/:organization_name/feature-sets
- Organizations -
GET /organizations
- Policy Checks -
GET /runs/:run_id/policy-checks
- Policy Set Parameters -
GET /policy-sets/:policy_set_id/parameters
- SSH Keys -
GET /organizations/:organization_name/ssh-keys
- User Tokens -
GET /users/:user_id/authentication-tokens
- Feature Sets -
2021-11-11
- Introduced the Variable Sets endpoints for viewing and administering Variable Sets
2021-11-18
- Introduced the Registry Providers endpoint to manage public providers for a
private registry. These endpoints will be available in the following TFE Release:
v202112-1
2021-09-12
- Added Run Tasks Stages and Results endpoint.
2021-08-18
- Introduced the State Version Outputs endpoint to retrieve the Outputs for a given State Version
2021-08-11
- BREAKING CHANGE: Security fix to Configuration versions: upload-url attribute for uploading configuration files is now only available on the create response.
2021-07-30
- Introduced Workspace Tagging
- Updated Workspaces:
- added
tag-names
attribute. - added
POST /workspaces/:workspace_id/relationships/tags
- added
DELETE /workspaces/:workspace_id/relationships/tags
- added
- Added Organization Tags.
- Added
tags
attribute totfrun
- Updated Workspaces:
2021-07-19
- Notification configurations: Gave organization tokens permission to create and manage notification configurations.
2021-07-09
- State versions: Fixed the ID format for the workspace relationship of a state version. Previously, the reported ID was unusable due to a bug.
- Workspaces: Added
locked_by
as an includable related resource. - Added Run Tasks API endpoint.
2021-06-8
- Updated Registry Module APIs.
- added
registry_name
scoped APIs. - added
organization_name
scoped APIs. - added Module List API.
- updated Module Delete APIs (see deprecation note below).
- CLOUD: added public registry module related APIs.
- added
- DEPRECATION: The following Registry Module APIs have been replaced with newer apis and will be removed in the future.
- The following endpoints to delete modules are replaced with Module Delete APIs
POST /registry-modules/actions/delete/:organization_name/:name/:provider/:version
replaced withDELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider/:version
POST /registry-modules/actions/delete/:organization_name/:name/:provider
replaced withDELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider
POST /registry-modules/actions/delete/:organization_name/:name
replaced withDELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name
POST /registry-modules
replaced withPOST /organizations/:organization_name/registry-modules/vcs
POST /registry-modules/:organization_name/:name/:provider/versions
replaced withPOST /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider/versions
GET /registry-modules/show/:organization_name/:name/:provider
replaced withGET /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider
- The following endpoints to delete modules are replaced with Module Delete APIs
2021-05-27
- CLOUD: Agents: added delete endpoint.
2021-05-19
- Runs: added
refresh
,refresh-only
, andreplace-addrs
attributes.
2021-04-16
- Introduced Controlled Remote State Access.
- Admin Settings: added
default-remote-state-access
attribute. - Workspaces:
- added
global-remote-state
attribute. - added Remote State Consumers relationship.
- added
- Admin Settings: added
2021-04-13
- Teams: added
manage-policy-overrides
property to theorganization-access
attribute.
2021-03-23
- ENTERPRISE:
v202103-1
Introduced Share Modules Across Organizations with Terraform Enterprise.- Admin Organizations:
- added new query parameters to List all Organizations endpoint
- added module-consumers link in
relationships
response - added update module consumers endpoint
- added list module consumers endpoint
- Organizations: added Module Producers
- DEPRECATION: Admin Module Sharing: is replaced with a new JSON::Api compliant endpoint
- Admin Organizations:
2021-03-18
- CLOUD: Introduced New Workspace Overview for Terraform Cloud.
- Workspaces:
- added
resource-count
andupdated-at
attributes. - added performance attributes (
apply-duration-average
,plan-duration-average
,policy-check-failures
,run-failures
,workspaces-kpis-run-count
). - added
readme
andoutputs
related resources.
- added
- Team Access: updated to support pagination.
- Workspaces:
2021-03-11
- Added VCS Events, limited to GitLab.com connections.
2021-03-08
- Workspaces: added
current_configuration_version
andcurrent_configuration_version.ingress_attributes
as includable related resources.