1. Packages
  2. Packages
  3. Rootly
  4. API Docs
  5. StatusPage
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

rootly.StatusPage

rootly logo
Viewing docs for Rootly v3.3.0
published on Thursday, May 7, 2026 by rootlyhq
Schema (JSON)
rootlyhq/pulumi-rootly

    Example Usage

    resource "rootly_status_page" "public" {
  title                 = "Acme Status"
  public_title          = "Acme System Status"
  description           = "Current status of Acme services"
  success_message       = "All Systems Operational"
  failure_message       = "Degraded Performance"
  show_uptime           = true
  show_uptime_last_days = 90
  service_ids           = [rootly_service.elasticsearch_prod.id]
  functionality_ids     = [rootly_functionality.checkout.id]
}

    Create StatusPage Resource

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

    Constructor syntax

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

@overload
def StatusPage(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               title: Optional[str] = None,
               public_title: Optional[str] = None,
               service_ids: Optional[Sequence[str]] = None,
               authentication_password: Optional[str] = None,
               description: Optional[str] = None,
               enabled: Optional[bool] = None,
               external_domain_names: Optional[Sequence[str]] = None,
               failure_message: Optional[str] = None,
               footer_color: Optional[str] = None,
               functionality_ids: Optional[Sequence[str]] = None,
               ga_tracking_id: Optional[str] = None,
               header_color: Optional[str] = None,
               public: Optional[bool] = None,
               public_description: Optional[str] = None,
               allow_search_engine_index: Optional[bool] = None,
               authentication_method: Optional[str] = None,
               saml_idp_cert: Optional[str] = None,
               show_uptime_last_days: Optional[int] = None,
               saml_idp_sso_service_url: Optional[str] = None,
               saml_name_identifier_format: Optional[str] = None,
               section_orders: Optional[Sequence[str]] = None,
               saml_idp_cert_fingerprint: Optional[str] = None,
               show_uptime: Optional[bool] = None,
               saml_idp_slo_service_url: Optional[str] = None,
               slug: Optional[str] = None,
               success_message: Optional[str] = None,
               time_zone: Optional[str] = None,
               authentication_enabled: Optional[bool] = None,
               website_privacy_url: Optional[str] = None,
               website_support_url: Optional[str] = None,
               website_url: Optional[str] = None)
    func NewStatusPage(ctx *Context, name string, args StatusPageArgs, opts ...ResourceOption) (*StatusPage, error)
    public StatusPage(string name, StatusPageArgs args, CustomResourceOptions? opts = null)
    public StatusPage(String name, StatusPageArgs args)
