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

GraphQueryService_ListEdgeInventory

get

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

GraphQueryService_ListEdgeInventory

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

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.

origin_node.sourcestring

source is the data source of the node (e.g. "AWS", "GCP", "HCP_TERRAFORM"). If empty, the schema contract is not limited to a single source.

origin_node.source_typestring

source_type is the source-specific type of the node (e.g. "AWS_EC2_INSTANCE"). If empty, the schema contract is not limited to a single concrete source type.

origin_node.unified_typestring

unified_type is the unified type of the node (e.g. "VIRTUAL_MACHINE"). If empty, the schema contract does not guarantee a single generalized type.

edge_typestring

edge_type specifies the type of the edge (e.g. "MANAGES"). This field is optional. If omitted, all possible edge types will be returned.

destination_node.sourcestring

source is the data source of the node (e.g. "AWS", "GCP", "HCP_TERRAFORM"). If empty, the schema contract is not limited to a single source.

destination_node.source_typestring

source_type is the source-specific type of the node (e.g. "AWS_EC2_INSTANCE"). If empty, the schema contract is not limited to a single concrete source type.

destination_node.unified_typestring

unified_type is the unified type of the node (e.g. "VIRTUAL_MACHINE"). If empty, the schema contract does not guarantee a single generalized type.

Response

200 - OK
inventoryobject[]
  • edge_typestring

    edge_type specifies the type of the edge(e.g. "MANAGES").

  • edge_countstring

    edge_count is the number of edges that have the above edge type.

  • origin_nodestring
  • destination_nodestring
  • originobject

    EdgeTerminus represents the general kinds of nodes an edge type may be attached to.

    • sourcestring
    • unified_typestring
    • source_typestring
  • destinationobject

    EdgeTerminus represents the general kinds of nodes an edge type may be attached to.

    • sourcestring
    • unified_typestring
    • source_typestring
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