Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. Domain
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
Schema (JSON)
dimeskigj/pulumi-dokploy

dokploy.Domain

dokploy logo Dokploy
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
Schema (JSON)
dimeskigj/pulumi-dokploy

    A Dokploy domain routing rule.

    Create Domain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
    @overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           host: Optional[str] = None,
           application_id: Optional[str] = None,
           certificate_type: Optional[str] = None,
           compose_id: Optional[str] = None,
           custom_cert_resolver: Optional[str] = None,
           enabled: Optional[bool] = None,
           https: Optional[bool] = None,
           internal_path: Optional[str] = None,
           path: Optional[str] = None,
           port: Optional[int] = None,
           service_name: Optional[str] = None,
           strip_path: Optional[bool] = None)
    func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

    type: dokploy:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "dokploy_domain" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var domainResource = new Dokploy.Domain("domainResource", new()
{
    Host = "string",
    ApplicationId = "string",
    CertificateType = "string",
    ComposeId = "string",
    CustomCertResolver = "string",
    Enabled = false,
    Https = false,
    InternalPath = "string",
    Path = "string",
    Port = 0,
    ServiceName = "string",
    StripPath = false,
});

    example, err := dokploy.NewDomain(ctx, "domainResource", &dokploy.DomainArgs{
	Host:               pulumi.String("string"),
	ApplicationId:      pulumi.String("string"),
	CertificateType:    pulumi.String("string"),
	ComposeId:          pulumi.String("string"),
	CustomCertResolver: pulumi.String("string"),
	Enabled:            pulumi.Bool(false),
	Https:              pulumi.Bool(false),
	InternalPath:       pulumi.String("string"),
	Path:               pulumi.String("string"),
	Port:               pulumi.Int(0),
	ServiceName:        pulumi.String("string"),
	StripPath:          pulumi.Bool(false),
})

    resource "dokploy_domain" "domainResource" {
  pulumi {
    replace_on_changes = [application_id, compose_id, service_name]
  }
  lifecycle {
    create_before_destroy = true
  }
  host                 = "string"
  application_id       = "string"
  certificate_type     = "string"
  compose_id           = "string"
  custom_cert_resolver = "string"
  enabled              = false
  https                = false
  internal_path        = "string"
  path                 = "string"
  port                 = 0
  service_name         = "string"
  strip_path           = false
}

    var domainResource = new Domain("domainResource", DomainArgs.builder()
    .host("string")
    .applicationId("string")
    .certificateType("string")
    .composeId("string")
    .customCertResolver("string")
    .enabled(false)
    .https(false)
    .internalPath("string")
    .path("string")
    .port(0)
    .serviceName("string")
    .stripPath(false)
    .build());

    domain_resource = dokploy.Domain("domainResource",
    host="string",
    application_id="string",
    certificate_type="string",
    compose_id="string",
    custom_cert_resolver="string",
    enabled=False,
    https=False,
    internal_path="string",
    path="string",
    port=0,
    service_name="string",
    strip_path=False)

    const domainResource = new dokploy.Domain("domainResource", {
    host: "string",
    applicationId: "string",
    certificateType: "string",
    composeId: "string",
    customCertResolver: "string",
    enabled: false,
    https: false,
    internalPath: "string",
    path: "string",
    port: 0,
    serviceName: "string",
    stripPath: false,
});

    type: dokploy:Domain
