HashiConf 2025 Don't miss the live stream of HashiConf Day 2 happening now View live stream
HashiCorp Cloud Platform
HashiCorp Cloud Platform

GraphQueryService_ListNodeInventory

get

/infragraph/organizations/{location.organization_id}/inventory/nodes

GraphQueryService_ListNodeInventory

https://api.cloud.hashicorp.com/infragraph/2025-05-07/organizations/{location.organization_id}/inventory/nodes

Request

Path Parameters
location.organization_idstring
Required

organization_id is the id of the organization.

Query Parameters
location.project_idstring

project_id is the projects id.

pagination.page_sizeinteger

page_size specifies the max number of results per page that should be returned. If unspecified or set to 0, a default page size will be used. Returned pages may be smaller than the requested page size, but will never be larger.

pagination.next_page_tokenstring

next_page_token is the token to retrieve the next page of results. It should be set to the value of next_page_token provided in a prior response. The encoding scheme is opaque to clients and may change at any time.

source_typesstring[]

source_types filters returned node inventory by source type (e.g. "AWS_EC2_INSTANCE"). This field is optional. If left unset, all types will be included. Repeated values are ORed together. This field is mutually exclusive with sources and unified_types.

sourcesstring[]

sources filters node inventory by their data source (e.g. "AWS", "GCP", "HCP_TERRAFORM"). This field is optional. If left unset, all sources will be included. Repeated values are ORed together. If unified_types is also provided, both fields are applied as an intersecting subset. This field is mutually exclusive with source_types.

unified_typesstring[]

unified_types filters node inventory by their unified type (e.g. "VIRTUAL_MACHINE"). This field is optional. If left unset, all types will be included. Repeated values are ORed together. If sources is also provided, both fields are applied as an intersecting subset. This field is mutually exclusive with source_types. This field also supports the universal base type ("BASE").

Response

200 - OK
inventoryobject[]
  • node_countstring
  • unified_typestring

    unified_type is the union/generic type of the node (e.g. "VIRTUAL_MACHINE").

  • source_typestring

    source_type is the native resource type of the node (e.g. "AWS_EC2_INSTANCE").

paginationobject

PaginationResponse contains pagination information for a response.

  • next_page_tokenstring

    next_page_token is the token to retrieve the next page of results. If there are no more results, this field will be empty.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring