1. Registry
  2. Packages
  3. Incident Provider
  4. API Docs
  5. getIpAllowlist
Viewing docs for incident 7.0.0
published on Friday, Sep 11, 2026 by incident-io
Viewing docs for incident 7.0.0
published on Friday, Sep 11, 2026 by incident-io

    Manage the IP allowlist.

    When enabled, the IP allowlist restricts authenticated traffic from the dashboard, public API and mobile app.

    Use this data source to read the organisation’s IP allowlist: whether it is enabled, and the IP addresses or CIDR prefixes that are allowed to reach the dashboard, public API and mobile app.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as incident from "@pulumi/incident";
    
    // Read the organisation's IP allowlist.
    const current = incident.getIpAllowlist({});
    export const allowedAddresses = current.then(current => .map(item => (item.value)));
    
    import pulumi
    import pulumi_incident as incident
    
    # Read the organisation's IP allowlist.
    current = incident.get_ip_allowlist()
    pulumi.export("allowedAddresses", [item.value for item in current.allowlists])
    
    Example coming soon!
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Incident = Pulumi.Incident;
    
    return await Deployment.RunAsync(() => 
    {
        // Read the organisation's IP allowlist.
        var current = Incident.GetIpAllowlist.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["allowedAddresses"] = .Select(item => 
            {
                return item.Value;
            }).ToList(),
        };
    });
    
    Example coming soon!
    
    Example coming soon!
    
    Example coming soon!
    

    Using getIpAllowlist

    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 getIpAllowlist(opts?: InvokeOptions): Promise<GetIpAllowlistResult>
    function getIpAllowlistOutput(opts?: InvokeOutputOptions): Output<GetIpAllowlistResult>
    def get_ip_allowlist(opts: Optional[InvokeOptions] = None) -> GetIpAllowlistResult
    def get_ip_allowlist_output(opts: Optional[InvokeOutputOptions] = None) -> Output[GetIpAllowlistResult]
    func GetIpAllowlist(ctx *Context, opts ...InvokeOption) (*GetIpAllowlistResult, error)
    func GetIpAllowlistOutput(ctx *Context, opts ...InvokeOption) GetIpAllowlistResultOutput

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

    public static class GetIpAllowlist 
    {
        public static Task<GetIpAllowlistResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetIpAllowlistResult> Invoke(InvokeOptions? opts = null)
        public static Output<GetIpAllowlistResult> Invoke(InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetIpAllowlistResult> getIpAllowlist(InvokeOptions options)
    public static Output<GetIpAllowlistResult> getIpAllowlist(InvokeOptions options)
    public static Output<GetIpAllowlistResult> getIpAllowlist(InvokeOutputOptions options)
    
    fn::invoke:
      function: incident:index/getIpAllowlist:getIpAllowlist
      arguments:
        # arguments dictionary
    data "incident_get_ip_allowlist" "name" {
        # arguments
    }

    getIpAllowlist Result

    The following output properties are available:

    Allowlists List<GetIpAllowlistAllowlist>
    A list of IP addresses or CIDR prefixes to allow
    Enabled bool
    Whether this IP allowlist is enabled or not
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The time this allowlist was last updated
    Version double
    The version of this IP allowlist
    Allowlists []GetIpAllowlistAllowlist
    A list of IP addresses or CIDR prefixes to allow
    Enabled bool
    Whether this IP allowlist is enabled or not
    Id string
    The provider-assigned unique ID for this managed resource.
    UpdatedAt string
    The time this allowlist was last updated
    Version float64
    The version of this IP allowlist
    allowlists list(object)
    A list of IP addresses or CIDR prefixes to allow
    enabled bool
    Whether this IP allowlist is enabled or not
    id string
    The provider-assigned unique ID for this managed resource.
    updated_at string
    The time this allowlist was last updated
    version number
    The version of this IP allowlist
    allowlists List<GetIpAllowlistAllowlist>
    A list of IP addresses or CIDR prefixes to allow
    enabled Boolean
    Whether this IP allowlist is enabled or not
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The time this allowlist was last updated
    version Double
    The version of this IP allowlist
    allowlists GetIpAllowlistAllowlist[]
    A list of IP addresses or CIDR prefixes to allow
    enabled boolean
    Whether this IP allowlist is enabled or not
    id string
    The provider-assigned unique ID for this managed resource.
    updatedAt string
    The time this allowlist was last updated
    version number
    The version of this IP allowlist
    allowlists Sequence[GetIpAllowlistAllowlist]
    A list of IP addresses or CIDR prefixes to allow
    enabled bool
    Whether this IP allowlist is enabled or not
    id str
    The provider-assigned unique ID for this managed resource.
    updated_at str
    The time this allowlist was last updated
    version float
    The version of this IP allowlist
    allowlists List<Property Map>
    A list of IP addresses or CIDR prefixes to allow
    enabled Boolean
    Whether this IP allowlist is enabled or not
    id String
    The provider-assigned unique ID for this managed resource.
    updatedAt String
    The time this allowlist was last updated
    version Number
    The version of this IP allowlist

    Supporting Types

    GetIpAllowlistAllowlist

    Label string
    A label to help identify this IP or prefix
    Value string
    An IP address or a CIDR IP prefix to allow
    Label string
    A label to help identify this IP or prefix
    Value string
    An IP address or a CIDR IP prefix to allow
    label string
    A label to help identify this IP or prefix
    value string
    An IP address or a CIDR IP prefix to allow
    label String
    A label to help identify this IP or prefix
    value String
    An IP address or a CIDR IP prefix to allow
    label string
    A label to help identify this IP or prefix
    value string
    An IP address or a CIDR IP prefix to allow
    label str
    A label to help identify this IP or prefix
    value str
    An IP address or a CIDR IP prefix to allow
    label String
    A label to help identify this IP or prefix
    value String
    An IP address or a CIDR IP prefix to allow

    Package Details

    Repository
    incident incident-io/terraform-provider-incident
    License
    Notes
    This Pulumi package is based on the incident Terraform Provider.
    Viewing docs for incident 7.0.0
    published on Friday, Sep 11, 2026 by incident-io

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial