terrasnek Documentation¶
Installation¶
pip install terrasnek
Getting Started¶
Recommended Env Var Usage:
import os
TFC_TOKEN = os.getenv("TFC_TOKEN", None)
TFC_URL = os.getenv("TFC_URL", None) # ex: https://app.terraform.io
Using TLS:
from terrasnek.api import TFC
api = TFC(TFC_TOKEN, url=TFC_URL)
api.set_org("YOUR_ORGANIZATION")
Insecure:
from terrasnek.api import TFC
api = TFC(TFC_TOKEN, url=TFC_URL, verify=False)
api.set_org("YOUR_ORGANIZATION")
Examples¶
NOTE: Every endpoint supported in terrasnek has an API reference in its docstring.
Configure the API Class¶
import os
from terrasnek.api import TFC
TFC_TOKEN = os.getenv("TFC_TOKEN", None)
TFC_URL = os.getenv("TFC_URL", None) # ex: https://app.terraform.io
api = TFC(TFC_TOKEN, url=TFC_URL)
api.set_org("YOUR_ORGANIZATION")
Create a Workspace¶
create_workspace_payload = {
# https://www.terraform.io/docs/cloud/api/workspaces.html#sample-payload
}
created_workspace = api.workspaces.create(create_workspace_payload)
created_workspace_id = created_workspace["data"]["id"]
Add Variables to a Workspace¶
create_variable_payload = {
# https://www.terraform.io/docs/cloud/api/variables.html#sample-payload
}
api.vars.create(create_variable_payload)
Create a Run on a Workspace¶
create_run_payload = {
# https://www.terraform.io/docs/cloud/api/run.html#sample-payload
}
run = api.runs.create(create_run_payload)
run_id = self._run["data"]["id"]
Override a Failed Policy Check¶
pol_checks = api.pol_checks.list(run_id)
api.pol_checks.override(pol_checks["data"][0]["id"])
Apply a Run on a Workspace¶
applied_run = api.runs.apply(run_id)
For more examples, see the ./test directory in the repository.
terrasnek to Terraform Cloud API Completeness¶
| API Endpoint | Method Description | HTTP Method | Terrasnek Method | Implemented | Permalink |
|---|---|---|---|---|---|
| Account | Get your account details | GET /account/details | account.show | True | https://www.terraform.io/docs/cloud/api/account.html#get-your-account-details |
| Account | Update your account info | PATCH /account/update | account.update | True | https://www.terraform.io/docs/cloud/api/account.html#update-your-account-info |
| Account | Change your password | PATCH /account/password | account.change_password | True | https://www.terraform.io/docs/cloud/api/account.html#change-your-password |
| Admin Module Sharing | Update an Organization’s Module Consumers | PATCH /admin/organizations/:name/module-consumers | False | https://www.terraform.io/docs/cloud/api/admin/module-sharing.html#update-an-organization-39-s-module-consumers | |
| Admin Orgs | List all organizations | GET /admin/organizations | admin_orgs.list | True | https://www.terraform.io/docs/cloud/api/admin/organizations.html#list-all-organizations |
| Admin Orgs | Show an organization | GET /admin/organizations/:name | admin_orgs.show | True | https://www.terraform.io/docs/cloud/api/admin/organizations.html#show-an-organization |
| Admin Orgs | Update an Organization | PATCH /organizations/:organization_name | False | https://www.terraform.io/docs/cloud/api/admin/organizations.html#update-an-organization | |
| Admin Orgs | Delete an organization | DELETE /admin/organizations/:name | admin_orgs.destroy | True | https://www.terraform.io/docs/cloud/api/admin/organizations.html#delete-an-organization |
| Admin Runs | List all runs | GET /admin/runs | admin_runs.list | True | https://www.terraform.io/docs/cloud/api/admin/runs.html#list-all-runs |
| Admin Runs | Force a run into the “cancelled” state | POST /admin/runs/:id/actions/force-cancel | admin_runs.force_cancel | True | https://www.terraform.io/docs/cloud/api/admin/runs.html#force-a-run-into-the-quot-cancelled-quot-state |
| Admin Settings | List General Settings | GET /api/v2/admin/general-settings | admin_settings.list_general | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#list-general-settings |
| Admin Settings | Update General Settings | PATCH /api/v2/admin/general-settings | admin_settings.update_general | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#update-general-settings |
| Admin Settings | List Cost Estimation Settings | GET /api/v2/admin/cost-estimation-settings | admin_settings.list_cost_estimation | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#list-cost-estimation-settings |
| Admin Settings | Update Cost Estimation Settings | PATCH /api/v2/admin/cost-estimation-settings | admin_settings.update_cost_estimation | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#update-cost-estimation-settings |
| Admin Settings | List SAML Settings | GET /api/v2/admin/saml-settings | admin_settings.list_saml | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#list-saml-settings |
| Admin Settings | Update SAML Settings | PATCH /api/v2/admin/saml-settings | admin_settings.update_saml | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#update-saml-settings |
| Admin Settings | Revoke previous SAML IdP Certificate | POST /api/v2/admin/saml-settings/actions/revoke-old-certificate | admin_settings.revoke_previous_saml_idp_cert | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#revoke-previous-saml-idp-certificate |
| Admin Settings | List SMTP Settings | GET /api/v2/admin/smtp-settings | admin_settings.list_smtp | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#list-smtp-settings |
| Admin Settings | Update SMTP Settings | PATCH /api/v2/admin/smtp-settings | admin_settings.update_smtp | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#update-smtp-settings |
| Admin Settings | List Twilio Settings | GET /api/v2/admin/twilio-settings | admin_settings.list_twilio | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#list-twilio-settings |
| Admin Settings | Update Twilio Settings | PATCH /api/v2/admin/twilio-settings | admin_settings.update_twilio | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#update-twilio-settings |
| Admin Settings | Verify Twilio Settings | POST /api/v2/admin/twilio-settings/verify | admin_settings.verify_twilio | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#verify-twilio-settings |
| Admin Settings | List Customization Settings | GET /api/v2/admin/customization-settings | admin_settings.list_customization | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#list-customization-settings |
| Admin Settings | Update Customization Settings | PATCH /api/v2/admin/customization-settings | admin_settings.update_customization | True | https://www.terraform.io/docs/cloud/api/admin/settings.html#update-customization-settings |
| Admin Terraform Versions | List all Terraform versions | GET /admin/terraform-versions | admin_terraform_versions.list | True | https://www.terraform.io/docs/cloud/api/admin/terraform-versions.html#list-all-terraform-versions |
| Admin Terraform Versions | Create a Terraform version | POST /admin/terraform-versions | admin_terraform_versions.create | True | https://www.terraform.io/docs/cloud/api/admin/terraform-versions.html#create-a-terraform-version |
| Admin Terraform Versions | Show a Terraform version | GET /admin/terraform-versions/:id | admin_terraform_versions.show | True | https://www.terraform.io/docs/cloud/api/admin/terraform-versions.html#show-a-terraform-version |
| Admin Terraform Versions | Update a Terraform version | PATCH /admin/terraform-versions/:id | admin_terraform_versions.update | True | https://www.terraform.io/docs/cloud/api/admin/terraform-versions.html#update-a-terraform-version |
| Admin Terraform Versions | Delete a Terraform version | DELETE /admin/terraform-versions/:id | admin_terraform_versions.destroy | True | https://www.terraform.io/docs/cloud/api/admin/terraform-versions.html#delete-a-terraform-version |
| Admin Users | List all users | GET /admin/users | admin_users.list | True | https://www.terraform.io/docs/cloud/api/admin/users.html#list-all-users |
| Admin Users | Delete a user account | DELETE /admin/users/:id | admin_users.destroy | True | https://www.terraform.io/docs/cloud/api/admin/users.html#delete-a-user-account |
| Admin Users | Suspend a user | POST /admin/users/:id/actions/suspend | admin_users.suspend | True | https://www.terraform.io/docs/cloud/api/admin/users.html#suspend-a-user |
| Admin Users | Re-activate a suspended user | POST /admin/users/:id/actions/unsuspend | admin_users.unsuspend | True | https://www.terraform.io/docs/cloud/api/admin/users.html#re-activate-a-suspended-user |
| Admin Users | Grant a user administrative privileges | POST /admin/users/:id/actions/grant_admin | admin_users.grant_admin | True | https://www.terraform.io/docs/cloud/api/admin/users.html#grant-a-user-administrative-privileges |
| Admin Users | Revoke an user’s administrative privileges | POST /admin/users/:id/actions/revoke_admin | admin_users.revoke_admin | True | https://www.terraform.io/docs/cloud/api/admin/users.html#revoke-an-user-39-s-administrative-privileges |
| Admin Users | Disable a user’s two-factor authentication | POST /admin/users/:id/actions/disable_two_factor | admin_users.disable_two_factor | True | https://www.terraform.io/docs/cloud/api/admin/users.html#disable-a-user-39-s-two-factor-authentication |
| Admin Users | Impersonate another user | POST /admin/users/:id/actions/impersonate | admin_users.impersonate | True | https://www.terraform.io/docs/cloud/api/admin/users.html#impersonate-another-user |
| Admin Users | End an impersonation session | POST /admin/users/actions/unimpersonate | admin_users.unimpersonate | True | https://www.terraform.io/docs/cloud/api/admin/users.html#end-an-impersonation-session |
| Admin Workspaces | List all workspaces | GET /admin/workspaces | admin_workspaces.list | True | https://www.terraform.io/docs/cloud/api/admin/workspaces.html#list-all-workspaces |
| Admin Workspaces | Show a workspace | GET /admin/workspaces/:id | admin_workspaces.show | True | https://www.terraform.io/docs/cloud/api/admin/workspaces.html#show-a-workspace |
| Admin Workspaces | Destroy a workspace | DELETE /admin/workspaces/:id | admin_workspaces.destroy | True | https://www.terraform.io/docs/cloud/api/admin/workspaces.html#destroy-a-workspace |
| Agent Tokens | List Agent Tokens | GET /agent-pools/:agent_pool_id/authentication-tokens | agent_tokens.list | True | https://www.terraform.io/docs/cloud/api/agent-tokens.html#list-agent-tokens |
| Agent Tokens | Show an Agent Token | GET /authentication-tokens/:id | agent_tokens.show | True | https://www.terraform.io/docs/cloud/api/agent-tokens.html#show-an-agent-token |
| Agent Tokens | Create an Agent Token | POST /agent-pools/:agent_pool_id/authentication-tokens | agent_tokens.create | True | https://www.terraform.io/docs/cloud/api/agent-tokens.html#create-an-agent-token |
| Agent Tokens | Destroy an Agent Token | DELETE /api/v2/authentication-tokens/:id | agent_tokens.destroy | True | https://www.terraform.io/docs/cloud/api/agent-tokens.html#destroy-an-agent-token |
| Agents | List Agent Pools | GET /organizations/:organization_name/agent-pools | agents.list_pools | True | https://www.terraform.io/docs/cloud/api/agents.html#list-agent-pools |
| Agents | List Agents | GET /agent-pools/:agent_pool_id/agents | agents.list | True | https://www.terraform.io/docs/cloud/api/agents.html#list-agents |
| Agents | Show an Agent Pool | GET /agent-pools/:id | agents.show_pool | True | https://www.terraform.io/docs/cloud/api/agents.html#show-an-agent-pool |
| Agents | Show an Agent | GET /agents/:id | agents.show | True | https://www.terraform.io/docs/cloud/api/agents.html#show-an-agent |
| Agents | Create an Agent Pool | POST /organizations/:organization_name/agent-pool | agents.create_pool | True | https://www.terraform.io/docs/cloud/api/agents.html#create-an-agent-pool |
| Agents | Update an Agent Pool | PATCH /agent-pools/:id | agents.update | True | https://www.terraform.io/docs/cloud/api/agents.html#update-an-agent-pool |
| Agents | Delete an Agent Pool | DELETE /agent-pools/:agent_pool_id | agents.destroy | True | https://www.terraform.io/docs/cloud/api/agents.html#delete-an-agent-pool |
| Applies | Show an apply | GET /applies/:id | applies.show | True | https://www.terraform.io/docs/cloud/api/applies.html#show-an-apply |
| Audit Trails | List Audit Trails | GET /organization/audit-trail | audit_trails.list | True | https://www.terraform.io/docs/cloud/api/audit-trails.html#list-audit-trails |
| Config Versions | List Configuration Versions | GET /workspaces/:workspace_id/configuration-versions | config_versions.list | True | https://www.terraform.io/docs/cloud/api/configuration-versions.html#list-configuration-versions |
| Config Versions | Show a Configuration Version | GET /configuration-versions/:configuration-id | config_versions.show | True | https://www.terraform.io/docs/cloud/api/configuration-versions.html#show-a-configuration-version |
| Config Versions | Create a Configuration Version | POST /workspaces/:workspace_id/configuration-versions | config_versions.create | True | https://www.terraform.io/docs/cloud/api/configuration-versions.html#create-a-configuration-version |
| Config Versions | Upload Configuration Files | PUT https://archivist.terraform.io/v1/object/<UNIQUE OBJECT ID> | config_versions.upload | True | https://www.terraform.io/docs/cloud/api/configuration-versions.html#upload-configuration-files |
| Cost Estimates | Show a cost estimate | GET /cost-estimates/:id | cost_estimates.show | True | https://www.terraform.io/docs/cloud/api/cost-estimates.html#show-a-cost-estimate |
| Ip Ranges | Get IP Ranges | GET /meta/ip-ranges | ip_ranges.list | True | https://www.terraform.io/docs/cloud/api/ip-ranges.html#get-ip-ranges |
| Notification Configs | Create a Notification Configuration | POST /workspaces/:workspace_id/notification-configurations | notification_configs.create | True | https://www.terraform.io/docs/cloud/api/notification-configurations.html#create-a-notification-configuration |
| Notification Configs | List Notification Configurations | GET /workspaces/:workspace_id/notification-configurations | notification_configs.list | True | https://www.terraform.io/docs/cloud/api/notification-configurations.html#list-notification-configurations |
| Notification Configs | Show a Notification Configuration | GET /notification-configurations/:notification-configuration-id | notification_configs.show | True | https://www.terraform.io/docs/cloud/api/notification-configurations.html#show-a-notification-configuration |
| Notification Configs | Update a Notification Configuration | PATCH /notification-configurations/:notification-configuration-id | notification_configs.update | True | https://www.terraform.io/docs/cloud/api/notification-configurations.html#update-a-notification-configuration |
| Notification Configs | Verify a Notification Configuration | POST /notification-configurations/:notification-configuration-id/actions/verify | notification_configs.verify | True | https://www.terraform.io/docs/cloud/api/notification-configurations.html#verify-a-notification-configuration |
| Notification Configs | Delete a Notification Configuration | DELETE /notification-configurations/:notification-configuration-id | notification_configs.destroy | True | https://www.terraform.io/docs/cloud/api/notification-configurations.html#delete-a-notification-configuration |
| Oauth Clients | List OAuth Clients | GET /organizations/:organization_name/oauth-clients | oauth_clients.list | True | https://www.terraform.io/docs/cloud/api/oauth-clients.html#list-oauth-clients |
| Oauth Clients | Show an OAuth Client | GET /oauth-clients/:id | oauth_clients.show | True | https://www.terraform.io/docs/cloud/api/oauth-clients.html#show-an-oauth-client |
| Oauth Clients | Create an OAuth Client | POST /organizations/:organization_name/oauth-clients | oauth_clients.create | True | https://www.terraform.io/docs/cloud/api/oauth-clients.html#create-an-oauth-client |
| Oauth Clients | Update an OAuth Client | PATCH /oauth-clients/:id | oauth_clients.update | True | https://www.terraform.io/docs/cloud/api/oauth-clients.html#update-an-oauth-client |
| Oauth Clients | Destroy an OAuth Client | DELETE /oauth-clients/:id | oauth_clients.destroy | True | https://www.terraform.io/docs/cloud/api/oauth-clients.html#destroy-an-oauth-client |
| Oauth Tokens | List OAuth Tokens | GET /oauth-clients/:oauth_client_id/oauth-tokens | oauth_tokens.list | True | https://www.terraform.io/docs/cloud/api/oauth-tokens.html#list-oauth-tokens |
| Oauth Tokens | Show an OAuth Token | GET /oauth-tokens/:id | oauth_tokens.show | True | https://www.terraform.io/docs/cloud/api/oauth-tokens.html#show-an-oauth-token |
| Oauth Tokens | Update an OAuth Token | PATCH /oauth-tokens/:id | oauth_tokens.update | True | https://www.terraform.io/docs/cloud/api/oauth-tokens.html#update-an-oauth-token |
| Oauth Tokens | Destroy an OAuth Token | DELETE /oauth-tokens/:id | oauth_tokens.destroy | True | https://www.terraform.io/docs/cloud/api/oauth-tokens.html#destroy-an-oauth-token |
| Org Memberships | Invite a User to an Organization | POST /organizations/:organization_name/organization-memberships | org_memberships.invite | True | https://www.terraform.io/docs/cloud/api/organization-memberships.html#invite-a-user-to-an-organization |
| Org Memberships | List Memberships for an Organization | GET /organizations/:organization_name/organization-memberships | org_memberships.list_for_org | True | https://www.terraform.io/docs/cloud/api/organization-memberships.html#list-memberships-for-an-organization |
| Org Memberships | List User’s Own Memberships | GET /organization-memberships | org_memberships.list_for_user | True | https://www.terraform.io/docs/cloud/api/organization-memberships.html#list-user-39-s-own-memberships |
| Org Memberships | Show a Membership | GET /organization-memberships/:organization_membership_id | org_memberships.show | True | https://www.terraform.io/docs/cloud/api/organization-memberships.html#show-a-membership |
| Org Memberships | Remove User from Organization | DELETE /organization-memberships/:organization_membership_id | org_memberships.remove | True | https://www.terraform.io/docs/cloud/api/organization-memberships.html#remove-user-from-organization |
| Org Tokens | Generate a new organization token | POST /organizations/:organization_name/authentication-token | org_tokens.create | True | https://www.terraform.io/docs/cloud/api/organization-tokens.html#generate-a-new-organization-token |
| Org Tokens | Delete the organization token | DELETE /organizations/:organization/authentication-token | org_tokens.destroy | True | https://www.terraform.io/docs/cloud/api/organization-tokens.html#delete-the-organization-token |
| Orgs | List Organizations | GET /organizations | orgs.entitlements | True | https://www.terraform.io/docs/cloud/api/organizations.html#list-organizations |
| Orgs | Show an Organization | GET /organizations/:organization_name | orgs.entitlements | True | https://www.terraform.io/docs/cloud/api/organizations.html#show-an-organization |
| Orgs | Create an Organization | POST /organizations | orgs.create | True | https://www.terraform.io/docs/cloud/api/organizations.html#create-an-organization |
| Orgs | Update an Organization | PATCH /organizations/:organization_name | orgs.update | True | https://www.terraform.io/docs/cloud/api/organizations.html#update-an-organization |
| Orgs | Destroy an Organization | DELETE /organizations/:organization_name | orgs.destroy | True | https://www.terraform.io/docs/cloud/api/organizations.html#destroy-an-organization |
| Orgs | Show the Entitlement Set | GET /organizations/:organization_name/entitlement-set | orgs.entitlements | True | https://www.terraform.io/docs/cloud/api/organizations.html#show-the-entitlement-set |
| Plan Exports | Create a plan export | POST /plan-exports | plan_exports.create | True | https://www.terraform.io/docs/cloud/api/plan-exports.html#create-a-plan-export |
| Plan Exports | Show a plan export | GET /plan-exports/:id | plan_exports.show | True | https://www.terraform.io/docs/cloud/api/plan-exports.html#show-a-plan-export |
| Plan Exports | Download exported plan data | GET /plan-exports/:id/download | plan_exports.download | True | https://www.terraform.io/docs/cloud/api/plan-exports.html#download-exported-plan-data |
| Plan Exports | Delete exported plan data | DELETE /plan-exports/:id | plan_exports.destroy | True | https://www.terraform.io/docs/cloud/api/plan-exports.html#delete-exported-plan-data |
| Plans | Show a plan | GET /plans/:id | plans.show | True | https://www.terraform.io/docs/cloud/api/plans.html#show-a-plan |
| Plans | Retrieve the JSON execution plan | GET /plans/:id/json-output | plans.download_json | True | https://www.terraform.io/docs/cloud/api/plans.html#retrieve-the-json-execution-plan |
| Plans | Retrieve the JSON execution plan | GET /runs/:id/plan/json-output | plans.download_json | True | https://www.terraform.io/docs/cloud/api/plans.html#retrieve-the-json-execution-plan |
| Policies | Create a Policy | POST /organizations/:organization_name/policies | policies.create | True | https://www.terraform.io/docs/cloud/api/policies.html#create-a-policy |
| Policies | Show a Policy | GET /policies/:policy_id | policies.show | True | https://www.terraform.io/docs/cloud/api/policies.html#show-a-policy |
| Policies | Upload a Policy | PUT /policies/:policy_id/upload | policies.upload | True | https://www.terraform.io/docs/cloud/api/policies.html#upload-a-policy |
| Policies | Update a Policy | PATCH /policies/:policy_id | policies.update | True | https://www.terraform.io/docs/cloud/api/policies.html#update-a-policy |
| Policies | List Policies | GET /organizations/:organization_name/policies | policies.list | True | https://www.terraform.io/docs/cloud/api/policies.html#list-policies |
| Policies | Delete a Policy | DELETE /policies/:policy_id | policies.destroy | True | https://www.terraform.io/docs/cloud/api/policies.html#delete-a-policy |
| Policy Set Params | Create a Parameter | POST /policy-sets/:policy_set_id/parameters | policy_set_params.create | True | https://www.terraform.io/docs/cloud/api/policy-set-params.html#create-a-parameter |
| Policy Set Params | List Parameters | GET /policy-sets/:policy_set_id/parameters | policy_set_params.list | True | https://www.terraform.io/docs/cloud/api/policy-set-params.html#list-parameters |
| Policy Set Params | Update Parameters | PATCH /policy-sets/:policy_set_id/parameters/:parameter_id | policy_set_params.update | True | https://www.terraform.io/docs/cloud/api/policy-set-params.html#update-parameters |
| Policy Set Params | Delete Parameters | DELETE /policy-sets/:policy_set_id/parameters/:parameter_id | policy_set_params.destroy | True | https://www.terraform.io/docs/cloud/api/policy-set-params.html#delete-parameters |
| Policy Sets | Create a Policy Set | POST /organizations/:organization_name/policy-sets | policy_sets.create | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#create-a-policy-set |
| Policy Sets | List Policy Sets | GET /organizations/:organization_name/policy-sets | policy_sets.list | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#list-policy-sets |
| Policy Sets | Show a Policy Set | GET /policy-sets/:id | policy_sets.show | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#show-a-policy-set |
| Policy Sets | Update a Policy Set | PATCH /policy-sets/:id | policy_sets.update | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#update-a-policy-set |
| Policy Sets | Add Policies to the Policy Set | POST /policy-sets/:id/relationships/policies | policy_sets.add_policies_to_set | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#add-policies-to-the-policy-set |
| Policy Sets | Attach a Policy Set to workspaces | POST /policy-sets/:id/relationships/workspaces | policy_sets.attach_policy_set_to_workspaces | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#attach-a-policy-set-to-workspaces |
| Policy Sets | Remove Policies from the Policy Set | DELETE /policy-sets/:id/relationships/policies | policy_sets.remove_policies_from_set | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#remove-policies-from-the-policy-set |
| Policy Sets | Detach the Policy Set from workspaces | DELETE /policy-sets/:id/relationships/workspaces | policy_sets.detach_policy_set_from_workspaces | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#detach-the-policy-set-from-workspaces |
| Policy Sets | Delete a Policy Set | DELETE /policy-sets/:id | policy_sets.remove_policies_from_set | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#delete-a-policy-set |
| Policy Sets | Create a Policy Set Version | POST /policy-sets/:id/versions | policy_sets.create_policy_set_version | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#create-a-policy-set-version |
| Policy Sets | Create a Policy Set Version | PUT | policy_sets.upload | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#create-a-policy-set-version |
| Policy Sets | Upload Policy Set Versions | PUT https://archivist.terraform.io/v1/object/<UNIQUE OBJECT ID> | policy_sets.upload | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#upload-policy-set-versions |
| Policy Sets | Show a Policy Set Version | GET /policy-set-versions/:id | policy_sets.show_policy_set_version | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#show-a-policy-set-version |
| Policy Sets | Show a Policy Set Version | PUT | policy_sets.upload | True | https://www.terraform.io/docs/cloud/api/policy-sets.html#show-a-policy-set-version |
| Registry Modules | Publish a Module from a VCS | POST /registry-modules | registry_modules.publish_from_vcs | True | https://www.terraform.io/docs/cloud/api/modules.html#publish-a-module-from-a-vcs |
| Registry Modules | Create a Module | POST /organizations/:organization_name/registry-modules | registry_modules.create | True | https://www.terraform.io/docs/cloud/api/modules.html#create-a-module |
| Registry Modules | Create a Module Version | POST /registry-modules/:organization_name/:name/:provider/versions | registry_modules.create_version | True | https://www.terraform.io/docs/cloud/api/modules.html#create-a-module-version |
| Registry Modules | Upload a Module Version | PUT https://archivist.terraform.io/v1/object/<UNIQUE OBJECT ID> | registry_modules.upload_version | True | https://www.terraform.io/docs/cloud/api/modules.html#upload-a-module-version |
| Registry Modules | Show a Module | GET /registry-modules/show/:organization_name/:name/:provider | registry_modules.show | True | https://www.terraform.io/docs/cloud/api/modules.html#show-a-module |
| Registry Modules | None | POST /registry-modules/actions/delete/:organization_name/:name/:provider/:version | registry_modules.destroy | True | https://www.terraform.io/docs/cloud/api/modules.htmlNone |
| Registry Modules | None | POST /registry-modules/actions/delete/:organization_name/:name/:provider | registry_modules.destroy | True | https://www.terraform.io/docs/cloud/api/modules.htmlNone |
| Registry Modules | None | POST /registry-modules/actions/delete/:organization_name/:name | registry_modules.destroy | True | https://www.terraform.io/docs/cloud/api/modules.htmlNone |
| Run Triggers | Create a Run Trigger | POST /workspaces/:workspace_id/run-triggers | run_triggers.create | True | https://www.terraform.io/docs/cloud/api/run-triggers.html#create-a-run-trigger |
| Run Triggers | List Run Triggers | GET /workspaces/:workspace_id/run-triggers | run_triggers.list | True | https://www.terraform.io/docs/cloud/api/run-triggers.html#list-run-triggers |
| Run Triggers | Show a Run Trigger | GET /run-triggers/:run_trigger_id | run_triggers.show | True | https://www.terraform.io/docs/cloud/api/run-triggers.html#show-a-run-trigger |
| Run Triggers | Delete a Run Trigger | DELETE /run-triggers/:run_trigger_id | run_triggers.destroy | True | https://www.terraform.io/docs/cloud/api/run-triggers.html#delete-a-run-trigger |
| Runs | Create a Run | POST /runs | runs.create | True | https://www.terraform.io/docs/cloud/api/run.html#create-a-run |
| Runs | Apply a Run | POST /runs/:run_id/actions/apply | runs.apply | True | https://www.terraform.io/docs/cloud/api/run.html#apply-a-run |
| Runs | List Runs in a Workspace | GET /workspaces/:workspace_id/runs | runs.list | True | https://www.terraform.io/docs/cloud/api/run.html#list-runs-in-a-workspace |
| Runs | Get run details | GET /runs/:run_id | runs.show | True | https://www.terraform.io/docs/cloud/api/run.html#get-run-details |
| Runs | Discard a Run | POST /runs/:run_id/actions/discard | runs.discard | True | https://www.terraform.io/docs/cloud/api/run.html#discard-a-run |
| Runs | Cancel a Run | POST /runs/:run_id/actions/cancel | runs.cancel | True | https://www.terraform.io/docs/cloud/api/run.html#cancel-a-run |
| Runs | Forcefully cancel a run | POST /runs/:run_id/actions/force-cancel | runs.force_cancel | True | https://www.terraform.io/docs/cloud/api/run.html#forcefully-cancel-a-run |
| Runs | Forcefully execute a run | POST /runs/:run_id/actions/force-execute | runs.force_execute | True | https://www.terraform.io/docs/cloud/api/run.html#forcefully-execute-a-run |
| Ssh Keys | List SSH Keys | GET /organizations/:organization_name/ssh-keys | ssh_keys.list | True | https://www.terraform.io/docs/cloud/api/ssh-keys.html#list-ssh-keys |
| Ssh Keys | Get an SSH Key | GET /ssh-keys/:ssh_key_id | ssh_keys.show | True | https://www.terraform.io/docs/cloud/api/ssh-keys.html#get-an-ssh-key |
| Ssh Keys | Create an SSH Key | POST /organizations/:organization_name/ssh-keys | ssh_keys.create | True | https://www.terraform.io/docs/cloud/api/ssh-keys.html#create-an-ssh-key |
| Ssh Keys | Update an SSH Key | PATCH /ssh-keys/:ssh_key_id | ssh_keys.update | True | https://www.terraform.io/docs/cloud/api/ssh-keys.html#update-an-ssh-key |
| Ssh Keys | Delete an SSH Key | DELETE /ssh-keys/:ssh_key_id | ssh_keys.destroy | True | https://www.terraform.io/docs/cloud/api/ssh-keys.html#delete-an-ssh-key |
| State Version Outputs | Show a State Version Output | GET /state-version-outputs/:state_version_output_id | state_version_outputs.show | True | https://www.terraform.io/docs/cloud/api/state-version-outputs.html#show-a-state-version-output |
| State Versions | Create a State Version | POST /workspaces/:workspace_id/state-versions | state_versions.create | True | https://www.terraform.io/docs/cloud/api/state-versions.html#create-a-state-version |
| State Versions | List State Versions for a Workspace | GET /state-versions | state_versions.list | True | https://www.terraform.io/docs/cloud/api/state-versions.html#list-state-versions-for-a-workspace |
| State Versions | Fetch the Current State Version for a Workspace | GET /workspaces/:workspace_id/current-state-version | state_versions.get_current | True | https://www.terraform.io/docs/cloud/api/state-versions.html#fetch-the-current-state-version-for-a-workspace |
| State Versions | Show a State Version | GET /state-versions/:state_version_id | state_versions.show | True | https://www.terraform.io/docs/cloud/api/state-versions.html#show-a-state-version |
| Team Access | List Team Access to a Workspace | GET /team-workspaces | team_access.list | True | https://www.terraform.io/docs/cloud/api/team-access.html#list-team-access-to-a-workspace |
| Team Access | Show a Team Access relationship | GET /team-workspaces/:id | team_access.show | True | https://www.terraform.io/docs/cloud/api/team-access.html#show-a-team-access-relationship |
| Team Access | Add Team Access to a Workspace | POST /team-workspaces | team_access.add_team_access | True | https://www.terraform.io/docs/cloud/api/team-access.html#add-team-access-to-a-workspace |
| Team Access | Update Team Access to a Workspace | PATCH /team-workspaces/:id | team_access.update | True | https://www.terraform.io/docs/cloud/api/team-access.html#update-team-access-to-a-workspace |
| Team Access | Remove Team Access to a Workspace | DELETE /team-workspaces/:id | team_access.remove_team_access | True | https://www.terraform.io/docs/cloud/api/team-access.html#remove-team-access-to-a-workspace |
| Team Memberships | Add a User to Team | POST /teams/:team_id/relationships/users | team_memberships.add_user_to_team | True | https://www.terraform.io/docs/cloud/api/team-members.html#add-a-user-to-team |
| Team Memberships | Delete a User from Team | DELETE /teams/:team_id/relationships/users | team_memberships.remove_user_from_team | True | https://www.terraform.io/docs/cloud/api/team-members.html#delete-a-user-from-team |
| Teams | List teams | GET organizations/:organization_name/teams | teams.list | True | https://www.terraform.io/docs/cloud/api/teams.html#list-teams |
| Teams | Create a Team | POST /organizations/:organization_name/teams | teams.create | True | https://www.terraform.io/docs/cloud/api/teams.html#create-a-team |
| Teams | Show Team Information | GET /teams/:team_id | teams.show | True | https://www.terraform.io/docs/cloud/api/teams.html#show-team-information |
| Teams | Update a Team | PATCH /teams/:team_id | teams.update | True | https://www.terraform.io/docs/cloud/api/teams.html#update-a-team |
| Teams | Delete a Team | DELETE /teams/:team_id | teams.destroy | True | https://www.terraform.io/docs/cloud/api/teams.html#delete-a-team |
| User Tokens | List User Tokens | GET /api/v2/users/:user_id/authentication-tokens | user_tokens.list | True | https://www.terraform.io/docs/cloud/api/user-tokens.html#list-user-tokens |
| User Tokens | Show a User Token | GET /api/v2/authentication-tokens/:id | user_tokens.show | True | https://www.terraform.io/docs/cloud/api/user-tokens.html#show-a-user-token |
| User Tokens | Create a User Token | POST /api/v2/users/:user_id/authentication-tokens | user_tokens.create | True | https://www.terraform.io/docs/cloud/api/user-tokens.html#create-a-user-token |
| User Tokens | Destroy a User Token | DELETE /api/v2/authentication-tokens/:id | user_tokens.destroy | True | https://www.terraform.io/docs/cloud/api/user-tokens.html#destroy-a-user-token |
| Users | Show a User | GET /users/:user_id | users.show | True | https://www.terraform.io/docs/cloud/api/users.html#show-a-user |
| Vars | Create a Variable | POST /vars | vars.create | True | https://www.terraform.io/docs/cloud/api/variables.html#create-a-variable |
| Vars | List Variables | GET /vars | vars.list | True | https://www.terraform.io/docs/cloud/api/variables.html#list-variables |
| Vars | Update Variables | PATCH /vars/:variable_id | vars.update | True | https://www.terraform.io/docs/cloud/api/variables.html#update-variables |
| Vars | Delete Variables | DELETE /vars/:variable_id | vars.destroy | True | https://www.terraform.io/docs/cloud/api/variables.html#delete-variables |
| Workspace Vars | Create a Variable | POST /workspaces/:workspace_id/vars | workspace_vars.create | True | https://www.terraform.io/docs/cloud/api/workspace-variables.html#create-a-variable |
| Workspace Vars | List Variables | GET /workspaces/:workspace_id/vars | workspace_vars.list | True | https://www.terraform.io/docs/cloud/api/workspace-variables.html#list-variables |
| Workspace Vars | Update Variables | PATCH /workspaces/:workspace_id/vars/:variable_id | workspace_vars.update | True | https://www.terraform.io/docs/cloud/api/workspace-variables.html#update-variables |
| Workspace Vars | Delete Variables | DELETE /workspaces/:workspace_id/vars/:variable_id | workspace_vars.destroy | True | https://www.terraform.io/docs/cloud/api/workspace-variables.html#delete-variables |
| Workspaces | Create a Workspace | POST /organizations/:organization_name/workspaces | workspaces.create | True | https://www.terraform.io/docs/cloud/api/workspaces.html#create-a-workspace |
| Workspaces | Update a Workspace | PATCH /workspaces/:workspace_id | workspaces.update | True | https://www.terraform.io/docs/cloud/api/workspaces.html#update-a-workspace |
| Workspaces | Update a Workspace | PATCH /organizations/:organization_name/workspaces/:name | workspaces.update | True | https://www.terraform.io/docs/cloud/api/workspaces.html#update-a-workspace |
| Workspaces | List workspaces | GET /organizations/:organization_name/workspaces | workspaces.list | True | https://www.terraform.io/docs/cloud/api/workspaces.html#list-workspaces |
| Workspaces | Show workspace | GET /workspaces/:workspace_id | workspaces.show | True | https://www.terraform.io/docs/cloud/api/workspaces.html#show-workspace |
| Workspaces | Show workspace | GET /organizations/:organization_name/workspaces/:name | workspaces.show | True | https://www.terraform.io/docs/cloud/api/workspaces.html#show-workspace |
| Workspaces | Delete a workspace | DELETE /workspaces/:workspace_id | workspaces.destroy | True | https://www.terraform.io/docs/cloud/api/workspaces.html#delete-a-workspace |
| Workspaces | Delete a workspace | DELETE /organizations/:organization_name/workspaces/:name | workspaces.destroy | True | https://www.terraform.io/docs/cloud/api/workspaces.html#delete-a-workspace |
| Workspaces | Lock a workspace | POST /workspaces/:workspace_id/actions/lock | workspaces.lock | True | https://www.terraform.io/docs/cloud/api/workspaces.html#lock-a-workspace |
| Workspaces | Unlock a workspace | POST /workspaces/:workspace_id/actions/unlock | workspaces.unlock | True | https://www.terraform.io/docs/cloud/api/workspaces.html#unlock-a-workspace |
| Workspaces | Force Unlock a workspace | POST /workspaces/:workspace_id/actions/force-unlock | workspaces.force_unlock | True | https://www.terraform.io/docs/cloud/api/workspaces.html#force-unlock-a-workspace |
| Workspaces | Assign an SSH key to a workspace | PATCH /workspaces/:workspace_id/relationships/ssh-key | workspaces.assign_ssh_key | True | https://www.terraform.io/docs/cloud/api/workspaces.html#assign-an-ssh-key-to-a-workspace |
| Workspaces | Unassign an SSH key from a workspace | PATCH /workspaces/:workspace_id/relationships/ssh-key | workspaces.assign_ssh_key | True | https://www.terraform.io/docs/cloud/api/workspaces.html#unassign-an-ssh-key-from-a-workspace |
Contents¶
- Account
- Admin Runs
- Admin Orgs
- Admin Users
- Admin Settings
- Admin Terraform Versions
- Admin Workspaces
- Agents
- Agent Tokens
- Applies
- Audit Trails
- Config Versions
- Cost Estimates
- IP Ranges
- Notification Configurations
- OAuth Clients
- OAuth Tokens
- Orgs
- Org Memberships
- Org Tokens
- Plan Exports
- Plans
- Policies
- Policy Checks
- Policy Sets
- Policy Set Params
- Registry Modules
- Runs
- Run Triggers
- SSH Keys
- State Versions
- State Version Outputs
- Team Access
- Team Memberships
- Team Tokens
- Teams
- User Tokens
- Users
- Vars
- Workspace Variables
- Workspaces