GetZone

Provides details about a NS1 Zone. Use this if you would simply like to read information from NS1 into your configurations. For read/write operations, you should use a resource.

Using GetZone

function getZone(args: GetZoneArgs, opts?: InvokeOptions): Promise<GetZoneResult>

function  get_zone(additional_primaries=None, zone=None, opts=None)

func LookupZone(ctx *Context, args *LookupZoneArgs, opts ...InvokeOption) (*LookupZoneResult, error)

Note: This function is named LookupZone in the Go SDK.

public static class GetZone {
    public static Task<GetZoneResult> InvokeAsync(GetZoneArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Zone string: The domain name of the zone.
AdditionalPrimaries List<string>: List of additional IPv4 addresses for the primary zone.

Zone string: The domain name of the zone.
AdditionalPrimaries []string: List of additional IPv4 addresses for the primary zone.

zone string: The domain name of the zone.
additionalPrimaries string[]: List of additional IPv4 addresses for the primary zone.

zone str: The domain name of the zone.
additional_primaries List[str]: List of additional IPv4 addresses for the primary zone.

GetZone Result

The following output properties are available:

DnsServers string: Authoritative Name Servers.
Dnssec bool: Whether or not DNSSEC is enabled for the zone.
Expiry int: The SOA Expiry.
Hostmaster string: The SOA Hostmaster.
Id string: The provider-assigned unique ID for this managed resource.
Link string: The linked target zone.
Networks List<int>: List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network.
NxTtl int: The SOA NX TTL.
Primary string: The primary zones’ IPv4 address.
Refresh int: The SOA Refresh.
Retry int: The SOA Retry.
Secondaries List<GetZoneSecondary>: List of secondary servers. Secondaries is documented below.
Ttl int: The SOA TTL.
Zone string
AdditionalPrimaries List<string>: List of additional IPv4 addresses for the primary zone.

DnsServers string: Authoritative Name Servers.
Dnssec bool: Whether or not DNSSEC is enabled for the zone.
Expiry int: The SOA Expiry.
Hostmaster string: The SOA Hostmaster.
Id string: The provider-assigned unique ID for this managed resource.
Link string: The linked target zone.
Networks []int: List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network.
NxTtl int: The SOA NX TTL.
Primary string: The primary zones’ IPv4 address.
Refresh int: The SOA Refresh.
Retry int: The SOA Retry.
Secondaries []GetZoneSecondary: List of secondary servers. Secondaries is documented below.
Ttl int: The SOA TTL.
Zone string
AdditionalPrimaries []string: List of additional IPv4 addresses for the primary zone.

dnsServers string: Authoritative Name Servers.
dnssec boolean: Whether or not DNSSEC is enabled for the zone.
expiry number: The SOA Expiry.
hostmaster string: The SOA Hostmaster.
id string: The provider-assigned unique ID for this managed resource.
link string: The linked target zone.
networks number[]: List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network.
nxTtl number: The SOA NX TTL.
primary string: The primary zones’ IPv4 address.
refresh number: The SOA Refresh.
retry number: The SOA Retry.
secondaries GetZoneSecondary[]: List of secondary servers. Secondaries is documented below.
ttl number: The SOA TTL.
zone string
additionalPrimaries string[]: List of additional IPv4 addresses for the primary zone.

dns_servers str: Authoritative Name Servers.
dnssec bool: Whether or not DNSSEC is enabled for the zone.
expiry float: The SOA Expiry.
hostmaster str: The SOA Hostmaster.
id str: The provider-assigned unique ID for this managed resource.
link str: The linked target zone.
networks List[Integer]: List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network.
nx_ttl float: The SOA NX TTL.
primary str: The primary zones’ IPv4 address.
refresh float: The SOA Refresh.
retry float: The SOA Retry.
secondaries List[GetZoneSecondary]: List of secondary servers. Secondaries is documented below.
ttl float: The SOA TTL.
zone str
additional_primaries List[str]: List of additional IPv4 addresses for the primary zone.

Supporting Types

GetZoneSecondary

See the output API doc for this type.

Ip string: IPv4 address of the secondary server.
Networks List<int>: List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network.
Notify bool: Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.
Port int: Port of the the secondary server. Default 53.

Ip string: IPv4 address of the secondary server.
Networks []int: List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network.
Notify bool: Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.
Port int: Port of the the secondary server. Default 53.

ip string: IPv4 address of the secondary server.
networks number[]: List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network.
notify boolean: Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.
port number: Port of the the secondary server. Default 53.

ip str: IPv4 address of the secondary server.
networks List[Integer]: List of network IDs (int) for which the zone should be made available. Default is network 0, the primary NSONE Global Network.
notify bool: Whether we send NOTIFY messages to the secondary host when the zone changes. Default false.
port float: Port of the the secondary server. Default 53.

Package Details

Repository: https://github.com/pulumi/pulumi-ns1
License: Apache-2.0
Notes: This Pulumi package is based on the ns1 Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud