getDomains

Linode v5.9.0, Mar 13 26

Viewing docs for Linode v5.9.0
published on Friday, Mar 13, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-linode

Viewing docs for Linode v5.9.0
published on Friday, Mar 13, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-linode

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as linode from "@pulumi/linode";

const specific = linode.getDomains({
    filters: [{
        name: "tags",
        values: ["test-tag"],
    }],
});
export const domain = specific.then(specific => specific.domains?.[0]?.domain);

import pulumi
import pulumi_linode as linode

specific = linode.get_domains(filters=[{
    "name": "tags",
    "values": ["test-tag"],
}])
pulumi.export("domain", specific.domains[0].domain)

package main

import (
	"github.com/pulumi/pulumi-linode/sdk/v5/go/linode"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		specific, err := linode.GetDomains(ctx, &linode.GetDomainsArgs{
			Filters: []linode.GetDomainsFilter{
				{
					Name: "tags",
					Values: []string{
						"test-tag",
					},
				},
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("domain", specific.Domains[0].Domain)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Linode = Pulumi.Linode;

return await Deployment.RunAsync(() => 
{
    var specific = Linode.GetDomains.Invoke(new()
    {
        Filters = new[]
        {
            new Linode.Inputs.GetDomainsFilterInputArgs
            {
                Name = "tags",
                Values = new[]
                {
                    "test-tag",
                },
            },
        },
    });

    return new Dictionary<string, object?>
    {
        ["domain"] = specific.Apply(getDomainsResult => getDomainsResult.Domains[0]?.Domain),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.linode.LinodeFunctions;
import com.pulumi.linode.inputs.GetDomainsArgs;
import java.util.List;
import java.util.ArrayList;
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) {
        final var specific = LinodeFunctions.getDomains(GetDomainsArgs.builder()
            .filters(GetDomainsFilterArgs.builder()
                .name("tags")
                .values("test-tag")
                .build())
            .build());

        ctx.export("domain", specific.domains()[0].domain());
    }
}

variables:
  specific:
    fn::invoke:
      function: linode:getDomains
      arguments:
        filters:
          - name: tags
            values:
              - test-tag
outputs:
  domain: ${specific.domains[0].domain}

Filterable Fields

group
tags
domain
type
status
description
master_ips
axfr_ips
ttl_sec
retry_sec
expire_sec
refresh_sec
soa_email

Using getDomains

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 getDomains(args: GetDomainsArgs, opts?: InvokeOptions): Promise<GetDomainsResult>
function getDomainsOutput(args: GetDomainsOutputArgs, opts?: InvokeOptions): Output<GetDomainsResult>

def get_domains(filters: Optional[Sequence[GetDomainsFilter]] = None,
                order: Optional[str] = None,
                order_by: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetDomainsResult
def get_domains_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetDomainsFilterArgs]]]] = None,
                order: Optional[pulumi.Input[str]] = None,
                order_by: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetDomainsResult]

func GetDomains(ctx *Context, args *GetDomainsArgs, opts ...InvokeOption) (*GetDomainsResult, error)
func GetDomainsOutput(ctx *Context, args *GetDomainsOutputArgs, opts ...InvokeOption) GetDomainsResultOutput

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

public static class GetDomains 
{
    public static Task<GetDomainsResult> InvokeAsync(GetDomainsArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainsResult> Invoke(GetDomainsInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetDomainsResult> getDomains(GetDomainsArgs args, InvokeOptions options)
public static Output<GetDomainsResult> getDomains(GetDomainsArgs args, InvokeOptions options)

fn::invoke:
  function: linode:index/getDomains:getDomains
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetDomainsFilter>
Order string: The order in which results should be returned. (asc, desc; default asc)
OrderBy string: The attribute to order the results by. See the Filterable Fields section for a list of valid fields.

Filters []GetDomainsFilter
Order string: The order in which results should be returned. (asc, desc; default asc)
OrderBy string: The attribute to order the results by. See the Filterable Fields section for a list of valid fields.

filters List<GetDomainsFilter>
order String: The order in which results should be returned. (asc, desc; default asc)
orderBy String: The attribute to order the results by. See the Filterable Fields section for a list of valid fields.

filters GetDomainsFilter[]
order string: The order in which results should be returned. (asc, desc; default asc)
orderBy string: The attribute to order the results by. See the Filterable Fields section for a list of valid fields.

filters Sequence[GetDomainsFilter]
order str: The order in which results should be returned. (asc, desc; default asc)
order_by str: The attribute to order the results by. See the Filterable Fields section for a list of valid fields.

filters List<Property Map>
order String: The order in which results should be returned. (asc, desc; default asc)
orderBy String: The attribute to order the results by. See the Filterable Fields section for a list of valid fields.

getDomains Result

The following output properties are available:

Domains List<GetDomainsDomain>
Id string: The unique ID of this Domain.
Filters List<GetDomainsFilter>
Order string
OrderBy string

Domains []GetDomainsDomain
Id string: The unique ID of this Domain.
Filters []GetDomainsFilter
Order string
OrderBy string

domains List<GetDomainsDomain>
id String: The unique ID of this Domain.
filters List<GetDomainsFilter>
order String
orderBy String

domains GetDomainsDomain[]
id string: The unique ID of this Domain.
filters GetDomainsFilter[]
order string
orderBy string

domains Sequence[GetDomainsDomain]
id str: The unique ID of this Domain.
filters Sequence[GetDomainsFilter]
order str
order_by str

domains List<Property Map>
id String: The unique ID of this Domain.
filters List<Property Map>
order String
orderBy String

Supporting Types

GetDomainsDomain

AxfrIps List<string>: The list of IPs that may perform a zone transfer for this Domain.
Description string: A description for this Domain.
ExpireSec int: The amount of time in seconds that may pass before this Domain is no longer authoritative.
Group string: The group this Domain belongs to.
MasterIps List<string>: The IP addresses representing the master DNS for this Domain.
RefreshSec int: The amount of time in seconds before this Domain should be refreshed.
RetrySec int: The interval, in seconds, at which a failed refresh should be retried.
SoaEmail string: Start of Authority email address.
Status string: Used to control whether this Domain is currently being rendered. (disabled, active)
Tags List<string>: An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
TtlSec int: 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
Type string: If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
Domain string: The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
Id int: The unique ID of this Domain.

AxfrIps []string: The list of IPs that may perform a zone transfer for this Domain.
Description string: A description for this Domain.
ExpireSec int: The amount of time in seconds that may pass before this Domain is no longer authoritative.
Group string: The group this Domain belongs to.
MasterIps []string: The IP addresses representing the master DNS for this Domain.
RefreshSec int: The amount of time in seconds before this Domain should be refreshed.
RetrySec int: The interval, in seconds, at which a failed refresh should be retried.
SoaEmail string: Start of Authority email address.
Status string: Used to control whether this Domain is currently being rendered. (disabled, active)
Tags []string: An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
TtlSec int: 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
Type string: If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
Domain string: The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
Id int: The unique ID of this Domain.

axfrIps List<String>: The list of IPs that may perform a zone transfer for this Domain.
description String: A description for this Domain.
expireSec Integer: The amount of time in seconds that may pass before this Domain is no longer authoritative.
group String: The group this Domain belongs to.
masterIps List<String>: The IP addresses representing the master DNS for this Domain.
refreshSec Integer: The amount of time in seconds before this Domain should be refreshed.
retrySec Integer: The interval, in seconds, at which a failed refresh should be retried.
soaEmail String: Start of Authority email address.
status String: Used to control whether this Domain is currently being rendered. (disabled, active)
tags List<String>: An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
ttlSec Integer: 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
type String: If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
domain String: The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
id Integer: The unique ID of this Domain.

axfrIps string[]: The list of IPs that may perform a zone transfer for this Domain.
description string: A description for this Domain.
expireSec number: The amount of time in seconds that may pass before this Domain is no longer authoritative.
group string: The group this Domain belongs to.
masterIps string[]: The IP addresses representing the master DNS for this Domain.
refreshSec number: The amount of time in seconds before this Domain should be refreshed.
retrySec number: The interval, in seconds, at which a failed refresh should be retried.
soaEmail string: Start of Authority email address.
status string: Used to control whether this Domain is currently being rendered. (disabled, active)
tags string[]: An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
ttlSec number: 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
type string: If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
domain string: The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
id number: The unique ID of this Domain.

axfr_ips Sequence[str]: The list of IPs that may perform a zone transfer for this Domain.
description str: A description for this Domain.
expire_sec int: The amount of time in seconds that may pass before this Domain is no longer authoritative.
group str: The group this Domain belongs to.
master_ips Sequence[str]: The IP addresses representing the master DNS for this Domain.
refresh_sec int: The amount of time in seconds before this Domain should be refreshed.
retry_sec int: The interval, in seconds, at which a failed refresh should be retried.
soa_email str: Start of Authority email address.
status str: Used to control whether this Domain is currently being rendered. (disabled, active)
tags Sequence[str]: An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
ttl_sec int: 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
type str: If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
domain str: The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
id int: The unique ID of this Domain.

axfrIps List<String>: The list of IPs that may perform a zone transfer for this Domain.
description String: A description for this Domain.
expireSec Number: The amount of time in seconds that may pass before this Domain is no longer authoritative.
group String: The group this Domain belongs to.
masterIps List<String>: The IP addresses representing the master DNS for this Domain.
refreshSec Number: The amount of time in seconds before this Domain should be refreshed.
retrySec Number: The interval, in seconds, at which a failed refresh should be retried.
soaEmail String: Start of Authority email address.
status String: Used to control whether this Domain is currently being rendered. (disabled, active)
tags List<String>: An array of tags applied to this object. Tags are case-insensitive and are for organizational purposes only.
ttlSec Number: 'Time to Live'-the amount of time in seconds that this Domain's records may be cached by resolvers or other domain servers.
type String: If this Domain represents the authoritative source of information for the domain it describes, or if it is a read-only copy of a master (also called a slave) (master, slave)
domain String: The domain this Domain represents. These must be unique in our system; you cannot have two Domains representing the same domain
id Number: The unique ID of this Domain.

GetDomainsFilter

Name string: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
Values List<string>: A list of values for the filter to allow. These values should all be in string form.
MatchBy string: The method to match the field by. (exact, regex, substring; default exact)

Name string: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
Values []string: A list of values for the filter to allow. These values should all be in string form.
MatchBy string: The method to match the field by. (exact, regex, substring; default exact)

name String: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
values List<String>: A list of values for the filter to allow. These values should all be in string form.
matchBy String: The method to match the field by. (exact, regex, substring; default exact)

name string: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
values string[]: A list of values for the filter to allow. These values should all be in string form.
matchBy string: The method to match the field by. (exact, regex, substring; default exact)

name str: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
values Sequence[str]: A list of values for the filter to allow. These values should all be in string form.
match_by str: The method to match the field by. (exact, regex, substring; default exact)

name String: The name of the field to filter by. See the Filterable Fields section for a complete list of filterable fields.
values List<String>: A list of values for the filter to allow. These values should all be in string form.
matchBy String: The method to match the field by. (exact, regex, substring; default exact)

Package Details

Repository: Linode pulumi/pulumi-linode
License: Apache-2.0
Notes: This Pulumi package is based on the linode Terraform Provider.

Viewing docs for Linode v5.9.0
published on Friday, Mar 13, 2026 by Pulumi

Schema (JSON)

pulumi/pulumi-linode

linode.getDomains

On this page

On this page

Example Usage

Filterable Fields

Using getDomains

getDomains Result

Supporting Types

GetDomainsDomain

GetDomainsFilter

Package Details

On this page

On this page