List terraform module usage

get

https://{Domain}/api/iacp/v3/reports/module-usage

This endpoint lists terraform module usage.

Query Params

query

string

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.

format

string

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

filter[workspace]

string

The workspace ID to list modules usage for.

sort

array of strings

The comma-separated list of attributes.

sort

fields

object

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.

include

array of strings

The comma-separated list of relationship paths.

include

filter[environment]

string

The environment ID to list modules usage for.

Headers

string

enum

Defaults to application/vnd.api+json

Generated from available response content types

Allowed:

Responses

403

User unauthorized to perform this action.

4XX

Client error.

5XX

Server error.

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/vnd.api+json

text/csv

200Success.