GPG Keys

class terrasnek.gpg_keys.TFCGPGKeys(instance_url, org_name, headers, well_known_paths, verify, log_level)

GPG Keys API Docs

create(payload)

POST /api/registry/:registry_name/v2/gpg-keys

GPG Keys Create API Doc Reference

destroy(key_id)

DELETE /api/registry/:registry_name/v2/gpg-keys/:namespace/:key_id

GPG Keys Destroy API Doc Reference

list(page=None, page_size=None, filters=None)

GET /api/registry/:registry_name/v2/gpg-keys

GPG Keys List API Doc Reference

Query Parameter(s) Details

list_all(filters=None)

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 workspace in an organization.

Returns an object with two arrays of objects.

required_entitlements()

Terraform Cloud Entitlements required for endpoint to work.

show(key_id)

GET /api/registry/:registry_name/v2/gpg-keys/:namespace/:key_id

GPG Keys 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.

update(key_id, payload=None)

PATCH /api/registry/:registry_name/v2/gpg-keys/:namespace/:key_id

GPG Keys Update API Doc Reference

Update Sample Payload