public StatusPage(String name, StatusPageArgs args, CustomResourceOptions options)

    type: rootly:StatusPage
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 StatusPageArgs
    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 StatusPageArgs
    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 StatusPageArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args StatusPageArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args StatusPageArgs
    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 statusPageResource = new Rootly.StatusPage("statusPageResource", new()
{
    Title = "string",
    PublicTitle = "string",
    ServiceIds = new[]
    {
        "string",
    },
    AuthenticationPassword = "string",
    Description = "string",
    Enabled = false,
    ExternalDomainNames = new[]
    {
        "string",
    },
    FailureMessage = "string",
    FooterColor = "string",
    FunctionalityIds = new[]
    {
        "string",
    },
    GaTrackingId = "string",
    HeaderColor = "string",
    Public = false,
    PublicDescription = "string",
    AllowSearchEngineIndex = false,
    AuthenticationMethod = "string",
    SamlIdpCert = "string",
    ShowUptimeLastDays = 0,
    SamlIdpSsoServiceUrl = "string",
    SamlNameIdentifierFormat = "string",
    SectionOrders = new[]
    {
        "string",
    },
    SamlIdpCertFingerprint = "string",
    ShowUptime = false,
    SamlIdpSloServiceUrl = "string",
    Slug = "string",
    SuccessMessage = "string",
    TimeZone = "string",
    AuthenticationEnabled = false,
    WebsitePrivacyUrl = "string",
    WebsiteSupportUrl = "string",
    WebsiteUrl = "string",
});

    example, err := rootly.NewStatusPage(ctx, "statusPageResource", &rootly.StatusPageArgs{
	Title:       pulumi.String("string"),
	PublicTitle: pulumi.String("string"),
	ServiceIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	AuthenticationPassword: pulumi.String("string"),
	Description:            pulumi.String("string"),
	Enabled:                pulumi.Bool(false),
	ExternalDomainNames: pulumi.StringArray{
		pulumi.String("string"),
	},
	FailureMessage: pulumi.String("string"),
	FooterColor:    pulumi.String("string"),
	FunctionalityIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	GaTrackingId:             pulumi.String("string"),
	HeaderColor:              pulumi.String("string"),
	Public:                   pulumi.Bool(false),
	PublicDescription:        pulumi.String("string"),
	AllowSearchEngineIndex:   pulumi.Bool(false),
	AuthenticationMethod:     pulumi.String("string"),
	SamlIdpCert:              pulumi.String("string"),
	ShowUptimeLastDays:       pulumi.Int(0),
	SamlIdpSsoServiceUrl:     pulumi.String("string"),
	SamlNameIdentifierFormat: pulumi.String("string"),
	SectionOrders: pulumi.StringArray{
		pulumi.String("string"),
	},
	SamlIdpCertFingerprint: pulumi.String("string"),
	ShowUptime:             pulumi.Bool(false),
	SamlIdpSloServiceUrl:   pulumi.String("string"),
	Slug:                   pulumi.String("string"),
	SuccessMessage:         pulumi.String("string"),
	TimeZone:               pulumi.String("string"),
	AuthenticationEnabled:  pulumi.Bool(false),
	WebsitePrivacyUrl:      pulumi.String("string"),
	WebsiteSupportUrl:      pulumi.String("string"),
	WebsiteUrl:             pulumi.String("string"),
})

    var statusPageResource = new StatusPage("statusPageResource", StatusPageArgs.builder()
    .title("string")
    .publicTitle("string")
    .serviceIds("string")
    .authenticationPassword("string")
    .description("string")
    .enabled(false)
    .externalDomainNames("string")
    .failureMessage("string")
    .footerColor("string")
    .functionalityIds("string")
    .gaTrackingId("string")
    .headerColor("string")
    .public_(false)
    .publicDescription("string")
    .allowSearchEngineIndex(false)
    .authenticationMethod("string")
    .samlIdpCert("string")
    .showUptimeLastDays(0)
    .samlIdpSsoServiceUrl("string")
    .samlNameIdentifierFormat("string")
    .sectionOrders("string")
    .samlIdpCertFingerprint("string")
    .showUptime(false)
    .samlIdpSloServiceUrl("string")
    .slug("string")
    .successMessage("string")
    .timeZone("string")
    .authenticationEnabled(false)
    .websitePrivacyUrl("string")
    .websiteSupportUrl("string")
    .websiteUrl("string")
    .build());

    status_page_resource = rootly.StatusPage("statusPageResource",
    title="string",
    public_title="string",
    service_ids=["string"],
    authentication_password="string",
    description="string",
    enabled=False,
    external_domain_names=["string"],
    failure_message="string",
    footer_color="string",
    functionality_ids=["string"],
    ga_tracking_id="string",
    header_color="string",
    public=False,
    public_description="string",
    allow_search_engine_index=False,
    authentication_method="string",
    saml_idp_cert="string",
    show_uptime_last_days=0,
    saml_idp_sso_service_url="string",
    saml_name_identifier_format="string",
    section_orders=["string"],
    saml_idp_cert_fingerprint="string",
    show_uptime=False,
    saml_idp_slo_service_url="string",
    slug="string",
    success_message="string",
    time_zone="string",
    authentication_enabled=False,
    website_privacy_url="string",
    website_support_url="string",
    website_url="string")

    const statusPageResource = new rootly.StatusPage("statusPageResource", {
    title: "string",
    publicTitle: "string",
    serviceIds: ["string"],
    authenticationPassword: "string",
    description: "string",
    enabled: false,
    externalDomainNames: ["string"],
    failureMessage: "string",
    footerColor: "string",
    functionalityIds: ["string"],
    gaTrackingId: "string",
    headerColor: "string",
    "public": false,
    publicDescription: "string",
    allowSearchEngineIndex: false,
    authenticationMethod: "string",
    samlIdpCert: "string",
    showUptimeLastDays: 0,
    samlIdpSsoServiceUrl: "string",
    samlNameIdentifierFormat: "string",
    sectionOrders: ["string"],
    samlIdpCertFingerprint: "string",
    showUptime: false,
    samlIdpSloServiceUrl: "string",
    slug: "string",
    successMessage: "string",
    timeZone: "string",
    authenticationEnabled: false,
    websitePrivacyUrl: "string",
    websiteSupportUrl: "string",
    websiteUrl: "string",
});

    type: rootly:StatusPage
