Skip to main content
Pulumi logo Pulumi logo
  1. Docs
  2. Reference
  3. REST API Docs
  4. Schema
  5. GraphQueryResponse

GraphQueryResponse

    The subgraph selected by a graph query: nodes, typed edges, optional evidence paths, optional aggregation buckets, and result metadata. Process pages cumulatively: an edge or path may reference a node returned on an earlier page.

    Properties

    • nodes array[GraphNode] required
      This page’s slice of the selected nodes (id-ordered), from the frontiers named in return.select plus any nodes referenced by returned paths.
    • id string required
      Stable node identifier: the Pulumi URN for IaC resources, the Insights URN for discovered resources, or ‘stack://’ for stacks. A stack’s id is not the spelling a selector uses: scope.stacks and a stack anchor’s name predicate both take the org-free ‘project/stack’ form, and both reject the org-qualified form.
    • nodeType enum required
      The node type.
      Values: resource, stack
    • frontier array[string] required
      Names of the selected frontiers this node belongs to (‘anchor’ or traversal step aliases).
    • urn string optional
      The resource URN. Absent for stack nodes.
    • type string optional
      The resource type token. Absent for stack nodes.
    • stack string optional
      The Pulumi stack this node belongs to, or that it represents for a stack node. Absent on a resource discovered by a cloud scan.
    • project string optional
      The Pulumi project this node belongs to, or that it represents for a stack node. Absent on a resource discovered by a cloud scan.
    • account string optional
      The Insights account a discovered resource was found in, as the complete account name including any ‘/’-separated hierarchy.
    • fields map[string]string optional
      Additional projected fields requested via return.fields, plus engine-provided provenance fields where available.
    • fieldsUnavailable boolean optional
      True when this node carries no indexed document, so none of the fields requested in return.fields could be evaluated on it. Absent unless return.fields was requested.
    • edges array[GraphEdge] required
      The typed edges revealed by this page: every edge whose higher-id endpoint first appears on this page. Both endpoints are among the nodes returned by this page or an earlier one — process pages cumulatively. A drain over changing data may not be complete.
    • id string required
      Stable edge identifier, unique within the response.
    • from string required
      The source node id.
    • to string required
      The destination node id.
    • type string required
      The edge type, for example ‘provided_by’ or ‘inferred_reference’.
    • paths array[GraphPath] optional
      Evidence paths showing how the query reached its results. Present only when return.paths is true. One path per node of the final traversal frontier, not necessarily the shortest route.
    • nodes array[string] required
      Node ids along the path, in traversal order. Every id named here is present among the response’s nodes once the page containing it has been retrieved.
    • edges array[string] required
      Edge ids along the path, in traversal order. One fewer entry than nodes.
    • aggregations GraphAggregations required
      Aggregation buckets. Empty unless the query included an aggregate clause.
    • buckets array[GraphAggregationBucket] required
      The aggregation buckets.
    • pageInfo GraphPageInfo required
      Result-set pagination information.
    • continuationToken string optional
      Opaque keyset token for the next page, omitted rather than null when no pages remain. Pass it back as page.continuationToken.
    • resultCount integer required
      The number of nodes (or aggregation buckets) returned on this page.
    • meta GraphQueryMeta required
      Result metadata, including whether anything clipped the underlying result.
    • resultMode enum required
      Result fidelity: whether an engine cap or a partial search-backend response clipped the underlying result. Treat ’truncated’ as disqualifying for any question whose answer depends on completeness, such as an absence check.
      Values: exact, truncated
    • schemaVersion string required
      The dated revision of the graph contract this query was evaluated against, for example ‘2026-07-29’. While the graph query API is in preview the contract can change.
    • visibility enum optional
      Whether the caller’s permissions limited what the traversal could see. Always present for traversal queries; absent for aggregations, which are always scoped to the caller’s permissions. Anchor selection is likewise caller-scoped and not reported here. Independent of resultMode, which reports engine-side clipping.
      Values: complete, trimmed

      The infrastructure as code platform for any cloud.