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

SchemaService_ListNodeSchemas

get

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

SchemaService_ListNodeSchemas

https://api.cloud.hashicorp.com/infragraph/2025-05-07/organizations/{location.organization_id}/schema/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

The max number of results per page that should be returned. If the number of available results is larger than page_size, a next_page_token is returned which can be used to get the next page of results in subsequent requests. A value of zero will cause page_size to be defaulted.

pagination.next_page_tokenstring

Specifies a page token to use to retrieve the next page. Set this to the next_page_token returned by previous list requests to get the next page of results. If set, previous_page_token must not be set.

pagination.previous_page_tokenstring

Specifies a page token to use to retrieve the previous page. Set this to the previous_page_token returned by previous list requests to get the previous page of results. If set, next_page_token must not be set.

source_typesstring[]

source_types filters returned node schemas 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 schemas 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 schemas 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").

include_unified_typesboolean

include_unified_types indicates whether node schemas for unified types (including the universal base type) should be included in returned node schemas. If set to false, only source type node schemas will be returned. If set to true, the response expands the already-matched source-backed node schemas with any unified-only parent types they reference, plus BASE. Defaults to false.

include_propertiesboolean

include_properties indicates whether node property schemas should be included in returned node schemas. Defaults to false.

Response

200 - OK
nodesobject[]

NodeSchema represents the basic description of a given node type and its properties.

  • nodeobject

    NodeDescriptor describes a node by its source, source type, and unified type.

    • 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.

    • 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.

    • 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.

  • propertiesobject[]

    PropertySchema represents the schema of a node property.

    • namestring

      name indicates the name of the property.

    • typestring

      PropertyType enumerates the data types a schema property can have. Used by the schema codegen plugin (protoc-gen-go-domain) to generate a typed schema registry.

    • inherited_fromstring

      inherited_from indicates the node type that this property is inherited from. If the property is not inherited, this field will be left blank. Otherwise, this field will be set to a unified type (e.g. "VIRTUAL_MACHINE") or the universal base type ("BASE"), which indicates a property that is common to all types.

paginationobject

PaginationResponse is the response holding the page tokens for a paginated list response.

  • next_page_tokenstring

    This token allows you to get the next page of results for list requests. If the number of results is larger than page_size, use the next_page_token as a value for the query parameter next_page_token in the next request. The value will become empty when there are no more pages.

  • previous_page_tokenstring

    This token allows you to get the previous page of results for list requests. If the number of results is larger than page_size, use the previous_page_token as a value for the query parameter previous_page_token in the next request. The value will become empty when there are no more pages.

Default Error Response
codeinteger
messagestring
detailsobject[]
  • @typestring