Registry Modules

class terrasnek.registry_modules.TFCRegistryModules(instance_url, org_name, headers, well_known_paths, verify, log_level)

Registry Modules API Docs (Private Registry)

Registry Modules API Docs (Public Registry)

create(payload)

POST /organizations/:organization_name/registry-modules

Registry Modules Create API Doc Reference

Create Sample Payload

create_version(module_name, provider, payload, reg_name='private')

POST /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider/versions

Registry Modules Create Version API Doc Reference

Create Version Sample Payload

destroy(module_name, reg_name='private', provider=None, version=None)

DELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider/:version DELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider DELETE /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name

NOTE: Deprecated POST /registry-modules/actions/delete/:organization_name/:name/:provider/:version POST /registry-modules/actions/delete/:organization_name/:name/:provider POST /registry-modules/actions/delete/:organization_name/:name

Registry Modules Destroy API Doc Reference

download_latest_source(name, provider, target_path)

GET <base_url>/:namespace/:name/:provider/download

Registry Modules Download Latest Source API Doc Reference

download_version_source(name, provider, version, target_path)

GET <base_url>/:namespace/:name/:provider/:version/download

Registry Modules Download Version Source API Doc Reference

get(name, provider, version)

GET <base_url>/:namespace/:name/:provider/:version

Registry Modules Get API Doc Reference

list(offset=None, page=None, page_size=None, limit=None, provider=None, verified=None, filters=None)

GET /organizations/:organization_name/registry-modules

Registry Modules List API Doc Reference

Query Parameter(s) Details

list_all()

This function does not correlate to an endpoint in the TFC API Docs specifically, but rather is a helper function to wrap the list endpoint, which enumerates out every page so users do not have to implement the paging logic every time they just want to list every audit trail in an organization.

Returns an object with two arrays of objects.

list_latest_version_all_providers(name, offset=None, limit=None)

GET <base_url>/:namespace/:name

Registry Modules List Latest Version All Providers API Doc Reference

list_latest_version_specific_provider(name, provider)

GET <base_url>/:namespace/:name/:provider

Registry Modules List Latest Version Specific Provider API Doc Reference

list_versions(name, provider)

GET <base_url>/:namespace/:name/:provider/versions

Registry Modules List Versions API Doc Reference

publish_from_vcs(payload)

POST /organizations/:organization_name/registry-modules/vcs

Registry Modules Publish a Private Module From VCS API Doc Reference

Publish From VCS Sample Payload

required_entitlements()

Terraform Cloud Entitlements required for endpoint to work.

search(query, offset=None, limit=None, provider=None, verified=None)

GET <base_url>/search

Registry Modules Search API Doc Reference

show(module_name, provider, reg_name='private')

GET /organizations/:organization_name/registry-modules/:registry_name/:namespace/:name/:provider

NOTE: Deprecated GET /registry-modules/show/:organization_name/:name/:provider

Registry Modules Show API Doc Reference

terraform_cloud_only()

Return True if this endpoint is only for Terraform Cloud, else False.

terraform_enterprise_only()

Return True if this endpoint is only for Terraform Enterprise, else False.

upload_version(path_to_tarball, upload_url)

PUT https://archivist.terraform.io/v1/object/<UNIQUE OBJECT ID>

Registry Modules Upload Version API Doc Reference