v1

latestOpenAPI 3.0.0Apache 2.02026-07-24340250799.5 KB
terraform-resource-instances-usage

List terraform resource instances usage

This endpoint lists terraform resource instances usage.

get/reports/resource-usage

Query parameters

querystring

The search string. Supports search by external id or resource address.

page[number]string

Page number.

page[size]string

Page size.

filter[tf-resource-usage]string required

Filter by terraform resource usage.

filter[is-active]string

Filter by terraform resource usage status.

filter[is-duplicate]string

Filter duplicate resources usage.

formatstring

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

sortstring[]

The comma-separated list of attributes.

environmentsstring

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

runsstring

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

state-versionsstring

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

tf-resource-instance-usagesstring

The comma-separated list of fields to return in response for TerraformResourceInstanceUsage 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.

Response

Success.