properties:
    applicationId: string
    certificateType: string
    composeId: string
    customCertResolver: string
    enabled: false
    host: string
    https: false
    internalPath: string
    path: string
    port: 0
    serviceName: string
    stripPath: false

    Domain Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Domain resource accepts the following input properties:

    Host string
    The domain hostname.
    ApplicationId string
    The optional application ID target.
    CertificateType string
    The certificate resolver type.
    ComposeId string
    The optional Compose ID target.
    CustomCertResolver string
    The custom certificate resolver.
    Enabled bool
    Whether the domain is enabled.
    Https bool
    Whether HTTPS is enabled.
    InternalPath string
    The internal URL path.
    Path string
    The public URL path.
    Port int
    The target port.
    ServiceName string
    The Compose service name.
    StripPath bool
    Whether to strip the public path.
    Host string
    The domain hostname.
    ApplicationId string
    The optional application ID target.
    CertificateType string
    The certificate resolver type.
    ComposeId string
    The optional Compose ID target.
    CustomCertResolver string
    The custom certificate resolver.
    Enabled bool
    Whether the domain is enabled.
    Https bool
    Whether HTTPS is enabled.
    InternalPath string
    The internal URL path.
    Path string
    The public URL path.
    Port int
    The target port.
    ServiceName string
    The Compose service name.
    StripPath bool
    Whether to strip the public path.
    host string
    The domain hostname.
    application_id string
    The optional application ID target.
    certificate_type string
    The certificate resolver type.
    compose_id string
    The optional Compose ID target.
    custom_cert_resolver string
    The custom certificate resolver.
    enabled bool
    Whether the domain is enabled.
    https bool
    Whether HTTPS is enabled.
    internal_path string
    The internal URL path.
    path string
    The public URL path.
    port number
    The target port.
    service_name string
    The Compose service name.
    strip_path bool
    Whether to strip the public path.
    host String
    The domain hostname.
    applicationId String
    The optional application ID target.
    certificateType String
    The certificate resolver type.
    composeId String
    The optional Compose ID target.
    customCertResolver String
    The custom certificate resolver.
    enabled Boolean
    Whether the domain is enabled.
    https Boolean
    Whether HTTPS is enabled.
    internalPath String
    The internal URL path.
    path String
    The public URL path.
    port Integer
    The target port.
    serviceName String
    The Compose service name.
    stripPath Boolean
    Whether to strip the public path.
    host string
    The domain hostname.
    applicationId string
    The optional application ID target.
    certificateType string
    The certificate resolver type.
    composeId string
    The optional Compose ID target.
    customCertResolver string
    The custom certificate resolver.
    enabled boolean
    Whether the domain is enabled.
    https boolean
    Whether HTTPS is enabled.
    internalPath string
    The internal URL path.
    path string
    The public URL path.
    port number
    The target port.
    serviceName string
    The Compose service name.
    stripPath boolean
    Whether to strip the public path.
    host str
    The domain hostname.
    application_id str
    The optional application ID target.
    certificate_type str
    The certificate resolver type.
    compose_id str
    The optional Compose ID target.
    custom_cert_resolver str
    The custom certificate resolver.
    enabled bool
    Whether the domain is enabled.
    https bool
    Whether HTTPS is enabled.
    internal_path str
    The internal URL path.
    path str
    The public URL path.
    port int
    The target port.
    service_name str
    The Compose service name.
    strip_path bool
    Whether to strip the public path.
    host String
    The domain hostname.
    applicationId String
    The optional application ID target.
    certificateType String
    The certificate resolver type.
    composeId String
    The optional Compose ID target.
    customCertResolver String
    The custom certificate resolver.
    enabled Boolean
    Whether the domain is enabled.
    https Boolean
    Whether HTTPS is enabled.
    internalPath String
    The internal URL path.
    path String
    The public URL path.
    port Number
    The target port.
    serviceName String
    The Compose service name.
    stripPath Boolean
    Whether to strip the public path.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:

    DomainId string
    The stable Dokploy domain ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    DomainId string
    The stable Dokploy domain ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    domain_id string
    The stable Dokploy domain ID.
    id string
    The provider-assigned unique ID for this managed resource.
    domainId String
    The stable Dokploy domain ID.
    id String
    The provider-assigned unique ID for this managed resource.
    domainId string
    The stable Dokploy domain ID.
    id string
    The provider-assigned unique ID for this managed resource.
    domain_id str
    The stable Dokploy domain ID.
    id str
    The provider-assigned unique ID for this managed resource.
    domainId String
    The stable Dokploy domain ID.
    id String
    The provider-assigned unique ID for this managed resource.

    Package Details

    Repository
    dokploy dimeskigj/pulumi-dokploy
    License
    Apache-2.0
    dokploy logo Dokploy
    Viewing docs for Dokploy v0.3.1
    published on Tuesday, Sep 29, 2026 by dimeskigj
    Schema (JSON)
    dimeskigj/pulumi-dokploy

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial