1. Packages
  2. Packages
  3. Cloudflare Provider
  4. API Docs
  5. getWorkersCustomDomain
Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi
cloudflare logo
Viewing docs for Cloudflare v6.15.0
published on Saturday, May 2, 2026 by Pulumi

    Accepted Permissions

    • Workers Scripts Read
    • Workers Scripts Write

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as cloudflare from "@pulumi/cloudflare";
    
    const exampleWorkersCustomDomain = cloudflare.getWorkersCustomDomain({
        accountId: "023e105f4ecef8ad9ca31a8372d0c353",
        domainId: "dbe10b4bc17c295377eabd600e1787fd",
    });
    
    import pulumi
    import pulumi_cloudflare as cloudflare
    
    example_workers_custom_domain = cloudflare.get_workers_custom_domain(account_id="023e105f4ecef8ad9ca31a8372d0c353",
        domain_id="dbe10b4bc17c295377eabd600e1787fd")
    
    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.GetWorkersCustomDomain(ctx, &cloudflare.LookupWorkersCustomDomainArgs{
    			AccountId: pulumi.StringRef("023e105f4ecef8ad9ca31a8372d0c353"),
    			DomainId:  pulumi.StringRef("dbe10b4bc17c295377eabd600e1787fd"),
    		}, 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 exampleWorkersCustomDomain = Cloudflare.Index.GetWorkersCustomDomain.Invoke(new()
        {
            AccountId = "023e105f4ecef8ad9ca31a8372d0c353",
            DomainId = "dbe10b4bc17c295377eabd600e1787fd",
        });
    
    });
    
    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.GetWorkersCustomDomainArgs;
    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 exampleWorkersCustomDomain = CloudflareFunctions.getWorkersCustomDomain(GetWorkersCustomDomainArgs.builder()
                .accountId("023e105f4ecef8ad9ca31a8372d0c353")
                .domainId("dbe10b4bc17c295377eabd600e1787fd")
                .build());
    
        }
    }
    
    variables:
      exampleWorkersCustomDomain:
        fn::invoke:
          function: cloudflare:getWorkersCustomDomain
          arguments:
            accountId: 023e105f4ecef8ad9ca31a8372d0c353
            domainId: dbe10b4bc17c295377eabd600e1787fd
    

    Using getWorkersCustomDomain

    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 getWorkersCustomDomain(args: GetWorkersCustomDomainArgs, opts?: InvokeOptions): Promise<GetWorkersCustomDomainResult>
    function getWorkersCustomDomainOutput(args: GetWorkersCustomDomainOutputArgs, opts?: InvokeOptions): Output<GetWorkersCustomDomainResult>
    def get_workers_custom_domain(account_id: Optional[str] = None,
                                  domain_id: Optional[str] = None,
                                  filter: Optional[GetWorkersCustomDomainFilter] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetWorkersCustomDomainResult
    def get_workers_custom_domain_output(account_id: pulumi.Input[Optional[str]] = None,
                                  domain_id: pulumi.Input[Optional[str]] = None,
                                  filter: pulumi.Input[Optional[GetWorkersCustomDomainFilterArgs]] = None,
                                  opts: Optional[InvokeOptions] = None) -> Output[GetWorkersCustomDomainResult]
    func LookupWorkersCustomDomain(ctx *Context, args *LookupWorkersCustomDomainArgs, opts ...InvokeOption) (*LookupWorkersCustomDomainResult, error)
    func LookupWorkersCustomDomainOutput(ctx *Context, args *LookupWorkersCustomDomainOutputArgs, opts ...InvokeOption) LookupWorkersCustomDomainResultOutput

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

    public static class GetWorkersCustomDomain 
    {
        public static Task<GetWorkersCustomDomainResult> InvokeAsync(GetWorkersCustomDomainArgs args, InvokeOptions? opts = null)
        public static Output<GetWorkersCustomDomainResult> Invoke(GetWorkersCustomDomainInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetWorkersCustomDomainResult> getWorkersCustomDomain(GetWorkersCustomDomainArgs args, InvokeOptions options)
    public static Output<GetWorkersCustomDomainResult> getWorkersCustomDomain(GetWorkersCustomDomainArgs args, InvokeOptions options)
    
    fn::invoke:
      function: cloudflare:index/getWorkersCustomDomain:getWorkersCustomDomain
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AccountId string
    Identifier.
    DomainId string
    ID of the domain.
    Filter GetWorkersCustomDomainFilter
    AccountId string
    Identifier.
    DomainId string
    ID of the domain.
    Filter GetWorkersCustomDomainFilter
    accountId String
    Identifier.
    domainId String
    ID of the domain.
    filter GetWorkersCustomDomainFilter
    accountId string
    Identifier.
    domainId string
    ID of the domain.
    filter GetWorkersCustomDomainFilter
    account_id str
    Identifier.
    domain_id str
    ID of the domain.
    filter GetWorkersCustomDomainFilter
    accountId String
    Identifier.
    domainId String
    ID of the domain.
    filter Property Map

    getWorkersCustomDomain Result

    The following output properties are available:

    CertId string
    ID of the TLS certificate issued for the domain.
    Environment string
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    Hostname string
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    Id string
    ID of the domain.
    Service string
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    ZoneId string
    ID of the zone containing the domain hostname.
    ZoneName string
    Name of the zone containing the domain hostname.
    AccountId string
    Identifier.
    DomainId string
    ID of the domain.
    Filter GetWorkersCustomDomainFilter
    CertId string
    ID of the TLS certificate issued for the domain.
    Environment string
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    Hostname string
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    Id string
    ID of the domain.
    Service string
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    ZoneId string
    ID of the zone containing the domain hostname.
    ZoneName string
    Name of the zone containing the domain hostname.
    AccountId string
    Identifier.
    DomainId string
    ID of the domain.
    Filter GetWorkersCustomDomainFilter
    certId String
    ID of the TLS certificate issued for the domain.
    environment String
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    hostname String
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    id String
    ID of the domain.
    service String
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    zoneId String
    ID of the zone containing the domain hostname.
    zoneName String
    Name of the zone containing the domain hostname.
    accountId String
    Identifier.
    domainId String
    ID of the domain.
    filter GetWorkersCustomDomainFilter
    certId string
    ID of the TLS certificate issued for the domain.
    environment string
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    hostname string
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    id string
    ID of the domain.
    service string
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    zoneId string
    ID of the zone containing the domain hostname.
    zoneName string
    Name of the zone containing the domain hostname.
    accountId string
    Identifier.
    domainId string
    ID of the domain.
    filter GetWorkersCustomDomainFilter
    cert_id str
    ID of the TLS certificate issued for the domain.
    environment str
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    hostname str
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    id str
    ID of the domain.
    service str
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    zone_id str
    ID of the zone containing the domain hostname.
    zone_name str
    Name of the zone containing the domain hostname.
    account_id str
    Identifier.
    domain_id str
    ID of the domain.
    filter GetWorkersCustomDomainFilter
    certId String
    ID of the TLS certificate issued for the domain.
    environment String
    Worker environment associated with the domain.

    Deprecated: This attribute is deprecated.

    hostname String
    Hostname of the domain. Can be either the zone apex or a subdomain of the zone. Requests to this hostname will be routed to the configured Worker.
    id String
    ID of the domain.
    service String
    Name of the Worker associated with the domain. Requests to the configured hostname will be routed to this Worker.
    zoneId String
    ID of the zone containing the domain hostname.
    zoneName String
    Name of the zone containing the domain hostname.
    accountId String
    Identifier.
    domainId String
    ID of the domain.
    filter Property Map

    Supporting Types

    GetWorkersCustomDomainFilter

    Environment string
    Worker environment associated with the domain.
    Hostname string
    Hostname of the domain.
    Service string
    Name of the Worker associated with the domain.
    ZoneId string
    ID of the zone containing the domain hostname.
    ZoneName string
    Name of the zone containing the domain hostname.
    Environment string
    Worker environment associated with the domain.
    Hostname string
    Hostname of the domain.
    Service string
    Name of the Worker associated with the domain.
    ZoneId string
    ID of the zone containing the domain hostname.
    ZoneName string
    Name of the zone containing the domain hostname.
    environment String
    Worker environment associated with the domain.
    hostname String
    Hostname of the domain.
    service String
    Name of the Worker associated with the domain.
    zoneId String
    ID of the zone containing the domain hostname.
    zoneName String
    Name of the zone containing the domain hostname.
    environment string
    Worker environment associated with the domain.
    hostname string
    Hostname of the domain.
    service string
    Name of the Worker associated with the domain.
    zoneId string
    ID of the zone containing the domain hostname.
    zoneName string
    Name of the zone containing the domain hostname.
    environment str
    Worker environment associated with the domain.
    hostname str
    Hostname of the domain.
    service str
    Name of the Worker associated with the domain.
    zone_id str
    ID of the zone containing the domain hostname.
    zone_name str
    Name of the zone containing the domain hostname.
    environment String
    Worker environment associated with the domain.
    hostname String
    Hostname of the domain.
    service String
    Name of the Worker associated with the domain.
    zoneId String
    ID of the zone containing the domain hostname.
    zoneName String
    Name of the zone containing the domain hostname.

    Package Details

    Repository
    Cloudflare pulumi/pulumi-cloudflare
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the cloudflare Terraform Provider.
    cloudflare logo
    Viewing docs for Cloudflare v6.15.0
    published on Saturday, May 2, 2026 by Pulumi
      Try Pulumi Cloud free. Your team will thank you.