1. Registry
  2. Packages
  3. incident.io
  4. API Docs
  5. getStatusPage
Viewing docs for incident.io v0.4.1
published on Wednesday, Oct 21, 2026 by incident-io
incident logo incident.io
Viewing docs for incident.io v0.4.1
published on Wednesday, Oct 21, 2026 by incident-io

    Look up a status page, either by id or by name. Set exactly one of the two lookup attributes; setting both, or neither, is rejected at plan time.

    Status pages are created in the incident.io dashboard rather than through the API, so there is no incident.getStatusPage resource. Use this data source to reference one from configuration, such as to pass its id to a workflow or an alert route. Any valid API key can read status pages; no specific scope is needed.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as incident from "@incident-io/pulumi";
    
    // Look up a status page by name, as it was created in the dashboard.
    const _public = incident.getStatusPage({
        name: "Our public status page",
    });
    // Or by ID, taken from the dashboard URL or the ListStatusPages endpoint.
    const customer = incident.getStatusPage({
        id: "01FCNDV6P870EA6S7TK1DSYDG0",
    });
    export const publicStatusPageUrl = _public.then(_public => _public.publicUrl);
    
    import pulumi
    import pulumi_incident as incident
    
    # Look up a status page by name, as it was created in the dashboard.
    public = incident.get_status_page(name="Our public status page")
    # Or by ID, taken from the dashboard URL or the ListStatusPages endpoint.
    customer = incident.get_status_page(id="01FCNDV6P870EA6S7TK1DSYDG0")
    pulumi.export("publicStatusPageUrl", public.public_url)
    
    package main
    
    import (
    	"github.com/incident-io/pulumi-incident/sdk/go/incident"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		// Look up a status page by name, as it was created in the dashboard.
    		public, err := incident.GetStatusPage(ctx, &incident.GetStatusPageArgs{
    			Name: pulumi.StringRef("Our public status page"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		// Or by ID, taken from the dashboard URL or the ListStatusPages endpoint.
    		_, err = incident.GetStatusPage(ctx, &incident.GetStatusPageArgs{
    			Id: pulumi.StringRef("01FCNDV6P870EA6S7TK1DSYDG0"),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("publicStatusPageUrl", public.PublicUrl)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Incident = Pulumi.Incident;
    
    return await Deployment.RunAsync(() => 
    {
        // Look up a status page by name, as it was created in the dashboard.
        var @public = Incident.GetStatusPage.Invoke(new()
        {
            Name = "Our public status page",
        });
    
        // Or by ID, taken from the dashboard URL or the ListStatusPages endpoint.
        var customer = Incident.GetStatusPage.Invoke(new()
        {
            Id = "01FCNDV6P870EA6S7TK1DSYDG0",
        });
    
        return new Dictionary<string, object?>
        {
            ["publicStatusPageUrl"] = @public.Apply(@public => @public.Apply(getStatusPageResult => getStatusPageResult.PublicUrl)),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.incident.IncidentFunctions;
    import com.pulumi.incident.inputs.GetStatusPageArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            // Look up a status page by name, as it was created in the dashboard.
            final var public = IncidentFunctions.getStatusPage(GetStatusPageArgs.builder()
                .name("Our public status page")
                .build());
    
            // Or by ID, taken from the dashboard URL or the ListStatusPages endpoint.
            final var customer = IncidentFunctions.getStatusPage(GetStatusPageArgs.builder()
                .id("01FCNDV6P870EA6S7TK1DSYDG0")
                .build());
    
            ctx.export("publicStatusPageUrl", public_.publicUrl());
        }
    }
    
    variables:
      # Look up a status page by name, as it was created in the dashboard.
      public:
        fn::invoke:
          function: incident:getStatusPage
          arguments:
            name: Our public status page
      # Or by ID, taken from the dashboard URL or the ListStatusPages endpoint.
      customer:
        fn::invoke:
          function: incident:getStatusPage
          arguments:
            id: 01FCNDV6P870EA6S7TK1DSYDG0
    outputs:
      publicStatusPageUrl: ${public.publicUrl}
    
    pulumi {
      required_providers {
        incident = {
          source = "pulumi/incident"
        }
      }
    }
    
    data "incident_getstatuspage" "public" {
      name = "Our public status page"
    }
    data "incident_getstatuspage" "customer" {
      id = "01FCNDV6P870EA6S7TK1DSYDG0"
    }
    
    # Look up a status page by name, as it was created in the dashboard.
    # Or by ID, taken from the dashboard URL or the ListStatusPages endpoint.
    output "publicStatusPageUrl" {
      value = data.incident_getstatuspage.public.public_url
    }
    

    Using getStatusPage

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

    function getStatusPage(args: GetStatusPageArgs, opts?: InvokeOptions): Promise<GetStatusPageResult>
    function getStatusPageOutput(args: GetStatusPageOutputArgs, opts?: InvokeOutputOptions): Output<GetStatusPageResult>
    def get_status_page(id: Optional[str] = None,
                        name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetStatusPageResult
    def get_status_page_output(id: pulumi.Input[Optional[str]] = None,
                        name: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetStatusPageResult]
    func GetStatusPage(ctx *Context, args *GetStatusPageArgs, opts ...InvokeOption) (*GetStatusPageResult, error)
    func GetStatusPageOutput(ctx *Context, args *GetStatusPageOutputArgs, opts ...InvokeOption) GetStatusPageResultOutput

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

    public static class GetStatusPage 
    {
        public static Task<GetStatusPageResult> InvokeAsync(GetStatusPageArgs args, InvokeOptions? opts = null)
        public static Output<GetStatusPageResult> Invoke(GetStatusPageInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetStatusPageResult> Invoke(GetStatusPageInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetStatusPageResult> getStatusPage(GetStatusPageArgs args, InvokeOptions options)
    public static Output<GetStatusPageResult> getStatusPage(GetStatusPageArgs args, InvokeOptions options)
    public static Output<GetStatusPageResult> getStatusPage(GetStatusPageArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: incident:index/getStatusPage:getStatusPage
      arguments:
        # arguments dictionary
    data "incident_get_status_page" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Unique ID of this status page
    Name string
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    Id string
    Unique ID of this status page
    Name string
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    id string
    Unique ID of this status page
    name string
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    id String
    Unique ID of this status page
    name String
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    id string
    Unique ID of this status page
    name string
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    id str
    Unique ID of this status page
    name str
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    id String
    Unique ID of this status page
    name String
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.

    getStatusPage Result

    The following output properties are available:

    Description string
    The description of this status page. Null when the page has none.
    Id string
    Unique ID of this status page
    Name string
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    PublicUrl string
    The public URL of this status page. Null when the page has no public URL yet.
    Description string
    The description of this status page. Null when the page has none.
    Id string
    Unique ID of this status page
    Name string
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    PublicUrl string
    The public URL of this status page. Null when the page has no public URL yet.
    description string
    The description of this status page. Null when the page has none.
    id string
    Unique ID of this status page
    name string
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    public_url string
    The public URL of this status page. Null when the page has no public URL yet.
    description String
    The description of this status page. Null when the page has none.
    id String
    Unique ID of this status page
    name String
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    publicUrl String
    The public URL of this status page. Null when the page has no public URL yet.
    description string
    The description of this status page. Null when the page has none.
    id string
    Unique ID of this status page
    name string
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    publicUrl string
    The public URL of this status page. Null when the page has no public URL yet.
    description str
    The description of this status page. Null when the page has none.
    id str
    Unique ID of this status page
    name str
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    public_url str
    The public URL of this status page. Null when the page has no public URL yet.
    description String
    The description of this status page. Null when the page has none.
    id String
    Unique ID of this status page
    name String
    The title of this status page. Names aren't unique, so a lookup fails if more than one status page matches.
    publicUrl String
    The public URL of this status page. Null when the page has no public URL yet.

    Package Details

    Repository
    incident incident-io/pulumi-incident
    License
    MIT
    Notes
    This Pulumi package is based on the incident Terraform Provider.
    incident logo incident.io
    Viewing docs for incident.io v0.4.1
    published on Wednesday, Oct 21, 2026 by incident-io

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial