Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Checkly
  4. API Docs
  5. StatusPageV3Component
Viewing docs for Checkly v2.14.0
published on Friday, Oct 9, 2026 by Checkly
Schema (JSON)
checkly/pulumi-checkly

checkly.StatusPageV3Component

checkly logo Checkly
Viewing docs for Checkly v2.14.0
published on Friday, Oct 9, 2026 by Checkly
Schema (JSON)
checkly/pulumi-checkly

    A component of a v3 status page: either a SERVICE (a monitored thing with its own status) or a GROUP (a container for other components). Import uses the composite ID <status_page_id>/<component_id>.

    Example Usage

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

const example = new checkly.StatusPageV3("example", {
    name: "Example Application",
    url: "my-example-status-page",
});
const services = new checkly.StatusPageV3Component("services", {
    statusPageId: example.id,
    type: "GROUP",
    name: "Services",
    displayOrder: 0,
    expandedByDefault: true,
});
const api = new checkly.StatusPageV3Component("api", {
    statusPageId: example.id,
    name: "API",
    description: "The public API",
    displayOrder: 1,
    parentId: services.id,
});

    import pulumi
import pulumi_checkly as checkly

example = checkly.StatusPageV3("example",
    name="Example Application",
    url="my-example-status-page")
services = checkly.StatusPageV3Component("services",
    status_page_id=example.id,
    type="GROUP",
    name="Services",
    display_order=0,
    expanded_by_default=True)
api = checkly.StatusPageV3Component("api",
    status_page_id=example.id,
    name="API",
    description="The public API",
    display_order=1,
    parent_id=services.id)

    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 {
		example, err := checkly.NewStatusPageV3(ctx, "example", &checkly.StatusPageV3Args{
			Name: pulumi.String("Example Application"),
			Url:  pulumi.String("my-example-status-page"),
		})
		if err != nil {
			return err
		}
		services, err := checkly.NewStatusPageV3Component(ctx, "services", &checkly.StatusPageV3ComponentArgs{
			StatusPageId:      example.ID(),
			Type:              pulumi.String("GROUP"),
			Name:              pulumi.String("Services"),
			DisplayOrder:      pulumi.Int(0),
			ExpandedByDefault: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		_, err = checkly.NewStatusPageV3Component(ctx, "api", &checkly.StatusPageV3ComponentArgs{
			StatusPageId: example.ID(),
			Name:         pulumi.String("API"),
			Description:  pulumi.String("The public API"),
			DisplayOrder: pulumi.Int(1),
			ParentId:     services.ID(),
		})
		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 example = new Checkly.StatusPageV3("example", new()
    {
        Name = "Example Application",
        Url = "my-example-status-page",
    });

    var services = new Checkly.StatusPageV3Component("services", new()
    {
        StatusPageId = example.Id,
        Type = "GROUP",
        Name = "Services",
        DisplayOrder = 0,
        ExpandedByDefault = true,
    });

    var api = new Checkly.StatusPageV3Component("api", new()
    {
        StatusPageId = example.Id,
        Name = "API",
        Description = "The public API",
        DisplayOrder = 1,
        ParentId = services.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.checkly.StatusPageV3;
import com.pulumi.checkly.StatusPageV3Args;
import com.pulumi.checkly.StatusPageV3Component;
import com.pulumi.checkly.StatusPageV3ComponentArgs;
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 example = new StatusPageV3("example", StatusPageV3Args.builder()
            .name("Example Application")
            .url("my-example-status-page")
            .build());

        var services = new StatusPageV3Component("services", StatusPageV3ComponentArgs.builder()
            .statusPageId(example.id())
            .type("GROUP")
            .name("Services")
            .displayOrder(0)
            .expandedByDefault(true)
            .build());

        var api = new StatusPageV3Component("api", StatusPageV3ComponentArgs.builder()
            .statusPageId(example.id())
            .name("API")
            .description("The public API")
            .displayOrder(1)
            .parentId(services.id())
            .build());

    }
}

    resources:
  example:
    type: checkly:StatusPageV3
    properties:
      name: Example Application
      url: my-example-status-page
  services:
    type: checkly:StatusPageV3Component
    properties:
      statusPageId: ${example.id}
      type: GROUP
      name: Services
      displayOrder: 0
      expandedByDefault: true
  api:
    type: checkly:StatusPageV3Component
    properties:
      statusPageId: ${example.id}
      name: API
      description: The public API
      displayOrder: 1
      parentId: ${services.id}

    Example coming soon!

    Create StatusPageV3Component Resource

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

    Constructor syntax

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

@overload
def StatusPageV3Component(resource_name: str,
                          opts: Optional[ResourceOptions] = None,
                          display_order: Optional[int] = None,
                          status_page_id: Optional[str] = None,
                          description: Optional[str] = None,
                          expanded_by_default: Optional[bool] = None,
                          hidden: Optional[bool] = None,
                          name: Optional[str] = None,
                          parent_id: Optional[str] = None,
                          show_historical_data: Optional[bool] = None,
                          type: Optional[str] = None)
    func NewStatusPageV3Component(ctx *Context, name string, args StatusPageV3ComponentArgs, opts ...ResourceOption) (*StatusPageV3Component, error)
    public StatusPageV3Component(string name, StatusPageV3ComponentArgs args, CustomResourceOptions? opts = null)
    public StatusPageV3Component(String name, StatusPageV3ComponentArgs args)
public StatusPageV3Component(String name, StatusPageV3ComponentArgs args, CustomResourceOptions options)

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


    resource "checkly_status_page_v3_component" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args StatusPageV3ComponentArgs
    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 StatusPageV3ComponentArgs
    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 StatusPageV3ComponentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StatusPageV3ComponentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StatusPageV3ComponentArgs
    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 statusPageV3ComponentResource = new Checkly.StatusPageV3Component("statusPageV3ComponentResource", new()
{
    DisplayOrder = 0,
    StatusPageId = "string",
    Description = "string",
    ExpandedByDefault = false,
    Hidden = false,
    Name = "string",
    ParentId = "string",
    ShowHistoricalData = false,
    Type = "string",
});

    example, err := checkly.NewStatusPageV3Component(ctx, "statusPageV3ComponentResource", &checkly.StatusPageV3ComponentArgs{
	DisplayOrder:       pulumi.Int(0),
	StatusPageId:       pulumi.String("string"),
	Description:        pulumi.String("string"),
	ExpandedByDefault:  pulumi.Bool(false),
	Hidden:             pulumi.Bool(false),
	Name:               pulumi.String("string"),
	ParentId:           pulumi.String("string"),
	ShowHistoricalData: pulumi.Bool(false),
	Type:               pulumi.String("string"),
})

    resource "checkly_status_page_v3_component" "statusPageV3ComponentResource" {
  lifecycle {
    create_before_destroy = true
  }
  display_order        = 0
  status_page_id       = "string"
  description          = "string"
  expanded_by_default  = false
  hidden               = false
  name                 = "string"
  parent_id            = "string"
  show_historical_data = false
  type                 = "string"
}

    var statusPageV3ComponentResource = new StatusPageV3Component("statusPageV3ComponentResource", StatusPageV3ComponentArgs.builder()
    .displayOrder(0)
    .statusPageId("string")
    .description("string")
    .expandedByDefault(false)
    .hidden(false)
    .name("string")
    .parentId("string")
    .showHistoricalData(false)
    .type("string")
    .build());

    status_page_v3_component_resource = checkly.StatusPageV3Component("statusPageV3ComponentResource",
    display_order=0,
    status_page_id="string",
    description="string",
    expanded_by_default=False,
    hidden=False,
    name="string",
    parent_id="string",
    show_historical_data=False,
    type="string")

    const statusPageV3ComponentResource = new checkly.StatusPageV3Component("statusPageV3ComponentResource", {
    displayOrder: 0,
    statusPageId: "string",
    description: "string",
    expandedByDefault: false,
    hidden: false,
    name: "string",
    parentId: "string",
    showHistoricalData: false,
    type: "string",
});

    type: checkly:StatusPageV3Component
properties:
    description: string
    displayOrder: 0
    expandedByDefault: false
    hidden: false
    name: string
    parentId: string
    showHistoricalData: false
    statusPageId: string
    type: string

    StatusPageV3Component 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 StatusPageV3Component resource accepts the following input properties:

    DisplayOrder int
    The position among siblings; lower comes first.
    StatusPageId string
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    Description string
    An optional description shown next to the name.
    ExpandedByDefault bool
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    Hidden bool
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    Name string
    The name shown on the status page.
    ParentId string
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    ShowHistoricalData bool
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    Type string
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    DisplayOrder int
    The position among siblings; lower comes first.
    StatusPageId string
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    Description string
    An optional description shown next to the name.
    ExpandedByDefault bool
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    Hidden bool
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    Name string
    The name shown on the status page.
    ParentId string
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    ShowHistoricalData bool
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    Type string
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    display_order number
    The position among siblings; lower comes first.
    status_page_id string
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    description string
    An optional description shown next to the name.
    expanded_by_default bool
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    hidden bool
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    name string
    The name shown on the status page.
    parent_id string
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    show_historical_data bool
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    type string
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    displayOrder Integer
    The position among siblings; lower comes first.
    statusPageId String
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    description String
    An optional description shown next to the name.
    expandedByDefault Boolean
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    hidden Boolean
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    name String
    The name shown on the status page.
    parentId String
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    showHistoricalData Boolean
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    type String
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    displayOrder number
    The position among siblings; lower comes first.
    statusPageId string
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    description string
    An optional description shown next to the name.
    expandedByDefault boolean
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    hidden boolean
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    name string
    The name shown on the status page.
    parentId string
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    showHistoricalData boolean
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    type string
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    display_order int
    The position among siblings; lower comes first.
    status_page_id str
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    description str
    An optional description shown next to the name.
    expanded_by_default bool
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    hidden bool
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    name str
    The name shown on the status page.
    parent_id str
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    show_historical_data bool
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    type str
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    displayOrder Number
    The position among siblings; lower comes first.
    statusPageId String
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    description String
    An optional description shown next to the name.
    expandedByDefault Boolean
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    hidden Boolean
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    name String
    The name shown on the status page.
    parentId String
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    showHistoricalData Boolean
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    type String
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing StatusPageV3Component Resource

    Get an existing StatusPageV3Component 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?: StatusPageV3ComponentState, opts?: CustomResourceOptions): StatusPageV3Component
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        display_order: Optional[int] = None,
        expanded_by_default: Optional[bool] = None,
        hidden: Optional[bool] = None,
        name: Optional[str] = None,
        parent_id: Optional[str] = None,
        show_historical_data: Optional[bool] = None,
        status_page_id: Optional[str] = None,
        type: Optional[str] = None) -> StatusPageV3Component
    func GetStatusPageV3Component(ctx *Context, name string, id IDInput, state *StatusPageV3ComponentState, opts ...ResourceOption) (*StatusPageV3Component, error)
    public static StatusPageV3Component Get(string name, Input<string> id, StatusPageV3ComponentState? state, CustomResourceOptions? opts = null)
    public static StatusPageV3Component get(String name, Output<String> id, StatusPageV3ComponentState state, CustomResourceOptions options)
    resources:  _:    type: checkly:StatusPageV3Component    get:      id: ${id}
    import {
  to = checkly_status_page_v3_component.example
  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:
    Description string
    An optional description shown next to the name.
    DisplayOrder int
    The position among siblings; lower comes first.
    ExpandedByDefault bool
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    Hidden bool
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    Name string
    The name shown on the status page.
    ParentId string
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    ShowHistoricalData bool
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    StatusPageId string
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    Type string
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    Description string
    An optional description shown next to the name.
    DisplayOrder int
    The position among siblings; lower comes first.
    ExpandedByDefault bool
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    Hidden bool
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    Name string
    The name shown on the status page.
    ParentId string
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    ShowHistoricalData bool
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    StatusPageId string
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    Type string
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    description string
    An optional description shown next to the name.
    display_order number
    The position among siblings; lower comes first.
    expanded_by_default bool
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    hidden bool
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    name string
    The name shown on the status page.
    parent_id string
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    show_historical_data bool
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    status_page_id string
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    type string
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    description String
    An optional description shown next to the name.
    displayOrder Integer
    The position among siblings; lower comes first.
    expandedByDefault Boolean
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    hidden Boolean
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    name String
    The name shown on the status page.
    parentId String
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    showHistoricalData Boolean
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    statusPageId String
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    type String
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    description string
    An optional description shown next to the name.
    displayOrder number
    The position among siblings; lower comes first.
    expandedByDefault boolean
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    hidden boolean
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    name string
    The name shown on the status page.
    parentId string
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    showHistoricalData boolean
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    statusPageId string
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    type string
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    description str
    An optional description shown next to the name.
    display_order int
    The position among siblings; lower comes first.
    expanded_by_default bool
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    hidden bool
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    name str
    The name shown on the status page.
    parent_id str
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    show_historical_data bool
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    status_page_id str
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    type str
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).
    description String
    An optional description shown next to the name.
    displayOrder Number
    The position among siblings; lower comes first.
    expandedByDefault Boolean
    Render the group expanded when the status page loads. Only available on a GROUP component. (Default false).
    hidden Boolean
    Hide the component from the public page while keeping it available for incidents and automation. (Default false).
    name String
    The name shown on the status page.
    parentId String
    The ID of the GROUP component to nest this component under. Must be on the same status page.
    showHistoricalData Boolean
    Show the historical status (the uptime bar) of the component on the status page. (Default true).
    statusPageId String
    The ID of the v3 status page the component belongs to. A component cannot be moved to another page.
    type String
    The type of the component. The allowed values are SERVICE (a monitored thing with its own status) and GROUP (a container for other components). (Default SERVICE).

    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
    Viewing docs for Checkly v2.14.0
    published on Friday, Oct 9, 2026 by Checkly
    Schema (JSON)
    checkly/pulumi-checkly

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial