API¶
-
class
terrasnek.api.TFC(api_token, url='https://app.terraform.io', verify=True, log_level=50, skip_version_check=False)¶ Super class for access to all TFC Endpoints.
-
get_entitlements()¶ Allows for the user to retrieve the entitlements to the API for the current org.
-
get_hostname()¶ Allows for the user to retrieve the hostname being hit from the API object.
-
get_org()¶ Allows for the user to retrieve the current org from the API object.
-
get_token()¶ Allows for the user to retrieve the token from the API object.
-
get_url()¶ Allows for the user to retrieve the URL being hit from the API object.
-
is_terraform_cloud()¶ Returns true if this API instance is configured for Terraform Cloud.
-
set_org(org_name)¶ Sets the organization to use for org specific endpoints. This method must be called for any non-admin endpoint to work.
-
set_token(token)¶ Allows for the user to change the token they are using on the fly if they need to change tokens.
-
well_known_paths()¶ Retrieve all the well known paths from the Terraform Cloud installation.
-
API Spec¶
- Account
- Admin Module Sharing
- Admin Runs
- Admin Orgs
- Admin Users
- Admin Settings
- Admin Terraform Versions
- Admin Workspaces
- Agents
- Agent Tokens
- Applies
- Assessment Results
- Audit Trails
- Comments
- Config Versions
- Cost Estimates
- Feature Sets
- GitHub Apps
- GPG Keys
- Invoices
- IP Ranges
- No Code Provisioning
- Notification Configurations
- OAuth Clients
- OAuth Tokens
- Orgs
- Org Memberships
- Org Tags
- Org Tokens
- Plan Exports
- Plans
- Policies
- Policy Checks
- Policy Sets
- Policy Set Params
- Projects
- Project Team Access
- Registry Modules
- Registry Providers
- Runs
- Run Tasks
- Run Tasks Integration
- Run Triggers
- SSH Keys
- State Versions
- State Version Outputs
- Subscriptions
- Team Access
- Team Memberships
- Team Tokens
- Teams
- User Tokens
- Users
- Variables
- Variable Sets
- VCS Events
- Workspace Variables
- Workspace Resources
- Workspaces