1. Registry
  2. Packages
  3. Harness Provider
  4. API Docs
  5. platform
  6. getDashboardFolders
Viewing docs for Harness v0.16.5
published on Saturday, Sep 12, 2026 by Pulumi
harness logo
Viewing docs for Harness v0.16.5
published on Saturday, Sep 12, 2026 by Pulumi

    Data source for retrieving a list of Harness Custom Dashboard Folders.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as harness from "@pulumi/harness";
    
    const all = harness.platform.getDashboardFolders({});
    // Or filter by name
    const filtered = harness.platform.getDashboardFolders({
        name: "my-folder",
    });
    
    import pulumi
    import pulumi_harness as harness
    
    all = harness.platform.get_dashboard_folders()
    # Or filter by name
    filtered = harness.platform.get_dashboard_folders(name="my-folder")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-harness/sdk/go/harness/platform"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := platform.LookupDashboardFolders(ctx, &platform.LookupDashboardFoldersArgs{}, nil)
    		if err != nil {
    			return err
    		}
    		// Or filter by name
    		_, err = platform.LookupDashboardFolders(ctx, &platform.LookupDashboardFoldersArgs{
    			Name: pulumi.StringRef("my-folder"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Harness = Pulumi.Harness;
    
    return await Deployment.RunAsync(() => 
    {
        var all = Harness.Platform.GetDashboardFolders.Invoke();
    
        // Or filter by name
        var filtered = Harness.Platform.GetDashboardFolders.Invoke(new()
        {
            Name = "my-folder",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.harness.platform.PlatformFunctions;
    import com.pulumi.harness.platform.inputs.GetDashboardFoldersArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var all = PlatformFunctions.getDashboardFolders(GetDashboardFoldersArgs.builder()
                .build());
    
            // Or filter by name
            final var filtered = PlatformFunctions.getDashboardFolders(GetDashboardFoldersArgs.builder()
                .name("my-folder")
                .build());
    
        }
    }
    
    variables:
      all:
        fn::invoke:
          function: harness:platform:getDashboardFolders
          arguments: {}
      # Or filter by name
      filtered:
        fn::invoke:
          function: harness:platform:getDashboardFolders
          arguments:
            name: my-folder
    
    pulumi {
      required_providers {
        harness = {
          source = "pulumi/harness"
        }
      }
    }
    
    data "harness_platform_getdashboardfolders" "all" {
    }
    data "harness_platform_getdashboardfolders" "filtered" {
      name = "my-folder"
    }
    
    # Or filter by name
    

    Using getDashboardFolders

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDashboardFolders(args: GetDashboardFoldersArgs, opts?: InvokeOptions): Promise<GetDashboardFoldersResult>
    function getDashboardFoldersOutput(args: GetDashboardFoldersOutputArgs, opts?: InvokeOutputOptions): Output<GetDashboardFoldersResult>
    def get_dashboard_folders(name: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetDashboardFoldersResult
    def get_dashboard_folders_output(name: pulumi.Input[Optional[str]] = None,
                              opts: Optional[InvokeOutputOptions] = None) -> Output[GetDashboardFoldersResult]
    func LookupDashboardFolders(ctx *Context, args *LookupDashboardFoldersArgs, opts ...InvokeOption) (*LookupDashboardFoldersResult, error)
    func LookupDashboardFoldersOutput(ctx *Context, args *LookupDashboardFoldersOutputArgs, opts ...InvokeOption) LookupDashboardFoldersResultOutput

    > Note: This function is named LookupDashboardFolders in the Go SDK.

    public static class GetDashboardFolders 
    {
        public static Task<GetDashboardFoldersResult> InvokeAsync(GetDashboardFoldersArgs args, InvokeOptions? opts = null)
        public static Output<GetDashboardFoldersResult> Invoke(GetDashboardFoldersInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetDashboardFoldersResult> Invoke(GetDashboardFoldersInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetDashboardFoldersResult> getDashboardFolders(GetDashboardFoldersArgs args, InvokeOptions options)
    public static Output<GetDashboardFoldersResult> getDashboardFolders(GetDashboardFoldersArgs args, InvokeOptions options)
    public static Output<GetDashboardFoldersResult> getDashboardFolders(GetDashboardFoldersArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: harness:platform/getDashboardFolders:getDashboardFolders
      arguments:
        # arguments dictionary
    data "harness_platform_get_dashboard_folders" "name" {
        # arguments
    }

    The following arguments are supported:

    Name string
    Name of a specific folder to filter the list by (optional).
    Name string
    Name of a specific folder to filter the list by (optional).
    name string
    Name of a specific folder to filter the list by (optional).
    name String
    Name of a specific folder to filter the list by (optional).
    name string
    Name of a specific folder to filter the list by (optional).
    name str
    Name of a specific folder to filter the list by (optional).
    name String
    Name of a specific folder to filter the list by (optional).

    getDashboardFolders Result

    The following output properties are available:

    Folders List<GetDashboardFoldersFolder>
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of a specific folder to filter the list by (optional).
    Folders []GetDashboardFoldersFolder
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    Name of a specific folder to filter the list by (optional).
    folders list(object)
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of a specific folder to filter the list by (optional).
    folders List<GetDashboardFoldersFolder>
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of a specific folder to filter the list by (optional).
    folders GetDashboardFoldersFolder[]
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    Name of a specific folder to filter the list by (optional).
    folders Sequence[GetDashboardFoldersFolder]
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    Name of a specific folder to filter the list by (optional).
    folders List<Property Map>
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    Name of a specific folder to filter the list by (optional).

    Supporting Types

    GetDashboardFoldersFolder

    CreatedAt string
    Created DateTime of the folder.
    Id string
    Identifier of the folder.
    Name string
    Name of the folder.
    CreatedAt string
    Created DateTime of the folder.
    Id string
    Identifier of the folder.
    Name string
    Name of the folder.
    created_at string
    Created DateTime of the folder.
    id string
    Identifier of the folder.
    name string
    Name of the folder.
    createdAt String
    Created DateTime of the folder.
    id String
    Identifier of the folder.
    name String
    Name of the folder.
    createdAt string
    Created DateTime of the folder.
    id string
    Identifier of the folder.
    name string
    Name of the folder.
    created_at str
    Created DateTime of the folder.
    id str
    Identifier of the folder.
    name str
    Name of the folder.
    createdAt String
    Created DateTime of the folder.
    id String
    Identifier of the folder.
    name String
    Name of the folder.

    Package Details

    Repository
    harness pulumi/pulumi-harness
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the harness Terraform Provider.
    harness logo
    Viewing docs for Harness v0.16.5
    published on Saturday, Sep 12, 2026 by Pulumi

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial