1. Packages
  2. stackit
  3. API Docs
  4. getNetwork
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud
stackit logo
Viewing docs for stackit v0.0.4
published on Friday, Feb 20, 2026 by stackitcloud

    Network resource schema. Must have a region specified in the provider configuration.

    Example Usage

    data "stackit_network" "example" {
      project_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
      network_id = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
    }
    

    Using getNetwork

    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 getNetwork(args: GetNetworkArgs, opts?: InvokeOptions): Promise<GetNetworkResult>
    function getNetworkOutput(args: GetNetworkOutputArgs, opts?: InvokeOptions): Output<GetNetworkResult>
    def get_network(network_id: Optional[str] = None,
                    project_id: Optional[str] = None,
                    region: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNetworkResult
    def get_network_output(network_id: Optional[pulumi.Input[str]] = None,
                    project_id: Optional[pulumi.Input[str]] = None,
                    region: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetNetworkResult]
    func LookupNetwork(ctx *Context, args *LookupNetworkArgs, opts ...InvokeOption) (*LookupNetworkResult, error)
    func LookupNetworkOutput(ctx *Context, args *LookupNetworkOutputArgs, opts ...InvokeOption) LookupNetworkResultOutput

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

    public static class GetNetwork 
    {
        public static Task<GetNetworkResult> InvokeAsync(GetNetworkArgs args, InvokeOptions? opts = null)
        public static Output<GetNetworkResult> Invoke(GetNetworkInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
    public static Output<GetNetworkResult> getNetwork(GetNetworkArgs args, InvokeOptions options)
    
    fn::invoke:
      function: stackit:index/getNetwork:getNetwork
      arguments:
        # arguments dictionary

    The following arguments are supported:

    NetworkId string
    The network ID.
    ProjectId string
    STACKIT project ID to which the network is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    NetworkId string
    The network ID.
    ProjectId string
    STACKIT project ID to which the network is associated.
    Region string
    The resource region. If not defined, the provider region is used.
    networkId String
    The network ID.
    projectId String
    STACKIT project ID to which the network is associated.
    region String
    The resource region. If not defined, the provider region is used.
    networkId string
    The network ID.
    projectId string
    STACKIT project ID to which the network is associated.
    region string
    The resource region. If not defined, the provider region is used.
    network_id str
    The network ID.
    project_id str
    STACKIT project ID to which the network is associated.
    region str
    The resource region. If not defined, the provider region is used.
    networkId String
    The network ID.
    projectId String
    STACKIT project ID to which the network is associated.
    region String
    The resource region. If not defined, the provider region is used.

    getNetwork Result

    The following output properties are available:

    Dhcp bool
    Shows if DHCP is enabled for the network.
    Id string
    Ipv4Gateway string
    The IPv4 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    Ipv4Nameservers List<string>
    The IPv4 nameservers of the network.
    Ipv4Prefix string
    The IPv4 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv4_prefixes` should be preferred. This attribute will be populated with the first element from the list

    Ipv4PrefixLength int
    The IPv4 prefix length of the network.
    Ipv4Prefixes List<string>
    The IPv4 prefixes of the network.
    Ipv6Gateway string
    The IPv6 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    Ipv6Nameservers List<string>
    The IPv6 nameservers of the network.
    Ipv6Prefix string
    The IPv6 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv6_prefixes` should be preferred. This attribute will be populated with the first element from the list

    Ipv6PrefixLength int
    The IPv6 prefix length of the network.
    Ipv6Prefixes List<string>
    The IPv6 prefixes of the network.
    Labels Dictionary<string, string>
    Labels are key-value string pairs which can be attached to a resource container
    Name string
    The name of the network.
    Nameservers List<string>
    The nameservers of the network. This field is deprecated and will be removed soon, use ipv4_nameservers to configure the nameservers for IPv4.

    Deprecated: Use ipv4_nameservers to configure the nameservers for IPv4.

    NetworkId string
    The network ID.
    Prefixes List<string>
    The prefixes of the network. This field is deprecated and will be removed soon, use ipv4_prefixes to read the prefixes of the IPv4 networks.

    Deprecated: Use ipv4_prefixes to read the prefixes of the IPv4 networks.

    ProjectId string
    STACKIT project ID to which the network is associated.
    PublicIp string
    The public IP of the network.
    Routed bool
    Shows if the network is routed and therefore accessible from other networks.
    RoutingTableId string
    The ID of the routing table associated with the network.
    Region string
    The resource region. If not defined, the provider region is used.
    Dhcp bool
    Shows if DHCP is enabled for the network.
    Id string
    Ipv4Gateway string
    The IPv4 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    Ipv4Nameservers []string
    The IPv4 nameservers of the network.
    Ipv4Prefix string
    The IPv4 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv4_prefixes` should be preferred. This attribute will be populated with the first element from the list

    Ipv4PrefixLength int
    The IPv4 prefix length of the network.
    Ipv4Prefixes []string
    The IPv4 prefixes of the network.
    Ipv6Gateway string
    The IPv6 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    Ipv6Nameservers []string
    The IPv6 nameservers of the network.
    Ipv6Prefix string
    The IPv6 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv6_prefixes` should be preferred. This attribute will be populated with the first element from the list

    Ipv6PrefixLength int
    The IPv6 prefix length of the network.
    Ipv6Prefixes []string
    The IPv6 prefixes of the network.
    Labels map[string]string
    Labels are key-value string pairs which can be attached to a resource container
    Name string
    The name of the network.
    Nameservers []string
    The nameservers of the network. This field is deprecated and will be removed soon, use ipv4_nameservers to configure the nameservers for IPv4.

    Deprecated: Use ipv4_nameservers to configure the nameservers for IPv4.

    NetworkId string
    The network ID.
    Prefixes []string
    The prefixes of the network. This field is deprecated and will be removed soon, use ipv4_prefixes to read the prefixes of the IPv4 networks.

    Deprecated: Use ipv4_prefixes to read the prefixes of the IPv4 networks.

    ProjectId string
    STACKIT project ID to which the network is associated.
    PublicIp string
    The public IP of the network.
    Routed bool
    Shows if the network is routed and therefore accessible from other networks.
    RoutingTableId string
    The ID of the routing table associated with the network.
    Region string
    The resource region. If not defined, the provider region is used.
    dhcp Boolean
    Shows if DHCP is enabled for the network.
    id String
    ipv4Gateway String
    The IPv4 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    ipv4Nameservers List<String>
    The IPv4 nameservers of the network.
    ipv4Prefix String
    The IPv4 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv4_prefixes` should be preferred. This attribute will be populated with the first element from the list

    ipv4PrefixLength Integer
    The IPv4 prefix length of the network.
    ipv4Prefixes List<String>
    The IPv4 prefixes of the network.
    ipv6Gateway String
    The IPv6 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    ipv6Nameservers List<String>
    The IPv6 nameservers of the network.
    ipv6Prefix String
    The IPv6 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv6_prefixes` should be preferred. This attribute will be populated with the first element from the list

    ipv6PrefixLength Integer
    The IPv6 prefix length of the network.
    ipv6Prefixes List<String>
    The IPv6 prefixes of the network.
    labels Map<String,String>
    Labels are key-value string pairs which can be attached to a resource container
    name String
    The name of the network.
    nameservers List<String>
    The nameservers of the network. This field is deprecated and will be removed soon, use ipv4_nameservers to configure the nameservers for IPv4.

    Deprecated: Use ipv4_nameservers to configure the nameservers for IPv4.

    networkId String
    The network ID.
    prefixes List<String>
    The prefixes of the network. This field is deprecated and will be removed soon, use ipv4_prefixes to read the prefixes of the IPv4 networks.

    Deprecated: Use ipv4_prefixes to read the prefixes of the IPv4 networks.

    projectId String
    STACKIT project ID to which the network is associated.
    publicIp String
    The public IP of the network.
    routed Boolean
    Shows if the network is routed and therefore accessible from other networks.
    routingTableId String
    The ID of the routing table associated with the network.
    region String
    The resource region. If not defined, the provider region is used.
    dhcp boolean
    Shows if DHCP is enabled for the network.
    id string
    ipv4Gateway string
    The IPv4 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    ipv4Nameservers string[]
    The IPv4 nameservers of the network.
    ipv4Prefix string
    The IPv4 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv4_prefixes` should be preferred. This attribute will be populated with the first element from the list

    ipv4PrefixLength number
    The IPv4 prefix length of the network.
    ipv4Prefixes string[]
    The IPv4 prefixes of the network.
    ipv6Gateway string
    The IPv6 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    ipv6Nameservers string[]
    The IPv6 nameservers of the network.
    ipv6Prefix string
    The IPv6 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv6_prefixes` should be preferred. This attribute will be populated with the first element from the list

    ipv6PrefixLength number
    The IPv6 prefix length of the network.
    ipv6Prefixes string[]
    The IPv6 prefixes of the network.
    labels {[key: string]: string}
    Labels are key-value string pairs which can be attached to a resource container
    name string
    The name of the network.
    nameservers string[]
    The nameservers of the network. This field is deprecated and will be removed soon, use ipv4_nameservers to configure the nameservers for IPv4.

    Deprecated: Use ipv4_nameservers to configure the nameservers for IPv4.

    networkId string
    The network ID.
    prefixes string[]
    The prefixes of the network. This field is deprecated and will be removed soon, use ipv4_prefixes to read the prefixes of the IPv4 networks.

    Deprecated: Use ipv4_prefixes to read the prefixes of the IPv4 networks.

    projectId string
    STACKIT project ID to which the network is associated.
    publicIp string
    The public IP of the network.
    routed boolean
    Shows if the network is routed and therefore accessible from other networks.
    routingTableId string
    The ID of the routing table associated with the network.
    region string
    The resource region. If not defined, the provider region is used.
    dhcp bool
    Shows if DHCP is enabled for the network.
    id str
    ipv4_gateway str
    The IPv4 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    ipv4_nameservers Sequence[str]
    The IPv4 nameservers of the network.
    ipv4_prefix str
    The IPv4 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv4_prefixes` should be preferred. This attribute will be populated with the first element from the list

    ipv4_prefix_length int
    The IPv4 prefix length of the network.
    ipv4_prefixes Sequence[str]
    The IPv4 prefixes of the network.
    ipv6_gateway str
    The IPv6 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    ipv6_nameservers Sequence[str]
    The IPv6 nameservers of the network.
    ipv6_prefix str
    The IPv6 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv6_prefixes` should be preferred. This attribute will be populated with the first element from the list

    ipv6_prefix_length int
    The IPv6 prefix length of the network.
    ipv6_prefixes Sequence[str]
    The IPv6 prefixes of the network.
    labels Mapping[str, str]
    Labels are key-value string pairs which can be attached to a resource container
    name str
    The name of the network.
    nameservers Sequence[str]
    The nameservers of the network. This field is deprecated and will be removed soon, use ipv4_nameservers to configure the nameservers for IPv4.

    Deprecated: Use ipv4_nameservers to configure the nameservers for IPv4.

    network_id str
    The network ID.
    prefixes Sequence[str]
    The prefixes of the network. This field is deprecated and will be removed soon, use ipv4_prefixes to read the prefixes of the IPv4 networks.

    Deprecated: Use ipv4_prefixes to read the prefixes of the IPv4 networks.

    project_id str
    STACKIT project ID to which the network is associated.
    public_ip str
    The public IP of the network.
    routed bool
    Shows if the network is routed and therefore accessible from other networks.
    routing_table_id str
    The ID of the routing table associated with the network.
    region str
    The resource region. If not defined, the provider region is used.
    dhcp Boolean
    Shows if DHCP is enabled for the network.
    id String
    ipv4Gateway String
    The IPv4 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    ipv4Nameservers List<String>
    The IPv4 nameservers of the network.
    ipv4Prefix String
    The IPv4 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv4_prefixes` should be preferred. This attribute will be populated with the first element from the list

    ipv4PrefixLength Number
    The IPv4 prefix length of the network.
    ipv4Prefixes List<String>
    The IPv4 prefixes of the network.
    ipv6Gateway String
    The IPv6 gateway of a network. If not specified, the first IP of the network will be assigned as the gateway.
    ipv6Nameservers List<String>
    The IPv6 nameservers of the network.
    ipv6Prefix String
    The IPv6 prefix of the network (CIDR).

    Deprecated: The API supports reading multiple prefixes. So using the attribute 'ipv6_prefixes` should be preferred. This attribute will be populated with the first element from the list

    ipv6PrefixLength Number
    The IPv6 prefix length of the network.
    ipv6Prefixes List<String>
    The IPv6 prefixes of the network.
    labels Map<String>
    Labels are key-value string pairs which can be attached to a resource container
    name String
    The name of the network.
    nameservers List<String>
    The nameservers of the network. This field is deprecated and will be removed soon, use ipv4_nameservers to configure the nameservers for IPv4.

    Deprecated: Use ipv4_nameservers to configure the nameservers for IPv4.

    networkId String
    The network ID.
    prefixes List<String>
    The prefixes of the network. This field is deprecated and will be removed soon, use ipv4_prefixes to read the prefixes of the IPv4 networks.

    Deprecated: Use ipv4_prefixes to read the prefixes of the IPv4 networks.

    projectId String
    STACKIT project ID to which the network is associated.
    publicIp String
    The public IP of the network.
    routed Boolean
    Shows if the network is routed and therefore accessible from other networks.
    routingTableId String
    The ID of the routing table associated with the network.
    region String
    The resource region. If not defined, the provider region is used.

    Package Details

    Repository
    stackit stackitcloud/pulumi-stackit
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the stackit Terraform Provider.
    stackit logo
    Viewing docs for stackit v0.0.4
    published on Friday, Feb 20, 2026 by stackitcloud
      Try Pulumi Cloud free. Your team will thank you.