1. Docs
  2. Reference
  3. REST API Docs
  4. Resource Search

Resource Search

    Resource Search lets you find and filter resources managed by Pulumi across your organization. The Resource Search API allows you to query resources using structured filters and retrieve detailed resource metadata.

    Get Org Resource Search Query

    ▼
    Deprecated. Use GetOrgResourceSearchV2Query instead.
    GET /api/orgs/{orgName}/search/resources

    Searches for resources within an organization. Deprecated: use GetOrgResourceSearchV2Query for improved search functionality.

    Request Parameters

    • orgName string path required
      The organization name
    • collapse boolean query optional
      Collapse results to show one entry per stack instead of per resource
    • cursor string query optional
      Cursor for paginated results
    • facet array query optional
      Facet filters to apply
    • groupBy string query optional
      Group results by this field
    • page integer query optional
      Page number for pagination
    • properties boolean query optional
      Include resource properties in search results (may increase response size)
    • query string query optional
      Search query string
    • size integer query optional
      Number of results to return
    • sort array query optional
      Sort order for results
    • top integer query optional
      Number of top aggregation buckets to return

    Responses

    200 OK
    Schema: ResourceSearchResult
    • total integer optional
      The total number of matching resources.
    • resources array[ResourceResult] optional
      The list of matching resource results.
    • ↳ created string optional
      The ISO 8601 timestamp when the resource was first indexed.
    • ↳ custom boolean optional
      Whether this is a custom resource managed by a provider plugin.
    • ↳ delete boolean optional
      Whether this resource is pending deletion.
    • ↳ dependencies array[string] optional
      URNs of resources that this resource depends on.
    • ↳ external boolean optional
      Whether the lifecycle of this resource is not managed by Pulumi.
    • ↳ id string optional
      The provider-assigned resource ID.
    • ↳ matches map[string]array optional
      Matched search terms mapped to their highlighted values.
    • ↳ modified string optional
      The ISO 8601 timestamp when the resource was last updated in the index.
    • ↳ module string required
      The module that contains this resource.
    • ↳ name string optional
      The name of the resource.
    • ↳ package string required
      The package that provides this resource.
    • ↳ parent_urn string optional
      The URN of the parent resource, if any.
    • ↳ pending string optional
      The pending operation on this resource, if any (e.g. creating, updating, deleting).
    • ↳ project string optional
      The project that contains this resource.
    • ↳ protected boolean optional
      Whether this resource is protected from deletion.
    • ↳ provider_urn string optional
      The URN of the provider for this resource.
    • ↳ stack string optional
      The stack that contains this resource.
    • ↳ type string optional
      The full type token of the resource (e.g. aws:s3/bucket:Bucket).
    • ↳ urn string optional
      The URN uniquely identifying this resource within a stack.
    • ↳ teams array[string] optional
      The teams that have access to this resource.
    • ↳ properties object optional
      The resource’s input/output properties as a JSON object. Only populated when explicitly requested.
    • ↳ metadata object optional
      Additional metadata associated with the resource.
    • ↳ category string optional
      The category of the resource.
    • ↳ account string optional
      The Insights account name that discovered or manages this resource.
    • ↳ dependents array[string] optional
      URNs of resources that depend on this resource.
    • ↳ managed string optional
      Whether this resource is managed by Pulumi IaC stacks or discovered by Insights scanning. One of ‘managed’ or ‘discovered’.
    • ↳ fingerprint string optional
      A fingerprint uniquely identifying this resource’s state.
    • ↳ sourceCount integer optional
      The number of sources for this resource.
    • aggregations map[string]Aggregation optional
      Aggregation buckets for faceted search.
    • pagination ResourceSearchPagination optional
      Pagination links for navigating through results.
    • ↳ previous string optional
      Link to the previous page of results.
    • ↳ next string optional
      Link to the next page of results.
    • ↳ cursor string optional
      An opaque cursor for resuming pagination.
    Errors: 400 invalid groupBy field 422 search cluster is unreachable

    Get Resource Dashboard Aggregations

    ▼
    GET /api/orgs/{orgName}/search/resources/dashboard

    GetResourceDashboardAggregations returns aggregated resource data for display on organization dashboard cards, including resource counts grouped by package and other dimensions.

    Request Parameters

    • orgName string path required
      The organization name

    Responses

    200 OK
    Schema: ResourceSearchResult
    • total integer optional
      The total number of matching resources.
    • resources array[ResourceResult] optional
      The list of matching resource results.
    • ↳ created string optional
      The ISO 8601 timestamp when the resource was first indexed.
    • ↳ custom boolean optional
      Whether this is a custom resource managed by a provider plugin.
    • ↳ delete boolean optional
      Whether this resource is pending deletion.
    • ↳ dependencies array[string] optional
      URNs of resources that this resource depends on.
    • ↳ external boolean optional
      Whether the lifecycle of this resource is not managed by Pulumi.
    • ↳ id string optional
      The provider-assigned resource ID.
    • ↳ matches map[string]array optional
      Matched search terms mapped to their highlighted values.
    • ↳ modified string optional
      The ISO 8601 timestamp when the resource was last updated in the index.
    • ↳ module string required
      The module that contains this resource.
    • ↳ name string optional
      The name of the resource.
    • ↳ package string required
      The package that provides this resource.
    • ↳ parent_urn string optional
      The URN of the parent resource, if any.
    • ↳ pending string optional
      The pending operation on this resource, if any (e.g. creating, updating, deleting).
    • ↳ project string optional
      The project that contains this resource.
    • ↳ protected boolean optional
      Whether this resource is protected from deletion.
    • ↳ provider_urn string optional
      The URN of the provider for this resource.
    • ↳ stack string optional
      The stack that contains this resource.
    • ↳ type string optional
      The full type token of the resource (e.g. aws:s3/bucket:Bucket).
    • ↳ urn string optional
      The URN uniquely identifying this resource within a stack.
    • ↳ teams array[string] optional
      The teams that have access to this resource.
    • ↳ properties object optional
      The resource’s input/output properties as a JSON object. Only populated when explicitly requested.
    • ↳ metadata object optional
      Additional metadata associated with the resource.
    • ↳ category string optional
      The category of the resource.
    • ↳ account string optional
      The Insights account name that discovered or manages this resource.
    • ↳ dependents array[string] optional
      URNs of resources that depend on this resource.
    • ↳ managed string optional
      Whether this resource is managed by Pulumi IaC stacks or discovered by Insights scanning. One of ‘managed’ or ‘discovered’.
    • ↳ fingerprint string optional
      A fingerprint uniquely identifying this resource’s state.
    • ↳ sourceCount integer optional
      The number of sources for this resource.
    • aggregations map[string]Aggregation optional
      Aggregation buckets for faceted search.
    • pagination ResourceSearchPagination optional
      Pagination links for navigating through results.
    • ↳ previous string optional
      Link to the previous page of results.
    • ↳ next string optional
      Link to the next page of results.
    • ↳ cursor string optional
      An opaque cursor for resuming pagination.
    Errors: 404 Organization not found 422 search cluster is unreachable

    Get Natural Language Query

    ▼
    GET /api/orgs/{orgName}/search/resources/parse

    GetNaturalLanguageQuery converts a natural language query into a structured Pulumi search query using AI. For example, converts ‘show me all S3 buckets in production’ into a proper search syntax.

    Request Parameters

    • orgName string path required
      The organization name
    • query string query optional
      Search query string

    Responses

    200 OK
    Schema: GetNaturalLanguageQueryResponse
    • query string required
      The translated query string
    Errors: 400 please provide a query 402 AI assist feature requires Enterprise subscription 404 NLP search feature not enabled 503 AI services are temporarily unavailable

    Get Org Resource Search V2Query

    ▼
    GET /api/orgs/{orgName}/search/resourcesv2

    Searches for resources within an organization with advanced filtering, sorting, and pagination capabilities.

    Pagination: The page parameter supports up to 10,000 results. For larger result sets, use the cursor parameter instead (Enterprise plans only). Note that pagination is not transactional — result ordering may change if a stack update completes during pagination.

    Sorting: The sort parameter accepts: created, custom, delete, dependencies, id, modified, module, name, package, parentUrn, project, protected, providerUrn, stack, type, urn, managed, category. If omitted, results are sorted by search relevance (or last modified time when no query is provided).

    Properties: Set properties=true to include resource input/output values. Requires a supported subscription — returns 402 if not available.

    Collapse: Set collapse=true to consolidate resources that exist in multiple sources (e.g., both IaC stacks and Insights scans) into a single result.

    Request Parameters

    • orgName string path required
      The organization name
    • asc boolean query optional
      Sort in ascending order when true, descending when false
    • collapse boolean query optional
      Collapse results to show one entry per stack instead of per resource
    • cursor string query optional
      Cursor for paginated results
    • facet array query optional
      Facet filters to apply
    • groupBy string query optional
      Group results by this field
    • page integer query optional
      Page number for pagination
    • properties boolean query optional
      Include resource properties in search results (may increase response size)
    • query string query optional
      Search query string
    • size integer query optional
      Number of results to return
    • sort array query optional
      Sort order for results
    • top integer query optional
      Number of top aggregation buckets to return

    Responses

    200 OK
    Schema: ResourceSearchResult
    • total integer optional
      The total number of matching resources.
    • resources array[ResourceResult] optional
      The list of matching resource results.
    • ↳ created string optional
      The ISO 8601 timestamp when the resource was first indexed.
    • ↳ custom boolean optional
      Whether this is a custom resource managed by a provider plugin.
    • ↳ delete boolean optional
      Whether this resource is pending deletion.
    • ↳ dependencies array[string] optional
      URNs of resources that this resource depends on.
    • ↳ external boolean optional
      Whether the lifecycle of this resource is not managed by Pulumi.
    • ↳ id string optional
      The provider-assigned resource ID.
    • ↳ matches map[string]array optional
      Matched search terms mapped to their highlighted values.
    • ↳ modified string optional
      The ISO 8601 timestamp when the resource was last updated in the index.
    • ↳ module string required
      The module that contains this resource.
    • ↳ name string optional
      The name of the resource.
    • ↳ package string required
      The package that provides this resource.
    • ↳ parent_urn string optional
      The URN of the parent resource, if any.
    • ↳ pending string optional
      The pending operation on this resource, if any (e.g. creating, updating, deleting).
    • ↳ project string optional
      The project that contains this resource.
    • ↳ protected boolean optional
      Whether this resource is protected from deletion.
    • ↳ provider_urn string optional
      The URN of the provider for this resource.
    • ↳ stack string optional
      The stack that contains this resource.
    • ↳ type string optional
      The full type token of the resource (e.g. aws:s3/bucket:Bucket).
    • ↳ urn string optional
      The URN uniquely identifying this resource within a stack.
    • ↳ teams array[string] optional
      The teams that have access to this resource.
    • ↳ properties object optional
      The resource’s input/output properties as a JSON object. Only populated when explicitly requested.
    • ↳ metadata object optional
      Additional metadata associated with the resource.
    • ↳ category string optional
      The category of the resource.
    • ↳ account string optional
      The Insights account name that discovered or manages this resource.
    • ↳ dependents array[string] optional
      URNs of resources that depend on this resource.
    • ↳ managed string optional
      Whether this resource is managed by Pulumi IaC stacks or discovered by Insights scanning. One of ‘managed’ or ‘discovered’.
    • ↳ fingerprint string optional
      A fingerprint uniquely identifying this resource’s state.
    • ↳ sourceCount integer optional
      The number of sources for this resource.
    • aggregations map[string]Aggregation optional
      Aggregation buckets for faceted search.
    • pagination ResourceSearchPagination optional
      Pagination links for navigating through results.
    • ↳ previous string optional
      Link to the previous page of results.
    • ↳ next string optional
      Link to the next page of results.
    • ↳ cursor string optional
      An opaque cursor for resuming pagination.
    Errors: 400 invalid groupBy field 422 search cluster is unreachable