1. Packages
  2. Cloudflare Provider
  3. API Docs
  4. getRegistrarDomains
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

cloudflare.getRegistrarDomains

Explore with Pulumi AI

cloudflare logo
Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleRegistrarDomains = cloudflare.getRegistrarDomains({
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_registrar_domains = cloudflare.get_registrar_domains(account_id="023e105f4ecef8ad9ca31a8372d0c353")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-cloudflare/sdk/v6/go/cloudflare"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := cloudflare.LookupRegistrarDomains(ctx, &cloudflare.LookupRegistrarDomainsArgs{
    			AccountId: "023e105f4ecef8ad9ca31a8372d0c353",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Cloudflare = Pulumi.Cloudflare;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleRegistrarDomains = Cloudflare.GetRegistrarDomains.Invoke(new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.cloudflare.CloudflareFunctions;
    import com.pulumi.cloudflare.inputs.GetRegistrarDomainsArgs;
    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 exampleRegistrarDomains = CloudflareFunctions.getRegistrarDomains(GetRegistrarDomainsArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .build());
    
        }
    }
    
    variables:
      exampleRegistrarDomains:
        fn::invoke:
          function: cloudflare:getRegistrarDomains
          arguments:
            accountId: 023e105f4ecef8ad9ca31a8372d0c353
    

    Using getRegistrarDomains

    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 getRegistrarDomains(args: GetRegistrarDomainsArgs, opts?: InvokeOptions): Promise<GetRegistrarDomainsResult>
    function getRegistrarDomainsOutput(args: GetRegistrarDomainsOutputArgs, opts?: InvokeOptions): Output<GetRegistrarDomainsResult>
    def get_registrar_domains(account_id: Optional[str] = None,
                              max_items: Optional[int] = None,
                              opts: Optional[InvokeOptions] = None) -> GetRegistrarDomainsResult
    def get_registrar_domains_output(account_id: Optional[pulumi.Input[str]] = None,
                              max_items: Optional[pulumi.Input[int]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetRegistrarDomainsResult]
    func LookupRegistrarDomains(ctx *Context, args *LookupRegistrarDomainsArgs, opts ...InvokeOption) (*LookupRegistrarDomainsResult, error)
    func LookupRegistrarDomainsOutput(ctx *Context, args *LookupRegistrarDomainsOutputArgs, opts ...InvokeOption) LookupRegistrarDomainsResultOutput

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

    public static class GetRegistrarDomains 
    {
        public static Task<GetRegistrarDomainsResult> InvokeAsync(GetRegistrarDomainsArgs args, InvokeOptions? opts = null)
        public static Output<GetRegistrarDomainsResult> Invoke(GetRegistrarDomainsInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetRegistrarDomainsResult> getRegistrarDomains(GetRegistrarDomainsArgs args, InvokeOptions options)
    public static Output<GetRegistrarDomainsResult> getRegistrarDomains(GetRegistrarDomainsArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getRegistrarDomains:getRegistrarDomains
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    Identifier
    MaxItems int
    Max items to fetch, default: 1000
    AccountId string
    Identifier
    MaxItems int
    Max items to fetch, default: 1000
    accountId String
    Identifier
    maxItems Integer
    Max items to fetch, default: 1000
    accountId string
    Identifier
    maxItems number
    Max items to fetch, default: 1000
    account_id str
    Identifier
    max_items int
    Max items to fetch, default: 1000
    accountId String
    Identifier
    maxItems Number
    Max items to fetch, default: 1000

    getRegistrarDomains Result

    The following output properties are available:

    AccountId string
    Identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    Results List<GetRegistrarDomainsResult>
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    AccountId string
    Identifier
    Id string
    The provider-assigned unique ID for this managed resource.
    Results []GetRegistrarDomainsResult
    The items returned by the data source
    MaxItems int
    Max items to fetch, default: 1000
    accountId String
    Identifier
    id String
    The provider-assigned unique ID for this managed resource.
    results List<GetRegistrarDomainsResult>
    The items returned by the data source
    maxItems Integer
    Max items to fetch, default: 1000
    accountId string
    Identifier
    id string
    The provider-assigned unique ID for this managed resource.
    results GetRegistrarDomainsResult[]
    The items returned by the data source
    maxItems number
    Max items to fetch, default: 1000
    account_id str
    Identifier
    id str
    The provider-assigned unique ID for this managed resource.
    results Sequence[GetRegistrarDomainsResult]
    The items returned by the data source
    max_items int
    Max items to fetch, default: 1000
    accountId String
    Identifier
    id String
    The provider-assigned unique ID for this managed resource.
    results List<Property Map>
    The items returned by the data source
    maxItems Number
    Max items to fetch, default: 1000

    Supporting Types

    GetRegistrarDomainsResult

    Available bool
    Shows if a domain is available for transferring into Cloudflare Registrar.
    CanRegister bool
    Indicates if the domain can be registered as a new domain.
    CreatedAt string
    Shows time of creation.
    CurrentRegistrar string
    Shows name of current registrar.
    ExpiresAt string
    Shows when domain name registration expires.
    Id string
    Domain identifier.
    Locked bool
    Shows whether a registrar lock is in place for a domain.
    RegistrantContact GetRegistrarDomainsResultRegistrantContact
    Shows contact information for domain registrant.
    RegistryStatuses string
    A comma-separated list of registry status codes. A full list of status codes can be found at EPP Status Codes.
    SupportedTld bool
    Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to TLD Policies for a list of supported TLDs.
    TransferIn GetRegistrarDomainsResultTransferIn
    Statuses for domain transfers into Cloudflare Registrar.
    UpdatedAt string
    Last updated.
    Available bool
    Shows if a domain is available for transferring into Cloudflare Registrar.
    CanRegister bool
    Indicates if the domain can be registered as a new domain.
    CreatedAt string
    Shows time of creation.
    CurrentRegistrar string
    Shows name of current registrar.
    ExpiresAt string
    Shows when domain name registration expires.
    Id string
    Domain identifier.
    Locked bool
    Shows whether a registrar lock is in place for a domain.
    RegistrantContact GetRegistrarDomainsResultRegistrantContact
    Shows contact information for domain registrant.
    RegistryStatuses string
    A comma-separated list of registry status codes. A full list of status codes can be found at EPP Status Codes.
    SupportedTld bool
    Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to TLD Policies for a list of supported TLDs.
    TransferIn GetRegistrarDomainsResultTransferIn
    Statuses for domain transfers into Cloudflare Registrar.
    UpdatedAt string
    Last updated.
    available Boolean
    Shows if a domain is available for transferring into Cloudflare Registrar.
    canRegister Boolean
    Indicates if the domain can be registered as a new domain.
    createdAt String
    Shows time of creation.
    currentRegistrar String
    Shows name of current registrar.
    expiresAt String
    Shows when domain name registration expires.
    id String
    Domain identifier.
    locked Boolean
    Shows whether a registrar lock is in place for a domain.
    registrantContact GetRegistrarDomainsResultRegistrantContact
    Shows contact information for domain registrant.
    registryStatuses String
    A comma-separated list of registry status codes. A full list of status codes can be found at EPP Status Codes.
    supportedTld Boolean
    Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to TLD Policies for a list of supported TLDs.
    transferIn GetRegistrarDomainsResultTransferIn
    Statuses for domain transfers into Cloudflare Registrar.
    updatedAt String
    Last updated.
    available boolean
    Shows if a domain is available for transferring into Cloudflare Registrar.
    canRegister boolean
    Indicates if the domain can be registered as a new domain.
    createdAt string
    Shows time of creation.
    currentRegistrar string
    Shows name of current registrar.
    expiresAt string
    Shows when domain name registration expires.
    id string
    Domain identifier.
    locked boolean
    Shows whether a registrar lock is in place for a domain.
    registrantContact GetRegistrarDomainsResultRegistrantContact
    Shows contact information for domain registrant.
    registryStatuses string
    A comma-separated list of registry status codes. A full list of status codes can be found at EPP Status Codes.
    supportedTld boolean
    Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to TLD Policies for a list of supported TLDs.
    transferIn GetRegistrarDomainsResultTransferIn
    Statuses for domain transfers into Cloudflare Registrar.
    updatedAt string
    Last updated.
    available bool
    Shows if a domain is available for transferring into Cloudflare Registrar.
    can_register bool
    Indicates if the domain can be registered as a new domain.
    created_at str
    Shows time of creation.
    current_registrar str
    Shows name of current registrar.
    expires_at str
    Shows when domain name registration expires.
    id str
    Domain identifier.
    locked bool
    Shows whether a registrar lock is in place for a domain.
    registrant_contact GetRegistrarDomainsResultRegistrantContact
    Shows contact information for domain registrant.
    registry_statuses str
    A comma-separated list of registry status codes. A full list of status codes can be found at EPP Status Codes.
    supported_tld bool
    Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to TLD Policies for a list of supported TLDs.
    transfer_in GetRegistrarDomainsResultTransferIn
    Statuses for domain transfers into Cloudflare Registrar.
    updated_at str
    Last updated.
    available Boolean
    Shows if a domain is available for transferring into Cloudflare Registrar.
    canRegister Boolean
    Indicates if the domain can be registered as a new domain.
    createdAt String
    Shows time of creation.
    currentRegistrar String
    Shows name of current registrar.
    expiresAt String
    Shows when domain name registration expires.
    id String
    Domain identifier.
    locked Boolean
    Shows whether a registrar lock is in place for a domain.
    registrantContact Property Map
    Shows contact information for domain registrant.
    registryStatuses String
    A comma-separated list of registry status codes. A full list of status codes can be found at EPP Status Codes.
    supportedTld Boolean
    Whether a particular TLD is currently supported by Cloudflare Registrar. Refer to TLD Policies for a list of supported TLDs.
    transferIn Property Map
    Statuses for domain transfers into Cloudflare Registrar.
    updatedAt String
    Last updated.

    GetRegistrarDomainsResultRegistrantContact

    Address string
    Address.
    Address2 string
    Optional address line for unit, floor, suite, etc.
    City string
    City.
    Country string
    The country in which the user lives.
    Email string
    The contact email address of the user.
    Fax string
    Contact fax number.
    FirstName string
    User's first name
    Id string
    Contact Identifier.
    LastName string
    User's last name
    Organization string
    Name of organization.
    Phone string
    User's telephone number
    State string
    State.
    Zip string
    The zipcode or postal code where the user lives.
    Address string
    Address.
    Address2 string
    Optional address line for unit, floor, suite, etc.
    City string
    City.
    Country string
    The country in which the user lives.
    Email string
    The contact email address of the user.
    Fax string
    Contact fax number.
    FirstName string
    User's first name
    Id string
    Contact Identifier.
    LastName string
    User's last name
    Organization string
    Name of organization.
    Phone string
    User's telephone number
    State string
    State.
    Zip string
    The zipcode or postal code where the user lives.
    address String
    Address.
    address2 String
    Optional address line for unit, floor, suite, etc.
    city String
    City.
    country String
    The country in which the user lives.
    email String
    The contact email address of the user.
    fax String
    Contact fax number.
    firstName String
    User's first name
    id String
    Contact Identifier.
    lastName String
    User's last name
    organization String
    Name of organization.
    phone String
    User's telephone number
    state String
    State.
    zip String
    The zipcode or postal code where the user lives.
    address string
    Address.
    address2 string
    Optional address line for unit, floor, suite, etc.
    city string
    City.
    country string
    The country in which the user lives.
    email string
    The contact email address of the user.
    fax string
    Contact fax number.
    firstName string
    User's first name
    id string
    Contact Identifier.
    lastName string
    User's last name
    organization string
    Name of organization.
    phone string
    User's telephone number
    state string
    State.
    zip string
    The zipcode or postal code where the user lives.
    address str
    Address.
    address2 str
    Optional address line for unit, floor, suite, etc.
    city str
    City.
    country str
    The country in which the user lives.
    email str
    The contact email address of the user.
    fax str
    Contact fax number.
    first_name str
    User's first name
    id str
    Contact Identifier.
    last_name str
    User's last name
    organization str
    Name of organization.
    phone str
    User's telephone number
    state str
    State.
    zip str
    The zipcode or postal code where the user lives.
    address String
    Address.
    address2 String
    Optional address line for unit, floor, suite, etc.
    city String
    City.
    country String
    The country in which the user lives.
    email String
    The contact email address of the user.
    fax String
    Contact fax number.
    firstName String
    User's first name
    id String
    Contact Identifier.
    lastName String
    User's last name
    organization String
    Name of organization.
    phone String
    User's telephone number
    state String
    State.
    zip String
    The zipcode or postal code where the user lives.

    GetRegistrarDomainsResultTransferIn

    AcceptFoa string
    Form of authorization has been accepted by the registrant. Available values: "needed", "ok".
    ApproveTransfer string
    Shows transfer status with the registry. Available values: "needed", "ok", "pending", "trying", "rejected", "unknown".
    CanCancelTransfer bool
    Indicates if cancellation is still possible.
    DisablePrivacy string
    Privacy guards are disabled at the foreign registrar. Available values: "needed", "ok", "unknown".
    EnterAuthCode string
    Auth code has been entered and verified. Available values: "needed", "ok", "pending", "trying", "rejected".
    UnlockDomain string
    Domain is unlocked at the foreign registrar. Available values: "needed", "ok", "pending", "trying", "unknown".
    AcceptFoa string
    Form of authorization has been accepted by the registrant. Available values: "needed", "ok".
    ApproveTransfer string
    Shows transfer status with the registry. Available values: "needed", "ok", "pending", "trying", "rejected", "unknown".
    CanCancelTransfer bool
    Indicates if cancellation is still possible.
    DisablePrivacy string
    Privacy guards are disabled at the foreign registrar. Available values: "needed", "ok", "unknown".
    EnterAuthCode string
    Auth code has been entered and verified. Available values: "needed", "ok", "pending", "trying", "rejected".
    UnlockDomain string
    Domain is unlocked at the foreign registrar. Available values: "needed", "ok", "pending", "trying", "unknown".
    acceptFoa String
    Form of authorization has been accepted by the registrant. Available values: "needed", "ok".
    approveTransfer String
    Shows transfer status with the registry. Available values: "needed", "ok", "pending", "trying", "rejected", "unknown".
    canCancelTransfer Boolean
    Indicates if cancellation is still possible.
    disablePrivacy String
    Privacy guards are disabled at the foreign registrar. Available values: "needed", "ok", "unknown".
    enterAuthCode String
    Auth code has been entered and verified. Available values: "needed", "ok", "pending", "trying", "rejected".
    unlockDomain String
    Domain is unlocked at the foreign registrar. Available values: "needed", "ok", "pending", "trying", "unknown".
    acceptFoa string
    Form of authorization has been accepted by the registrant. Available values: "needed", "ok".
    approveTransfer string
    Shows transfer status with the registry. Available values: "needed", "ok", "pending", "trying", "rejected", "unknown".
    canCancelTransfer boolean
    Indicates if cancellation is still possible.
    disablePrivacy string
    Privacy guards are disabled at the foreign registrar. Available values: "needed", "ok", "unknown".
    enterAuthCode string
    Auth code has been entered and verified. Available values: "needed", "ok", "pending", "trying", "rejected".
    unlockDomain string
    Domain is unlocked at the foreign registrar. Available values: "needed", "ok", "pending", "trying", "unknown".
    accept_foa str
    Form of authorization has been accepted by the registrant. Available values: "needed", "ok".
    approve_transfer str
    Shows transfer status with the registry. Available values: "needed", "ok", "pending", "trying", "rejected", "unknown".
    can_cancel_transfer bool
    Indicates if cancellation is still possible.
    disable_privacy str
    Privacy guards are disabled at the foreign registrar. Available values: "needed", "ok", "unknown".
    enter_auth_code str
    Auth code has been entered and verified. Available values: "needed", "ok", "pending", "trying", "rejected".
    unlock_domain str
    Domain is unlocked at the foreign registrar. Available values: "needed", "ok", "pending", "trying", "unknown".
    acceptFoa String
    Form of authorization has been accepted by the registrant. Available values: "needed", "ok".
    approveTransfer String
    Shows transfer status with the registry. Available values: "needed", "ok", "pending", "trying", "rejected", "unknown".
    canCancelTransfer Boolean
    Indicates if cancellation is still possible.
    disablePrivacy String
    Privacy guards are disabled at the foreign registrar. Available values: "needed", "ok", "unknown".
    enterAuthCode String
    Auth code has been entered and verified. Available values: "needed", "ok", "pending", "trying", "rejected".
    unlockDomain String
    Domain is unlocked at the foreign registrar. Available values: "needed", "ok", "pending", "trying", "unknown".

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Cloudflare v6.1.2 published on Monday, Apr 28, 2025 by Pulumi