terrasnek to Terraform Cloud API Completeness

This page offers a comparison of what endpoints are implemented and usable with terrasnek, compared to the published Terraform Cloud endpoints.

# terrasnek API Coverage Completeness

Policy Checks Show Policy Check GET /policy-checks/:id False https://www.terraform.io/docs/cloud/api/policy-checks.html#show-policy-check Policy Checks Override Policy POST /policy-checks/:id/actions/override False https://www.terraform.io/docs/cloud/api/policy-checks.html#override-policy >>>>>>> Updating the API comparison table. 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 <<<<<<< HEAD Subscriptions Show Subscription For Organization GET /organizations/:organization_name/subscription subscriptions.show True https://www.terraform.io/docs/cloud/api/subscriptions.html#show-subscription-for-organization Subscriptions Show Subscription By ID GET /subscriptions/:id subscriptions.show_by_id True https://www.terraform.io/docs/cloud/api/subscriptions.html#show-subscription-by-id ======= Subscriptions Show Subscription For Organization GET /organizations/:organization_name/subscription False https://www.terraform.io/docs/cloud/api/subscriptions.html#show-subscription-for-organization Subscriptions Show Subscription By ID GET /subscriptions/:id False https://www.terraform.io/docs/cloud/api/subscriptions.html#show-subscription-by-id >>>>>>> Updating the API comparison table. 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 ======================== ================================================= =================================================================================== =============================================== ============= ==============================================================================================================