---
updatedAt: 2026-05-28T08:16:45.000Z
agentTools:
  projectIndex: https://docs.scalr.io/llms.txt
---

# List terraform provider usages

This endpoint lists terraform provider usages.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "TerraformProviderUsage": {
        "description": "Represents terraform provider usage instance.",
        "properties": {
          "attributes": {
            "properties": {
              "provider": {
                "type": "string"
              },
              "source": {
                "maxLength": 255,
                "type": "string"
              },
              "versions-used-count": {
                "type": "integer"
              },
              "workspaces-count": {
                "type": "integer"
              }
            },
            "required": [
              "provider",
              "source",
              "versions-used-count",
              "workspaces-count"
            ],
            "type": "object"
          },
          "id": {
            "readOnly": true,
            "type": "string"
          },
          "links": {
            "additionalProperties": {
              "type": "string"
            },
            "type": "object"
          },
          "type": {
            "enum": [
              "tf-provider-usages"
            ],
            "type": "string"
          }
        },
        "required": [
          "type",
          "attributes"
        ],
        "type": "object"
      },
      "TerraformProviderUsageListingDocument": {
        "description": "JSON:API Document Listing\n\nsee: https://jsonapi.org/format/#document-structure",
        "properties": {
          "data": {
            "items": {
              "$ref": "#/components/schemas/TerraformProviderUsage"
            },
            "type": "array"
          },
          "included": {
            "items": {
              "type": "object"
            },
            "readOnly": true,
            "type": "array"
          },
          "links": {
            "additionalProperties": {
              "type": "string"
            },
            "readOnly": true,
            "type": "object"
          },
          "meta": {
            "readOnly": true,
            "type": "object"
          }
        },
        "type": "object"
      }
    },
    "securitySchemes": {
      "API-Key": {
        "scheme": "bearer",
        "type": "http"
      }
    }
  },
  "info": {
    "description": "Scalr IACP API",
    "license": {
      "name": "Apache 2.0",
      "url": "https://www.apache.org/licenses/LICENSE-2.0"
    },
    "title": "Scalr IACP API",
    "version": "unversioned"
  },
  "openapi": "3.0.0",
  "paths": {
    "/reports/providers": {
      "get": {
        "description": "This endpoint lists terraform provider usages.",
        "operationId": "list_terraform_provider_usages",
        "parameters": [
          {
            "description": "Page number.",
            "in": "query",
            "name": "page[number]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Page size.",
            "in": "query",
            "name": "page[size]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Filter providers by source.",
            "in": "query",
            "name": "filter[source]",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Format of the response. It can be 'json' or 'csv'.",
            "in": "query",
            "name": "format",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "Query string",
            "in": "query",
            "name": "query",
            "required": false,
            "schema": {
              "type": "string"
            }
          },
          {
            "description": "The comma-separated list of attributes.",
            "explode": false,
            "in": "query",
            "name": "sort",
            "required": false,
            "schema": {
              "items": {
                "enum": [
                  "provider",
                  "source",
                  "versions-used-count",
                  "workspaces-count"
                ],
                "type": "string"
              },
              "type": "array"
            }
          },
          {
            "description": "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.",
            "explode": true,
            "in": "query",
            "name": "fields",
            "required": false,
            "schema": {
              "properties": {
                "tf-provider-usages": {
                  "description": "The comma-separated list of fields to return in response for TerraformProviderUsage resource.",
                  "type": "string"
                }
              },
              "type": "object"
            },
            "style": "deepObject"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/vnd.api+json": {
                "schema": {
                  "$ref": "#/components/schemas/TerraformProviderUsageListingDocument"
                }
              },
              "text/csv": {
                "schema": {
                  "format": "csv",
                  "type": "string"
                }
              }
            },
            "description": "Success."
          },
          "403": {
            "description": "User unauthorized to perform this action."
          },
          "4XX": {
            "description": "Client error."
          },
          "5XX": {
            "description": "Server error."
          }
        },
        "summary": "List terraform provider usages",
        "tags": [
          "terraform-provider-usage"
        ],
        "x-mcp-tool": true,
        "x-resource": "TerraformProviderUsage",
        "x-service": "tf-api"
      }
    }
  },
  "security": [
    {
      "API-Key": []
    }
  ],
  "servers": [
    {
      "url": "https://{Domain}/api/iacp/v3",
      "variables": {
        "Domain": {
          "default": "example.scalr.io",
          "description": "Domain where Scalr is hosted"
        }
      }
    }
  ]
}
```

# Sibling pages

* [List unique terraform provider sources](https://docs.scalr.io/scalr/reference/list_terraform_provider_sources.md)
* [Get provider usage](https://docs.scalr.io/scalr/reference/get_provider_usage.md)