v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB
terraform-module-versions-usage

List terraform module usage

This endpoint lists terraform module usage.

get/reports/module-usage

Query parameters

querystring

The search string. Supports search by workspace name.

page[number]string

Page number.

page[size]string

Page size.

filter[tf-module-usage]string required

Filter by terraform module usage.

filter[version]string

Filter modules usage by version.

formatstring

Format of the response. It can be 'json' or 'csv'.

filter[workspace]string

The workspace ID to list modules usage for.

sortstring[]

The comma-separated list of attributes.

environmentsstring

The comma-separated list of fields to return in response for Environment resource.

tf-module-version-usagesstring

The comma-separated list of fields to return in response for TerraformModuleVersionUsage resource.

workspacesstring

The comma-separated list of fields to return in response for Workspace resource.

The value of the fields[resource-type] parameter is a comma-separated list that refers to the name of the fields to be returned for the resource. An empty value indicates that no fields should be returned.

includestring[]

The comma-separated list of relationship paths.

filter[environment]string

The environment ID to list modules usage for.

Response

Success.