properties:
    allowSearchEngineIndex: false
    authenticationEnabled: false
    authenticationMethod: string
    authenticationPassword: string
    description: string
    enabled: false
    externalDomainNames:
        - string
    failureMessage: string
    footerColor: string
    functionalityIds:
        - string
    gaTrackingId: string
    headerColor: string
    public: false
    publicDescription: string
    publicTitle: string
    samlIdpCert: string
    samlIdpCertFingerprint: string
    samlIdpSloServiceUrl: string
    samlIdpSsoServiceUrl: string
    samlNameIdentifierFormat: string
    sectionOrders:
        - string
    serviceIds:
        - string
    showUptime: false
    showUptimeLastDays: 0
    slug: string
    successMessage: string
    timeZone: string
    title: string
    websitePrivacyUrl: string
    websiteSupportUrl: string
    websiteUrl: string

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

    Title string
    The title of the status page
    AllowSearchEngineIndex bool
    Allow search engines to include your public status page in search results. Value must be one of true or false
    AuthenticationEnabled bool
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    AuthenticationMethod string
    Authentication method. Value must be one of none, password, saml.
    AuthenticationPassword string
    Authentication password
    Description string
    The description of the status page
    Enabled bool
    ExternalDomainNames List<string>
    External domain names attached to the status page
    FailureMessage string
    Message showing when at least one component is not operational
    FooterColor string
    The color of the footer. Eg. "#1F2F41"
    FunctionalityIds List<string>
    Functionalities attached to the status page
    GaTrackingId string
    Google Analytics tracking ID
    HeaderColor string
    The color of the header. Eg. "#0061F2"
    Public bool
    Make the status page accessible to the public. Value must be one of true or false
    PublicDescription string
    The public description of the status page
    PublicTitle string
    The public title of the status page
    SamlIdpCert string
    SAML IdP certificate
    SamlIdpCertFingerprint string
    SAML IdP certificate fingerprint
    SamlIdpSloServiceUrl string
    SAML IdP SLO service URL
    SamlIdpSsoServiceUrl string
    SAML IdP SSO service URL
    SamlNameIdentifierFormat string
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    SectionOrders List<string>
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    ServiceIds List<string>
    Services attached to the status page
    ShowUptime bool
    Show uptime. Value must be one of true or false
    ShowUptimeLastDays int
    Show uptime over x days. Value must be one of 30, 60, 90.
    Slug string
    The slug of the status page
    SuccessMessage string
    Message showing when all components are operational
    TimeZone string
    A valid IANA time zone name.
    WebsitePrivacyUrl string
    Website Privacy URL
    WebsiteSupportUrl string
    Website Support URL
    WebsiteUrl string
    Website URL
    Title string
    The title of the status page
    AllowSearchEngineIndex bool
    Allow search engines to include your public status page in search results. Value must be one of true or false
    AuthenticationEnabled bool
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    AuthenticationMethod string
    Authentication method. Value must be one of none, password, saml.
    AuthenticationPassword string
    Authentication password
    Description string
    The description of the status page
    Enabled bool
    ExternalDomainNames []string
    External domain names attached to the status page
    FailureMessage string
    Message showing when at least one component is not operational
    FooterColor string
    The color of the footer. Eg. "#1F2F41"
    FunctionalityIds []string
    Functionalities attached to the status page
    GaTrackingId string
    Google Analytics tracking ID
    HeaderColor string
    The color of the header. Eg. "#0061F2"
    Public bool
    Make the status page accessible to the public. Value must be one of true or false
    PublicDescription string
    The public description of the status page
    PublicTitle string
    The public title of the status page
    SamlIdpCert string
    SAML IdP certificate
    SamlIdpCertFingerprint string
    SAML IdP certificate fingerprint
    SamlIdpSloServiceUrl string
    SAML IdP SLO service URL
    SamlIdpSsoServiceUrl string
    SAML IdP SSO service URL
    SamlNameIdentifierFormat string
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    SectionOrders []string
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    ServiceIds []string
    Services attached to the status page
    ShowUptime bool
    Show uptime. Value must be one of true or false
    ShowUptimeLastDays int
    Show uptime over x days. Value must be one of 30, 60, 90.
    Slug string
    The slug of the status page
    SuccessMessage string
    Message showing when all components are operational
    TimeZone string
    A valid IANA time zone name.
    WebsitePrivacyUrl string
    Website Privacy URL
    WebsiteSupportUrl string
    Website Support URL
    WebsiteUrl string
    Website URL
    title String
    The title of the status page
    allowSearchEngineIndex Boolean
    Allow search engines to include your public status page in search results. Value must be one of true or false
    authenticationEnabled Boolean
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    authenticationMethod String
    Authentication method. Value must be one of none, password, saml.
    authenticationPassword String
    Authentication password
    description String
    The description of the status page
    enabled Boolean
    externalDomainNames List<String>
    External domain names attached to the status page
    failureMessage String
    Message showing when at least one component is not operational
    footerColor String
    The color of the footer. Eg. "#1F2F41"
    functionalityIds List<String>
    Functionalities attached to the status page
    gaTrackingId String
    Google Analytics tracking ID
    headerColor String
    The color of the header. Eg. "#0061F2"
    publicDescription String
    The public description of the status page
    publicTitle String
    The public title of the status page
    public_ Boolean
    Make the status page accessible to the public. Value must be one of true or false
    samlIdpCert String
    SAML IdP certificate
    samlIdpCertFingerprint String
    SAML IdP certificate fingerprint
    samlIdpSloServiceUrl String
    SAML IdP SLO service URL
    samlIdpSsoServiceUrl String
    SAML IdP SSO service URL
    samlNameIdentifierFormat String
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    sectionOrders List<String>
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    serviceIds List<String>
    Services attached to the status page
    showUptime Boolean
    Show uptime. Value must be one of true or false
    showUptimeLastDays Integer
    Show uptime over x days. Value must be one of 30, 60, 90.
    slug String
    The slug of the status page
    successMessage String
    Message showing when all components are operational
    timeZone String
    A valid IANA time zone name.
    websitePrivacyUrl String
    Website Privacy URL
    websiteSupportUrl String
    Website Support URL
    websiteUrl String
    Website URL
    title string
    The title of the status page
    allowSearchEngineIndex boolean
    Allow search engines to include your public status page in search results. Value must be one of true or false
    authenticationEnabled boolean
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    authenticationMethod string
    Authentication method. Value must be one of none, password, saml.
    authenticationPassword string
    Authentication password
    description string
    The description of the status page
    enabled boolean
    externalDomainNames string[]
    External domain names attached to the status page
    failureMessage string
    Message showing when at least one component is not operational
    footerColor string
    The color of the footer. Eg. "#1F2F41"
    functionalityIds string[]
    Functionalities attached to the status page
    gaTrackingId string
    Google Analytics tracking ID
    headerColor string
    The color of the header. Eg. "#0061F2"
    public boolean
    Make the status page accessible to the public. Value must be one of true or false
    publicDescription string
    The public description of the status page
    publicTitle string
    The public title of the status page
    samlIdpCert string
    SAML IdP certificate
    samlIdpCertFingerprint string
    SAML IdP certificate fingerprint
    samlIdpSloServiceUrl string
    SAML IdP SLO service URL
    samlIdpSsoServiceUrl string
    SAML IdP SSO service URL
    samlNameIdentifierFormat string
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    sectionOrders string[]
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    serviceIds string[]
    Services attached to the status page
    showUptime boolean
    Show uptime. Value must be one of true or false
    showUptimeLastDays number
    Show uptime over x days. Value must be one of 30, 60, 90.
    slug string
    The slug of the status page
    successMessage string
    Message showing when all components are operational
    timeZone string
    A valid IANA time zone name.
    websitePrivacyUrl string
    Website Privacy URL
    websiteSupportUrl string
    Website Support URL
    websiteUrl string
    Website URL
    title str
    The title of the status page
    allow_search_engine_index bool
    Allow search engines to include your public status page in search results. Value must be one of true or false
    authentication_enabled bool
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    authentication_method str
    Authentication method. Value must be one of none, password, saml.
    authentication_password str
    Authentication password
    description str
    The description of the status page
    enabled bool
    external_domain_names Sequence[str]
    External domain names attached to the status page
    failure_message str
    Message showing when at least one component is not operational
    footer_color str
    The color of the footer. Eg. "#1F2F41"
    functionality_ids Sequence[str]
    Functionalities attached to the status page
    ga_tracking_id str
    Google Analytics tracking ID
    header_color str
    The color of the header. Eg. "#0061F2"
    public bool
    Make the status page accessible to the public. Value must be one of true or false
    public_description str
    The public description of the status page
    public_title str
    The public title of the status page
    saml_idp_cert str
    SAML IdP certificate
    saml_idp_cert_fingerprint str
    SAML IdP certificate fingerprint
    saml_idp_slo_service_url str
    SAML IdP SLO service URL
    saml_idp_sso_service_url str
    SAML IdP SSO service URL
    saml_name_identifier_format str
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    section_orders Sequence[str]
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    service_ids Sequence[str]
    Services attached to the status page
    show_uptime bool
    Show uptime. Value must be one of true or false
    show_uptime_last_days int
    Show uptime over x days. Value must be one of 30, 60, 90.
    slug str
    The slug of the status page
    success_message str
    Message showing when all components are operational
    time_zone str
    A valid IANA time zone name.
    website_privacy_url str
    Website Privacy URL
    website_support_url str
    Website Support URL
    website_url str
    Website URL
    title String
    The title of the status page
    allowSearchEngineIndex Boolean
    Allow search engines to include your public status page in search results. Value must be one of true or false
    authenticationEnabled Boolean
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    authenticationMethod String
    Authentication method. Value must be one of none, password, saml.
    authenticationPassword String
    Authentication password
    description String
    The description of the status page
    enabled Boolean
    externalDomainNames List<String>
    External domain names attached to the status page
    failureMessage String
    Message showing when at least one component is not operational
    footerColor String
    The color of the footer. Eg. "#1F2F41"
    functionalityIds List<String>
    Functionalities attached to the status page
    gaTrackingId String
    Google Analytics tracking ID
    headerColor String
    The color of the header. Eg. "#0061F2"
    public Boolean
    Make the status page accessible to the public. Value must be one of true or false
    publicDescription String
    The public description of the status page
    publicTitle String
    The public title of the status page
    samlIdpCert String
    SAML IdP certificate
    samlIdpCertFingerprint String
    SAML IdP certificate fingerprint
    samlIdpSloServiceUrl String
    SAML IdP SLO service URL
    samlIdpSsoServiceUrl String
    SAML IdP SSO service URL
    samlNameIdentifierFormat String
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    sectionOrders List<String>
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    serviceIds List<String>
    Services attached to the status page
    showUptime Boolean
    Show uptime. Value must be one of true or false
    showUptimeLastDays Number
    Show uptime over x days. Value must be one of 30, 60, 90.
    slug String
    The slug of the status page
    successMessage String
    Message showing when all components are operational
    timeZone String
    A valid IANA time zone name.
    websitePrivacyUrl String
    Website Privacy URL
    websiteSupportUrl String
    Website Support URL
    websiteUrl String
    Website URL

    Outputs

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

    CnameRecords Dictionary<string, string>
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    Id string
    The provider-assigned unique ID for this managed resource.
    CnameRecords map[string]string
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    Id string
    The provider-assigned unique ID for this managed resource.
    cnameRecords Map<String,String>
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    id String
    The provider-assigned unique ID for this managed resource.
    cnameRecords {[key: string]: string}
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    id string
    The provider-assigned unique ID for this managed resource.
    cname_records Mapping[str, str]
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    id str
    The provider-assigned unique ID for this managed resource.
    cnameRecords Map<String>
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing StatusPage Resource

    Get an existing StatusPage 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?: StatusPageState, opts?: CustomResourceOptions): StatusPage
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        allow_search_engine_index: Optional[bool] = None,
        authentication_enabled: Optional[bool] = None,
        authentication_method: Optional[str] = None,
        authentication_password: Optional[str] = None,
        cname_records: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        enabled: Optional[bool] = None,
        external_domain_names: Optional[Sequence[str]] = None,
        failure_message: Optional[str] = None,
        footer_color: Optional[str] = None,
        functionality_ids: Optional[Sequence[str]] = None,
        ga_tracking_id: Optional[str] = None,
        header_color: Optional[str] = None,
        public: Optional[bool] = None,
        public_description: Optional[str] = None,
        public_title: Optional[str] = None,
        saml_idp_cert: Optional[str] = None,
        saml_idp_cert_fingerprint: Optional[str] = None,
        saml_idp_slo_service_url: Optional[str] = None,
        saml_idp_sso_service_url: Optional[str] = None,
        saml_name_identifier_format: Optional[str] = None,
        section_orders: Optional[Sequence[str]] = None,
        service_ids: Optional[Sequence[str]] = None,
        show_uptime: Optional[bool] = None,
        show_uptime_last_days: Optional[int] = None,
        slug: Optional[str] = None,
        success_message: Optional[str] = None,
        time_zone: Optional[str] = None,
        title: Optional[str] = None,
        website_privacy_url: Optional[str] = None,
        website_support_url: Optional[str] = None,
        website_url: Optional[str] = None) -> StatusPage
    func GetStatusPage(ctx *Context, name string, id IDInput, state *StatusPageState, opts ...ResourceOption) (*StatusPage, error)
    public static StatusPage Get(string name, Input<string> id, StatusPageState? state, CustomResourceOptions? opts = null)
    public static StatusPage get(String name, Output<String> id, StatusPageState state, CustomResourceOptions options)
    resources:  _:    type: rootly:StatusPage    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:
    AllowSearchEngineIndex bool
    Allow search engines to include your public status page in search results. Value must be one of true or false
    AuthenticationEnabled bool
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    AuthenticationMethod string
    Authentication method. Value must be one of none, password, saml.
    AuthenticationPassword string
    Authentication password
    CnameRecords Dictionary<string, string>
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    Description string
    The description of the status page
    Enabled bool
    ExternalDomainNames List<string>
    External domain names attached to the status page
    FailureMessage string
    Message showing when at least one component is not operational
    FooterColor string
    The color of the footer. Eg. "#1F2F41"
    FunctionalityIds List<string>
    Functionalities attached to the status page
    GaTrackingId string
    Google Analytics tracking ID
    HeaderColor string
    The color of the header. Eg. "#0061F2"
    Public bool
    Make the status page accessible to the public. Value must be one of true or false
    PublicDescription string
    The public description of the status page
    PublicTitle string
    The public title of the status page
    SamlIdpCert string
    SAML IdP certificate
    SamlIdpCertFingerprint string
    SAML IdP certificate fingerprint
    SamlIdpSloServiceUrl string
    SAML IdP SLO service URL
    SamlIdpSsoServiceUrl string
    SAML IdP SSO service URL
    SamlNameIdentifierFormat string
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    SectionOrders List<string>
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    ServiceIds List<string>
    Services attached to the status page
    ShowUptime bool
    Show uptime. Value must be one of true or false
    ShowUptimeLastDays int
    Show uptime over x days. Value must be one of 30, 60, 90.
    Slug string
    The slug of the status page
    SuccessMessage string
    Message showing when all components are operational
    TimeZone string
    A valid IANA time zone name.
    Title string
    The title of the status page
    WebsitePrivacyUrl string
    Website Privacy URL
    WebsiteSupportUrl string
    Website Support URL
    WebsiteUrl string
    Website URL
    AllowSearchEngineIndex bool
    Allow search engines to include your public status page in search results. Value must be one of true or false
    AuthenticationEnabled bool
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    AuthenticationMethod string
    Authentication method. Value must be one of none, password, saml.
    AuthenticationPassword string
    Authentication password
    CnameRecords map[string]string
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    Description string
    The description of the status page
    Enabled bool
    ExternalDomainNames []string
    External domain names attached to the status page
    FailureMessage string
    Message showing when at least one component is not operational
    FooterColor string
    The color of the footer. Eg. "#1F2F41"
    FunctionalityIds []string
    Functionalities attached to the status page
    GaTrackingId string
    Google Analytics tracking ID
    HeaderColor string
    The color of the header. Eg. "#0061F2"
    Public bool
    Make the status page accessible to the public. Value must be one of true or false
    PublicDescription string
    The public description of the status page
    PublicTitle string
    The public title of the status page
    SamlIdpCert string
    SAML IdP certificate
    SamlIdpCertFingerprint string
    SAML IdP certificate fingerprint
    SamlIdpSloServiceUrl string
    SAML IdP SLO service URL
    SamlIdpSsoServiceUrl string
    SAML IdP SSO service URL
    SamlNameIdentifierFormat string
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    SectionOrders []string
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    ServiceIds []string
    Services attached to the status page
    ShowUptime bool
    Show uptime. Value must be one of true or false
    ShowUptimeLastDays int
    Show uptime over x days. Value must be one of 30, 60, 90.
    Slug string
    The slug of the status page
    SuccessMessage string
    Message showing when all components are operational
    TimeZone string
    A valid IANA time zone name.
    Title string
    The title of the status page
    WebsitePrivacyUrl string
    Website Privacy URL
    WebsiteSupportUrl string
    Website Support URL
    WebsiteUrl string
    Website URL
    allowSearchEngineIndex Boolean
    Allow search engines to include your public status page in search results. Value must be one of true or false
    authenticationEnabled Boolean
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    authenticationMethod String
    Authentication method. Value must be one of none, password, saml.
    authenticationPassword String
    Authentication password
    cnameRecords Map<String,String>
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    description String
    The description of the status page
    enabled Boolean
    externalDomainNames List<String>
    External domain names attached to the status page
    failureMessage String
    Message showing when at least one component is not operational
    footerColor String
    The color of the footer. Eg. "#1F2F41"
    functionalityIds List<String>
    Functionalities attached to the status page
    gaTrackingId String
    Google Analytics tracking ID
    headerColor String
    The color of the header. Eg. "#0061F2"
    publicDescription String
    The public description of the status page
    publicTitle String
    The public title of the status page
    public_ Boolean
    Make the status page accessible to the public. Value must be one of true or false
    samlIdpCert String
    SAML IdP certificate
    samlIdpCertFingerprint String
    SAML IdP certificate fingerprint
    samlIdpSloServiceUrl String
    SAML IdP SLO service URL
    samlIdpSsoServiceUrl String
    SAML IdP SSO service URL
    samlNameIdentifierFormat String
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    sectionOrders List<String>
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    serviceIds List<String>
    Services attached to the status page
    showUptime Boolean
    Show uptime. Value must be one of true or false
    showUptimeLastDays Integer
    Show uptime over x days. Value must be one of 30, 60, 90.
    slug String
    The slug of the status page
    successMessage String
    Message showing when all components are operational
    timeZone String
    A valid IANA time zone name.
    title String
    The title of the status page
    websitePrivacyUrl String
    Website Privacy URL
    websiteSupportUrl String
    Website Support URL
    websiteUrl String
    Website URL
    allowSearchEngineIndex boolean
    Allow search engines to include your public status page in search results. Value must be one of true or false
    authenticationEnabled boolean
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    authenticationMethod string
    Authentication method. Value must be one of none, password, saml.
    authenticationPassword string
    Authentication password
    cnameRecords {[key: string]: string}
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    description string
    The description of the status page
    enabled boolean
    externalDomainNames string[]
    External domain names attached to the status page
    failureMessage string
    Message showing when at least one component is not operational
    footerColor string
    The color of the footer. Eg. "#1F2F41"
    functionalityIds string[]
    Functionalities attached to the status page
    gaTrackingId string
    Google Analytics tracking ID
    headerColor string
    The color of the header. Eg. "#0061F2"
    public boolean
    Make the status page accessible to the public. Value must be one of true or false
    publicDescription string
    The public description of the status page
    publicTitle string
    The public title of the status page
    samlIdpCert string
    SAML IdP certificate
    samlIdpCertFingerprint string
    SAML IdP certificate fingerprint
    samlIdpSloServiceUrl string
    SAML IdP SLO service URL
    samlIdpSsoServiceUrl string
    SAML IdP SSO service URL
    samlNameIdentifierFormat string
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    sectionOrders string[]
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    serviceIds string[]
    Services attached to the status page
    showUptime boolean
    Show uptime. Value must be one of true or false
    showUptimeLastDays number
    Show uptime over x days. Value must be one of 30, 60, 90.
    slug string
    The slug of the status page
    successMessage string
    Message showing when all components are operational
    timeZone string
    A valid IANA time zone name.
    title string
    The title of the status page
    websitePrivacyUrl string
    Website Privacy URL
    websiteSupportUrl string
    Website Support URL
    websiteUrl string
    Website URL
    allow_search_engine_index bool
    Allow search engines to include your public status page in search results. Value must be one of true or false
    authentication_enabled bool
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    authentication_method str
    Authentication method. Value must be one of none, password, saml.
    authentication_password str
    Authentication password
    cname_records Mapping[str, str]
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    description str
    The description of the status page
    enabled bool
    external_domain_names Sequence[str]
    External domain names attached to the status page
    failure_message str
    Message showing when at least one component is not operational
    footer_color str
    The color of the footer. Eg. "#1F2F41"
    functionality_ids Sequence[str]
    Functionalities attached to the status page
    ga_tracking_id str
    Google Analytics tracking ID
    header_color str
    The color of the header. Eg. "#0061F2"
    public bool
    Make the status page accessible to the public. Value must be one of true or false
    public_description str
    The public description of the status page
    public_title str
    The public title of the status page
    saml_idp_cert str
    SAML IdP certificate
    saml_idp_cert_fingerprint str
    SAML IdP certificate fingerprint
    saml_idp_slo_service_url str
    SAML IdP SLO service URL
    saml_idp_sso_service_url str
    SAML IdP SSO service URL
    saml_name_identifier_format str
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    section_orders Sequence[str]
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    service_ids Sequence[str]
    Services attached to the status page
    show_uptime bool
    Show uptime. Value must be one of true or false
    show_uptime_last_days int
    Show uptime over x days. Value must be one of 30, 60, 90.
    slug str
    The slug of the status page
    success_message str
    Message showing when all components are operational
    time_zone str
    A valid IANA time zone name.
    title str
    The title of the status page
    website_privacy_url str
    Website Privacy URL
    website_support_url str
    Website Support URL
    website_url str
    Website URL
    allowSearchEngineIndex Boolean
    Allow search engines to include your public status page in search results. Value must be one of true or false
    authenticationEnabled Boolean
    Enable authentication (deprecated - use authenticationMethod instead). Value must be one of true or false
    authenticationMethod String
    Authentication method. Value must be one of none, password, saml.
    authenticationPassword String
    Authentication password
    cnameRecords Map<String>
    CNAME records mapping external domain names to their DNS target values. Populated asynchronously after setting externaldomainnames.
    description String
    The description of the status page
    enabled Boolean
    externalDomainNames List<String>
    External domain names attached to the status page
    failureMessage String
    Message showing when at least one component is not operational
    footerColor String
    The color of the footer. Eg. "#1F2F41"
    functionalityIds List<String>
    Functionalities attached to the status page
    gaTrackingId String
    Google Analytics tracking ID
    headerColor String
    The color of the header. Eg. "#0061F2"
    public Boolean
    Make the status page accessible to the public. Value must be one of true or false
    publicDescription String
    The public description of the status page
    publicTitle String
    The public title of the status page
    samlIdpCert String
    SAML IdP certificate
    samlIdpCertFingerprint String
    SAML IdP certificate fingerprint
    samlIdpSloServiceUrl String
    SAML IdP SLO service URL
    samlIdpSsoServiceUrl String
    SAML IdP SSO service URL
    samlNameIdentifierFormat String
    SAML name identifier format. Value must be one of urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress, urn:oasis:names:tc:SAML:2.0:nameid-format:persistent, urn:oasis:names:tc:SAML:2.0:nameid-format:transient, urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.
    sectionOrders List<String>
    Order of sections on the status page. Value must be a list of maintenance, systemStatus, incidents.
    serviceIds List<String>
    Services attached to the status page
    showUptime Boolean
    Show uptime. Value must be one of true or false
    showUptimeLastDays Number
    Show uptime over x days. Value must be one of 30, 60, 90.
    slug String
    The slug of the status page
    successMessage String
    Message showing when all components are operational
    timeZone String
    A valid IANA time zone name.
    title String
    The title of the status page
    websitePrivacyUrl String
    Website Privacy URL
    websiteSupportUrl String
    Website Support URL
    websiteUrl String
    Website URL

    Import

    rootly.StatusPage can be imported using the import command.

    $ pulumi import rootly:index/statusPage:StatusPage primary a816421c-6ceb-481a-87c4-585e47451f24

    Or using an import block.

    Locate the resource id in the web app, or retrieve it by listing resources through the API if it’s not visible in the web app.

    HCL can be generated from the import block using the -generate-config-out flag.

    pulumi preview -generate-config-out=generated.tf

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    rootly rootlyhq/pulumi-rootly
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the rootly Terraform Provider.
    rootly logo
    Viewing docs for Rootly v3.3.0
    published on Thursday, May 7, 2026 by rootlyhq
    Schema (JSON)
    rootlyhq/pulumi-rootly
      Try Pulumi Cloud free. Your team will thank you.