1. Registry
  2. Packages
  3. incident.io
  4. API Docs
  5. getStatusPageComponent
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 component by id, such as one created in the incident.io dashboard, without managing it as an incident.StatusPageComponent resource.

    Only live components can be found; the API does not return archived ones. Any valid API key can read components, and no specific permission is needed.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as incident from "@incident-io/pulumi";
    
    // Look up a status page component by ID, such as one created in the dashboard.
    const api = incident.getStatusPageComponent({
        id: "01FCNDV6P870EA6S7TK1DSYDG1",
    });
    export const apiComponentName = api.then(api => api.name);
    
    import pulumi
    import pulumi_incident as incident
    
    # Look up a status page component by ID, such as one created in the dashboard.
    api = incident.get_status_page_component(id="01FCNDV6P870EA6S7TK1DSYDG1")
    pulumi.export("apiComponentName", api.name)
    
    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 component by ID, such as one created in the dashboard.
    		api, err := incident.GetStatusPageComponent(ctx, &incident.LookupStatusPageComponentArgs{
    			Id: "01FCNDV6P870EA6S7TK1DSYDG1",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("apiComponentName", api.Name)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Incident = Pulumi.Incident;
    
    return await Deployment.RunAsync(() => 
    {
        // Look up a status page component by ID, such as one created in the dashboard.
        var api = Incident.GetStatusPageComponent.Invoke(new()
        {
            Id = "01FCNDV6P870EA6S7TK1DSYDG1",
        });
    
        return new Dictionary<string, object?>
        {
            ["apiComponentName"] = api.Apply(getStatusPageComponentResult => getStatusPageComponentResult.Name),
        };
    });
    
    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.GetStatusPageComponentArgs;
    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 component by ID, such as one created in the dashboard.
            final var api = IncidentFunctions.getStatusPageComponent(GetStatusPageComponentArgs.builder()
                .id("01FCNDV6P870EA6S7TK1DSYDG1")
                .build());
    
            ctx.export("apiComponentName", api.name());
        }
    }
    
    variables:
      # Look up a status page component by ID, such as one created in the dashboard.
      api:
        fn::invoke:
          function: incident:getStatusPageComponent
          arguments:
            id: 01FCNDV6P870EA6S7TK1DSYDG1
    outputs:
      apiComponentName: ${api.name}
    
    pulumi {
      required_providers {
        incident = {
          source = "pulumi/incident"
        }
      }
    }
    
    data "incident_getstatuspagecomponent" "api" {
      id = "01FCNDV6P870EA6S7TK1DSYDG1"
    }
    
    # Look up a status page component by ID, such as one created in the dashboard.
    output "apiComponentName" {
      value = data.incident_getstatuspagecomponent.api.name
    }
    

    Using getStatusPageComponent

    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 getStatusPageComponent(args: GetStatusPageComponentArgs, opts?: InvokeOptions): Promise<GetStatusPageComponentResult>
    function getStatusPageComponentOutput(args: GetStatusPageComponentOutputArgs, opts?: InvokeOutputOptions): Output<GetStatusPageComponentResult>
    def get_status_page_component(id: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetStatusPageComponentResult
    def get_status_page_component_output(id: pulumi.Input[Optional[str]] = None,
                                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetStatusPageComponentResult]
    func LookupStatusPageComponent(ctx *Context, args *LookupStatusPageComponentArgs, opts ...InvokeOption) (*LookupStatusPageComponentResult, error)
    func LookupStatusPageComponentOutput(ctx *Context, args *LookupStatusPageComponentOutputArgs, opts ...InvokeOption) LookupStatusPageComponentResultOutput

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

    public static class GetStatusPageComponent 
    {
        public static Task<GetStatusPageComponentResult> InvokeAsync(GetStatusPageComponentArgs args, InvokeOptions? opts = null)
        public static Output<GetStatusPageComponentResult> Invoke(GetStatusPageComponentInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetStatusPageComponentResult> Invoke(GetStatusPageComponentInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetStatusPageComponentResult> getStatusPageComponent(GetStatusPageComponentArgs args, InvokeOptions options)
    public static Output<GetStatusPageComponentResult> getStatusPageComponent(GetStatusPageComponentArgs args, InvokeOptions options)
    public static Output<GetStatusPageComponentResult> getStatusPageComponent(GetStatusPageComponentArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: incident:index/getStatusPageComponent:getStatusPageComponent
      arguments:
        # arguments dictionary
    data "incident_get_status_page_component" "name" {
        # arguments
    }

    The following arguments are supported:

    Id string
    Unique identifier for this component
    Id string
    Unique identifier for this component
    id string
    Unique identifier for this component
    id String
    Unique identifier for this component
    id string
    Unique identifier for this component
    id str
    Unique identifier for this component
    id String
    Unique identifier for this component

    getStatusPageComponent Result

    The following output properties are available:

    Description string
    Optional short description of this component. Null when the component has none.
    Id string
    Unique identifier for this component
    Name string
    Human-readable name for the component
    Description string
    Optional short description of this component. Null when the component has none.
    Id string
    Unique identifier for this component
    Name string
    Human-readable name for the component
    description string
    Optional short description of this component. Null when the component has none.
    id string
    Unique identifier for this component
    name string
    Human-readable name for the component
    description String
    Optional short description of this component. Null when the component has none.
    id String
    Unique identifier for this component
    name String
    Human-readable name for the component
    description string
    Optional short description of this component. Null when the component has none.
    id string
    Unique identifier for this component
    name string
    Human-readable name for the component
    description str
    Optional short description of this component. Null when the component has none.
    id str
    Unique identifier for this component
    name str
    Human-readable name for the component
    description String
    Optional short description of this component. Null when the component has none.
    id String
    Unique identifier for this component
    name String
    Human-readable name for the component

    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