Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi IDP Pulumi Cloud Packages Tutorials
  1. Packages
  2. Checkly
  3. API Docs
  4. Dashboard
Checkly v2.3.0 published on Friday, Aug 1, 2025 by Checkly
checkly/pulumi-checkly

checkly.Dashboard

Explore with Pulumi AI

checkly logo
Checkly v2.3.0 published on Friday, Aug 1, 2025 by Checkly
checkly/pulumi-checkly

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as checkly from "@checkly/pulumi";

const dashboard1 = new checkly.Dashboard("dashboard_1", {
    customUrl: "checkly",
    customDomain: "status.example.com",
    logo: "https://www.checklyhq.com/logo.png",
    header: "Public dashboard",
    refreshRate: 60,
    paginate: false,
    paginationRate: 30,
    hideTags: false,
    width: "FULL",
    tags: ["production"],
});

    import pulumi
import pulumi_checkly as checkly

dashboard1 = checkly.Dashboard("dashboard_1",
    custom_url="checkly",
    custom_domain="status.example.com",
    logo="https://www.checklyhq.com/logo.png",
    header="Public dashboard",
    refresh_rate=60,
    paginate=False,
    pagination_rate=30,
    hide_tags=False,
    width="FULL",
    tags=["production"])

    package main

import (
	"github.com/checkly/pulumi-checkly/sdk/v2/go/checkly"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := checkly.NewDashboard(ctx, "dashboard_1", &checkly.DashboardArgs{
			CustomUrl:      pulumi.String("checkly"),
			CustomDomain:   pulumi.String("status.example.com"),
			Logo:           pulumi.String("https://www.checklyhq.com/logo.png"),
			Header:         pulumi.String("Public dashboard"),
			RefreshRate:    pulumi.Int(60),
			Paginate:       pulumi.Bool(false),
			PaginationRate: pulumi.Int(30),
			HideTags:       pulumi.Bool(false),
			Width:          pulumi.String("FULL"),
			Tags: pulumi.StringArray{
				pulumi.String("production"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Checkly = Pulumi.Checkly;

return await Deployment.RunAsync(() => 
{
    var dashboard1 = new Checkly.Dashboard("dashboard_1", new()
    {
        CustomUrl = "checkly",
        CustomDomain = "status.example.com",
        Logo = "https://www.checklyhq.com/logo.png",
        Header = "Public dashboard",
        RefreshRate = 60,
        Paginate = false,
        PaginationRate = 30,
        HideTags = false,
        Width = "FULL",
        Tags = new[]
        {
            "production",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkly.Dashboard;
import com.pulumi.checkly.DashboardArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        var dashboard1 = new Dashboard("dashboard1", DashboardArgs.builder()
            .customUrl("checkly")
            .customDomain("status.example.com")
            .logo("https://www.checklyhq.com/logo.png")
            .header("Public dashboard")
            .refreshRate(60)
            .paginate(false)
            .paginationRate(30)
            .hideTags(false)
            .width("FULL")
            .tags("production")
            .build());

    }
}

    resources:
  dashboard1:
    type: checkly:Dashboard
    name: dashboard_1
    properties:
      customUrl: checkly
      customDomain: status.example.com
      logo: https://www.checklyhq.com/logo.png
      header: Public dashboard
      refreshRate: 60
      paginate: false
      paginationRate: 30
      hideTags: false
      width: FULL
      tags:
        - production

    Create Dashboard Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Dashboard(name: string, args: DashboardArgs, opts?: CustomResourceOptions);
    @overload
def Dashboard(resource_name: str,
              args: DashboardArgs,
              opts: Optional[ResourceOptions] = None)

@overload
def Dashboard(resource_name: str,
              opts: Optional[ResourceOptions] = None,
              custom_url: Optional[str] = None,
              header: Optional[str] = None,
              is_private: Optional[bool] = None,
              paginate: Optional[bool] = None,
              description: Optional[str] = None,
              enable_incidents: Optional[bool] = None,
              expand_checks: Optional[bool] = None,
              favicon: Optional[str] = None,
              custom_css: Optional[str] = None,
              hide_tags: Optional[bool] = None,
              checks_per_page: Optional[int] = None,
              link: Optional[str] = None,
              logo: Optional[str] = None,
              custom_domain: Optional[str] = None,
              pagination_rate: Optional[int] = None,
              refresh_rate: Optional[int] = None,
              show_check_run_links: Optional[bool] = None,
              show_header: Optional[bool] = None,
              show_p95: Optional[bool] = None,
              show_p99: Optional[bool] = None,
              tags: Optional[Sequence[str]] = None,
              use_tags_and_operator: Optional[bool] = None,
              width: Optional[str] = None)
    func NewDashboard(ctx *Context, name string, args DashboardArgs, opts ...ResourceOption) (*Dashboard, error)
    public Dashboard(string name, DashboardArgs args, CustomResourceOptions? opts = null)
    public Dashboard(String name, DashboardArgs args)
public Dashboard(String name, DashboardArgs args, CustomResourceOptions options)

    type: checkly:Dashboard
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DashboardArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var dashboardResource = new Checkly.Dashboard("dashboardResource", new()
{
    CustomUrl = "string",
    Header = "string",
    IsPrivate = false,
    Paginate = false,
    Description = "string",
    EnableIncidents = false,
    ExpandChecks = false,
    Favicon = "string",
    CustomCss = "string",
    HideTags = false,
    ChecksPerPage = 0,
    Link = "string",
    Logo = "string",
    CustomDomain = "string",
    PaginationRate = 0,
    RefreshRate = 0,
    ShowCheckRunLinks = false,
    ShowHeader = false,
    ShowP95 = false,
    ShowP99 = false,
    Tags = new[]
    {
        "string",
    },
    UseTagsAndOperator = false,
    Width = "string",
});

    example, err := checkly.NewDashboard(ctx, "dashboardResource", &checkly.DashboardArgs{
	CustomUrl:         pulumi.String("string"),
	Header:            pulumi.String("string"),
	IsPrivate:         pulumi.Bool(false),
	Paginate:          pulumi.Bool(false),
	Description:       pulumi.String("string"),
	EnableIncidents:   pulumi.Bool(false),
	ExpandChecks:      pulumi.Bool(false),
	Favicon:           pulumi.String("string"),
	CustomCss:         pulumi.String("string"),
	HideTags:          pulumi.Bool(false),
	ChecksPerPage:     pulumi.Int(0),
	Link:              pulumi.String("string"),
	Logo:              pulumi.String("string"),
	CustomDomain:      pulumi.String("string"),
	PaginationRate:    pulumi.Int(0),
	RefreshRate:       pulumi.Int(0),
	ShowCheckRunLinks: pulumi.Bool(false),
	ShowHeader:        pulumi.Bool(false),
	ShowP95:           pulumi.Bool(false),
	ShowP99:           pulumi.Bool(false),
	Tags: pulumi.StringArray{
		pulumi.String("string"),
	},
	UseTagsAndOperator: pulumi.Bool(false),
	Width:              pulumi.String("string"),
})

    var dashboardResource = new Dashboard("dashboardResource", DashboardArgs.builder()
    .customUrl("string")
    .header("string")
    .isPrivate(false)
    .paginate(false)
    .description("string")
    .enableIncidents(false)
    .expandChecks(false)
    .favicon("string")
    .customCss("string")
    .hideTags(false)
    .checksPerPage(0)
    .link("string")
    .logo("string")
    .customDomain("string")
    .paginationRate(0)
    .refreshRate(0)
    .showCheckRunLinks(false)
    .showHeader(false)
    .showP95(false)
    .showP99(false)
    .tags("string")
    .useTagsAndOperator(false)
    .width("string")
    .build());

    dashboard_resource = checkly.Dashboard("dashboardResource",
    custom_url="string",
    header="string",
    is_private=False,
    paginate=False,
    description="string",
    enable_incidents=False,
    expand_checks=False,
    favicon="string",
    custom_css="string",
    hide_tags=False,
    checks_per_page=0,
    link="string",
    logo="string",
    custom_domain="string",
    pagination_rate=0,
    refresh_rate=0,
    show_check_run_links=False,
    show_header=False,
    show_p95=False,
    show_p99=False,
    tags=["string"],
    use_tags_and_operator=False,
    width="string")

    const dashboardResource = new checkly.Dashboard("dashboardResource", {
    customUrl: "string",
    header: "string",
    isPrivate: false,
    paginate: false,
    description: "string",
    enableIncidents: false,
    expandChecks: false,
    favicon: "string",
    customCss: "string",
    hideTags: false,
    checksPerPage: 0,
    link: "string",
    logo: "string",
    customDomain: "string",
    paginationRate: 0,
    refreshRate: 0,
    showCheckRunLinks: false,
    showHeader: false,
    showP95: false,
    showP99: false,
    tags: ["string"],
    useTagsAndOperator: false,
    width: "string",
});

    type: checkly:Dashboard
properties:
    checksPerPage: 0
    customCss: string
    customDomain: string
    customUrl: string
    description: string
    enableIncidents: false
    expandChecks: false
    favicon: string
    header: string
    hideTags: false
    isPrivate: false
    link: string
    logo: string
    paginate: false
    paginationRate: 0
    refreshRate: 0
    showCheckRunLinks: false
    showHeader: false
    showP95: false
    showP99: false
    tags:
        - string
    useTagsAndOperator: false
    width: string

    Dashboard Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Dashboard resource accepts the following input properties:

    CustomUrl string
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    Header string
    A piece of text displayed at the top of your dashboard.
    ChecksPerPage int
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    CustomCss string
    Custom CSS to be applied to the dashboard.
    CustomDomain string
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    Description string
    HTML \n\n description for the dashboard.
    EnableIncidents bool
    Enable incident support for the dashboard. (Default false).
    ExpandChecks bool
    Expand or collapse checks on the dashboard. (Default false).
    Favicon string
    A URL pointing to an image file to use as browser favicon.
    HideTags bool
    Show or hide the tags on the dashboard. (Default false).
    IsPrivate bool
    Set your dashboard as private and generate key.
    Link string
    A link to for the dashboard logo.
    Logo string
    A URL pointing to an image file to use for the dashboard logo.
    Paginate bool
    Determines if pagination is on or off. (Default true).
    PaginationRate int
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    RefreshRate int
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    ShowCheckRunLinks bool
    Show or hide check run links on the dashboard. (Default false).
    ShowHeader bool
    Show or hide header and description on the dashboard. (Default true).
    ShowP95 bool
    Show or hide the P95 stats on the dashboard. (Default true).
    ShowP99 bool
    Show or hide the P99 stats on the dashboard. (Default true).
    Tags List<string>
    A list of one or more tags that filter which checks to display on the dashboard.
    UseTagsAndOperator bool
    Set when to use AND operator for fetching dashboard tags. (Default false).
    Width string
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).
    CustomUrl string
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    Header string
    A piece of text displayed at the top of your dashboard.
    ChecksPerPage int
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    CustomCss string
    Custom CSS to be applied to the dashboard.
    CustomDomain string
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    Description string
    HTML \n\n description for the dashboard.
    EnableIncidents bool
    Enable incident support for the dashboard. (Default false).
    ExpandChecks bool
    Expand or collapse checks on the dashboard. (Default false).
    Favicon string
    A URL pointing to an image file to use as browser favicon.
    HideTags bool
    Show or hide the tags on the dashboard. (Default false).
    IsPrivate bool
    Set your dashboard as private and generate key.
    Link string
    A link to for the dashboard logo.
    Logo string
    A URL pointing to an image file to use for the dashboard logo.
    Paginate bool
    Determines if pagination is on or off. (Default true).
    PaginationRate int
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    RefreshRate int
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    ShowCheckRunLinks bool
    Show or hide check run links on the dashboard. (Default false).
    ShowHeader bool
    Show or hide header and description on the dashboard. (Default true).
    ShowP95 bool
    Show or hide the P95 stats on the dashboard. (Default true).
    ShowP99 bool
    Show or hide the P99 stats on the dashboard. (Default true).
    Tags []string
    A list of one or more tags that filter which checks to display on the dashboard.
    UseTagsAndOperator bool
    Set when to use AND operator for fetching dashboard tags. (Default false).
    Width string
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).
    customUrl String
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    header String
    A piece of text displayed at the top of your dashboard.
    checksPerPage Integer
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    customCss String
    Custom CSS to be applied to the dashboard.
    customDomain String
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    description String
    HTML \n\n description for the dashboard.
    enableIncidents Boolean
    Enable incident support for the dashboard. (Default false).
    expandChecks Boolean
    Expand or collapse checks on the dashboard. (Default false).
    favicon String
    A URL pointing to an image file to use as browser favicon.
    hideTags Boolean
    Show or hide the tags on the dashboard. (Default false).
    isPrivate Boolean
    Set your dashboard as private and generate key.
    link String
    A link to for the dashboard logo.
    logo String
    A URL pointing to an image file to use for the dashboard logo.
    paginate Boolean
    Determines if pagination is on or off. (Default true).
    paginationRate Integer
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    refreshRate Integer
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    showCheckRunLinks Boolean
    Show or hide check run links on the dashboard. (Default false).
    showHeader Boolean
    Show or hide header and description on the dashboard. (Default true).
    showP95 Boolean
    Show or hide the P95 stats on the dashboard. (Default true).
    showP99 Boolean
    Show or hide the P99 stats on the dashboard. (Default true).
    tags List<String>
    A list of one or more tags that filter which checks to display on the dashboard.
    useTagsAndOperator Boolean
    Set when to use AND operator for fetching dashboard tags. (Default false).
    width String
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).
    customUrl string
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    header string
    A piece of text displayed at the top of your dashboard.
    checksPerPage number
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    customCss string
    Custom CSS to be applied to the dashboard.
    customDomain string
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    description string
    HTML \n\n description for the dashboard.
    enableIncidents boolean
    Enable incident support for the dashboard. (Default false).
    expandChecks boolean
    Expand or collapse checks on the dashboard. (Default false).
    favicon string
    A URL pointing to an image file to use as browser favicon.
    hideTags boolean
    Show or hide the tags on the dashboard. (Default false).
    isPrivate boolean
    Set your dashboard as private and generate key.
    link string
    A link to for the dashboard logo.
    logo string
    A URL pointing to an image file to use for the dashboard logo.
    paginate boolean
    Determines if pagination is on or off. (Default true).
    paginationRate number
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    refreshRate number
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    showCheckRunLinks boolean
    Show or hide check run links on the dashboard. (Default false).
    showHeader boolean
    Show or hide header and description on the dashboard. (Default true).
    showP95 boolean
    Show or hide the P95 stats on the dashboard. (Default true).
    showP99 boolean
    Show or hide the P99 stats on the dashboard. (Default true).
    tags string[]
    A list of one or more tags that filter which checks to display on the dashboard.
    useTagsAndOperator boolean
    Set when to use AND operator for fetching dashboard tags. (Default false).
    width string
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).
    custom_url str
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    header str
    A piece of text displayed at the top of your dashboard.
    checks_per_page int
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    custom_css str
    Custom CSS to be applied to the dashboard.
    custom_domain str
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    description str
    HTML \n\n description for the dashboard.
    enable_incidents bool
    Enable incident support for the dashboard. (Default false).
    expand_checks bool
    Expand or collapse checks on the dashboard. (Default false).
    favicon str
    A URL pointing to an image file to use as browser favicon.
    hide_tags bool
    Show or hide the tags on the dashboard. (Default false).
    is_private bool
    Set your dashboard as private and generate key.
    link str
    A link to for the dashboard logo.
    logo str
    A URL pointing to an image file to use for the dashboard logo.
    paginate bool
    Determines if pagination is on or off. (Default true).
    pagination_rate int
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    refresh_rate int
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    show_check_run_links bool
    Show or hide check run links on the dashboard. (Default false).
    show_header bool
    Show or hide header and description on the dashboard. (Default true).
    show_p95 bool
    Show or hide the P95 stats on the dashboard. (Default true).
    show_p99 bool
    Show or hide the P99 stats on the dashboard. (Default true).
    tags Sequence[str]
    A list of one or more tags that filter which checks to display on the dashboard.
    use_tags_and_operator bool
    Set when to use AND operator for fetching dashboard tags. (Default false).
    width str
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).
    customUrl String
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    header String
    A piece of text displayed at the top of your dashboard.
    checksPerPage Number
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    customCss String
    Custom CSS to be applied to the dashboard.
    customDomain String
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    description String
    HTML \n\n description for the dashboard.
    enableIncidents Boolean
    Enable incident support for the dashboard. (Default false).
    expandChecks Boolean
    Expand or collapse checks on the dashboard. (Default false).
    favicon String
    A URL pointing to an image file to use as browser favicon.
    hideTags Boolean
    Show or hide the tags on the dashboard. (Default false).
    isPrivate Boolean
    Set your dashboard as private and generate key.
    link String
    A link to for the dashboard logo.
    logo String
    A URL pointing to an image file to use for the dashboard logo.
    paginate Boolean
    Determines if pagination is on or off. (Default true).
    paginationRate Number
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    refreshRate Number
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    showCheckRunLinks Boolean
    Show or hide check run links on the dashboard. (Default false).
    showHeader Boolean
    Show or hide header and description on the dashboard. (Default true).
    showP95 Boolean
    Show or hide the P95 stats on the dashboard. (Default true).
    showP99 Boolean
    Show or hide the P99 stats on the dashboard. (Default true).
    tags List<String>
    A list of one or more tags that filter which checks to display on the dashboard.
    useTagsAndOperator Boolean
    Set when to use AND operator for fetching dashboard tags. (Default false).
    width String
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Dashboard resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    The access key when the dashboard is private.
    Id string
    The provider-assigned unique ID for this managed resource.
    Key string
    The access key when the dashboard is private.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    The access key when the dashboard is private.
    id string
    The provider-assigned unique ID for this managed resource.
    key string
    The access key when the dashboard is private.
    id str
    The provider-assigned unique ID for this managed resource.
    key str
    The access key when the dashboard is private.
    id String
    The provider-assigned unique ID for this managed resource.
    key String
    The access key when the dashboard is private.

    Look up Existing Dashboard Resource

    Get an existing Dashboard resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DashboardState, opts?: CustomResourceOptions): Dashboard
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        checks_per_page: Optional[int] = None,
        custom_css: Optional[str] = None,
        custom_domain: Optional[str] = None,
        custom_url: Optional[str] = None,
        description: Optional[str] = None,
        enable_incidents: Optional[bool] = None,
        expand_checks: Optional[bool] = None,
        favicon: Optional[str] = None,
        header: Optional[str] = None,
        hide_tags: Optional[bool] = None,
        is_private: Optional[bool] = None,
        key: Optional[str] = None,
        link: Optional[str] = None,
        logo: Optional[str] = None,
        paginate: Optional[bool] = None,
        pagination_rate: Optional[int] = None,
        refresh_rate: Optional[int] = None,
        show_check_run_links: Optional[bool] = None,
        show_header: Optional[bool] = None,
        show_p95: Optional[bool] = None,
        show_p99: Optional[bool] = None,
        tags: Optional[Sequence[str]] = None,
        use_tags_and_operator: Optional[bool] = None,
        width: Optional[str] = None) -> Dashboard
    func GetDashboard(ctx *Context, name string, id IDInput, state *DashboardState, opts ...ResourceOption) (*Dashboard, error)
    public static Dashboard Get(string name, Input<string> id, DashboardState? state, CustomResourceOptions? opts = null)
    public static Dashboard get(String name, Output<String> id, DashboardState state, CustomResourceOptions options)
    resources:  _:    type: checkly:Dashboard    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ChecksPerPage int
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    CustomCss string
    Custom CSS to be applied to the dashboard.
    CustomDomain string
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    CustomUrl string
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    Description string
    HTML \n\n description for the dashboard.
    EnableIncidents bool
    Enable incident support for the dashboard. (Default false).
    ExpandChecks bool
    Expand or collapse checks on the dashboard. (Default false).
    Favicon string
    A URL pointing to an image file to use as browser favicon.
    Header string
    A piece of text displayed at the top of your dashboard.
    HideTags bool
    Show or hide the tags on the dashboard. (Default false).
    IsPrivate bool
    Set your dashboard as private and generate key.
    Key string
    The access key when the dashboard is private.
    Link string
    A link to for the dashboard logo.
    Logo string
    A URL pointing to an image file to use for the dashboard logo.
    Paginate bool
    Determines if pagination is on or off. (Default true).
    PaginationRate int
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    RefreshRate int
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    ShowCheckRunLinks bool
    Show or hide check run links on the dashboard. (Default false).
    ShowHeader bool
    Show or hide header and description on the dashboard. (Default true).
    ShowP95 bool
    Show or hide the P95 stats on the dashboard. (Default true).
    ShowP99 bool
    Show or hide the P99 stats on the dashboard. (Default true).
    Tags List<string>
    A list of one or more tags that filter which checks to display on the dashboard.
    UseTagsAndOperator bool
    Set when to use AND operator for fetching dashboard tags. (Default false).
    Width string
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).
    ChecksPerPage int
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    CustomCss string
    Custom CSS to be applied to the dashboard.
    CustomDomain string
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    CustomUrl string
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    Description string
    HTML \n\n description for the dashboard.
    EnableIncidents bool
    Enable incident support for the dashboard. (Default false).
    ExpandChecks bool
    Expand or collapse checks on the dashboard. (Default false).
    Favicon string
    A URL pointing to an image file to use as browser favicon.
    Header string
    A piece of text displayed at the top of your dashboard.
    HideTags bool
    Show or hide the tags on the dashboard. (Default false).
    IsPrivate bool
    Set your dashboard as private and generate key.
    Key string
    The access key when the dashboard is private.
    Link string
    A link to for the dashboard logo.
    Logo string
    A URL pointing to an image file to use for the dashboard logo.
    Paginate bool
    Determines if pagination is on or off. (Default true).
    PaginationRate int
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    RefreshRate int
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    ShowCheckRunLinks bool
    Show or hide check run links on the dashboard. (Default false).
    ShowHeader bool
    Show or hide header and description on the dashboard. (Default true).
    ShowP95 bool
    Show or hide the P95 stats on the dashboard. (Default true).
    ShowP99 bool
    Show or hide the P99 stats on the dashboard. (Default true).
    Tags []string
    A list of one or more tags that filter which checks to display on the dashboard.
    UseTagsAndOperator bool
    Set when to use AND operator for fetching dashboard tags. (Default false).
    Width string
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).
    checksPerPage Integer
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    customCss String
    Custom CSS to be applied to the dashboard.
    customDomain String
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    customUrl String
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    description String
    HTML \n\n description for the dashboard.
    enableIncidents Boolean
    Enable incident support for the dashboard. (Default false).
    expandChecks Boolean
    Expand or collapse checks on the dashboard. (Default false).
    favicon String
    A URL pointing to an image file to use as browser favicon.
    header String
    A piece of text displayed at the top of your dashboard.
    hideTags Boolean
    Show or hide the tags on the dashboard. (Default false).
    isPrivate Boolean
    Set your dashboard as private and generate key.
    key String
    The access key when the dashboard is private.
    link String
    A link to for the dashboard logo.
    logo String
    A URL pointing to an image file to use for the dashboard logo.
    paginate Boolean
    Determines if pagination is on or off. (Default true).
    paginationRate Integer
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    refreshRate Integer
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    showCheckRunLinks Boolean
    Show or hide check run links on the dashboard. (Default false).
    showHeader Boolean
    Show or hide header and description on the dashboard. (Default true).
    showP95 Boolean
    Show or hide the P95 stats on the dashboard. (Default true).
    showP99 Boolean
    Show or hide the P99 stats on the dashboard. (Default true).
    tags List<String>
    A list of one or more tags that filter which checks to display on the dashboard.
    useTagsAndOperator Boolean
    Set when to use AND operator for fetching dashboard tags. (Default false).
    width String
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).
    checksPerPage number
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    customCss string
    Custom CSS to be applied to the dashboard.
    customDomain string
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    customUrl string
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    description string
    HTML \n\n description for the dashboard.
    enableIncidents boolean
    Enable incident support for the dashboard. (Default false).
    expandChecks boolean
    Expand or collapse checks on the dashboard. (Default false).
    favicon string
    A URL pointing to an image file to use as browser favicon.
    header string
    A piece of text displayed at the top of your dashboard.
    hideTags boolean
    Show or hide the tags on the dashboard. (Default false).
    isPrivate boolean
    Set your dashboard as private and generate key.
    key string
    The access key when the dashboard is private.
    link string
    A link to for the dashboard logo.
    logo string
    A URL pointing to an image file to use for the dashboard logo.
    paginate boolean
    Determines if pagination is on or off. (Default true).
    paginationRate number
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    refreshRate number
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    showCheckRunLinks boolean
    Show or hide check run links on the dashboard. (Default false).
    showHeader boolean
    Show or hide header and description on the dashboard. (Default true).
    showP95 boolean
    Show or hide the P95 stats on the dashboard. (Default true).
    showP99 boolean
    Show or hide the P99 stats on the dashboard. (Default true).
    tags string[]
    A list of one or more tags that filter which checks to display on the dashboard.
    useTagsAndOperator boolean
    Set when to use AND operator for fetching dashboard tags. (Default false).
    width string
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).
    checks_per_page int
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    custom_css str
    Custom CSS to be applied to the dashboard.
    custom_domain str
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    custom_url str
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    description str
    HTML \n\n description for the dashboard.
    enable_incidents bool
    Enable incident support for the dashboard. (Default false).
    expand_checks bool
    Expand or collapse checks on the dashboard. (Default false).
    favicon str
    A URL pointing to an image file to use as browser favicon.
    header str
    A piece of text displayed at the top of your dashboard.
    hide_tags bool
    Show or hide the tags on the dashboard. (Default false).
    is_private bool
    Set your dashboard as private and generate key.
    key str
    The access key when the dashboard is private.
    link str
    A link to for the dashboard logo.
    logo str
    A URL pointing to an image file to use for the dashboard logo.
    paginate bool
    Determines if pagination is on or off. (Default true).
    pagination_rate int
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    refresh_rate int
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    show_check_run_links bool
    Show or hide check run links on the dashboard. (Default false).
    show_header bool
    Show or hide header and description on the dashboard. (Default true).
    show_p95 bool
    Show or hide the P95 stats on the dashboard. (Default true).
    show_p99 bool
    Show or hide the P99 stats on the dashboard. (Default true).
    tags Sequence[str]
    A list of one or more tags that filter which checks to display on the dashboard.
    use_tags_and_operator bool
    Set when to use AND operator for fetching dashboard tags. (Default false).
    width str
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).
    checksPerPage Number
    Determines how many checks to show per page. Possible values are between 1 and 20. (Default 15).
    customCss String
    Custom CSS to be applied to the dashboard.
    customDomain String
    A custom user domain, e.g. 'status.example.com'. See the docs on updating your DNS and SSL usage.
    customUrl String
    A subdomain name under 'checklyhq.com'. Needs to be unique across all users.
    description String
    HTML \n\n description for the dashboard.
    enableIncidents Boolean
    Enable incident support for the dashboard. (Default false).
    expandChecks Boolean
    Expand or collapse checks on the dashboard. (Default false).
    favicon String
    A URL pointing to an image file to use as browser favicon.
    header String
    A piece of text displayed at the top of your dashboard.
    hideTags Boolean
    Show or hide the tags on the dashboard. (Default false).
    isPrivate Boolean
    Set your dashboard as private and generate key.
    key String
    The access key when the dashboard is private.
    link String
    A link to for the dashboard logo.
    logo String
    A URL pointing to an image file to use for the dashboard logo.
    paginate Boolean
    Determines if pagination is on or off. (Default true).
    paginationRate Number
    How often to trigger pagination in seconds. Possible values 30, 60 and 300. (Default 60).
    refreshRate Number
    How often to refresh the dashboard in seconds. Possible values 60, '300' and 600. (Default 60).
    showCheckRunLinks Boolean
    Show or hide check run links on the dashboard. (Default false).
    showHeader Boolean
    Show or hide header and description on the dashboard. (Default true).
    showP95 Boolean
    Show or hide the P95 stats on the dashboard. (Default true).
    showP99 Boolean
    Show or hide the P99 stats on the dashboard. (Default true).
    tags List<String>
    A list of one or more tags that filter which checks to display on the dashboard.
    useTagsAndOperator Boolean
    Set when to use AND operator for fetching dashboard tags. (Default false).
    width String
    Determines whether to use the full screen or focus in the center. Possible values are FULL and 960PX. (Default FULL).

    Package Details

    Repository
    checkly checkly/pulumi-checkly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the checkly Terraform Provider.
    checkly logo
    Checkly v2.3.0 published on Friday, Aug 1, 2025 by Checkly
    checkly/pulumi-checkly