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

dokploy.Environment

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 environment.

    Create Environment Resource

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

    Constructor syntax

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

@overload
def Environment(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                name: Optional[str] = None,
                project_id: Optional[str] = None,
                description: Optional[str] = None)
    func NewEnvironment(ctx *Context, name string, args EnvironmentArgs, opts ...ResourceOption) (*Environment, error)
    public Environment(string name, EnvironmentArgs args, CustomResourceOptions? opts = null)
    public Environment(String name, EnvironmentArgs args)
public Environment(String name, EnvironmentArgs args, CustomResourceOptions options)

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


    resource "dokploy_environment" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args EnvironmentArgs
    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 EnvironmentArgs
    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 EnvironmentArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args EnvironmentArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args EnvironmentArgs
    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 environmentResource = new Dokploy.Environment("environmentResource", new()
{
    Name = "string",
    ProjectId = "string",
    Description = "string",
});

    example, err := dokploy.NewEnvironment(ctx, "environmentResource", &dokploy.EnvironmentArgs{
	Name:        pulumi.String("string"),
	ProjectId:   pulumi.String("string"),
	Description: pulumi.String("string"),
})

    resource "dokploy_environment" "environmentResource" {
  lifecycle {
    create_before_destroy = true
  }
  name        = "string"
  project_id  = "string"
  description = "string"
}

    var environmentResource = new Environment("environmentResource", EnvironmentArgs.builder()
    .name("string")
    .projectId("string")
    .description("string")
    .build());

    environment_resource = dokploy.Environment("environmentResource",
    name="string",
    project_id="string",
    description="string")

    const environmentResource = new dokploy.Environment("environmentResource", {
    name: "string",
    projectId: "string",
    description: "string",
});

    type: dokploy:Environment
properties:
    description: string
    name: string
    projectId: string

    Environment 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 Environment resource accepts the following input properties:

    Name string
    The environment name.
    ProjectId string
    The parent project ID.
    Description string
    An optional environment description.
    Name string
    The environment name.
    ProjectId string
    The parent project ID.
    Description string
    An optional environment description.
    name string
    The environment name.
    project_id string
    The parent project ID.
    description string
    An optional environment description.
    name String
    The environment name.
    projectId String
    The parent project ID.
    description String
    An optional environment description.
    name string
    The environment name.
    projectId string
    The parent project ID.
    description string
    An optional environment description.
    name str
    The environment name.
    project_id str
    The parent project ID.
    description str
    An optional environment description.
    name String
    The environment name.
    projectId String
    The parent project ID.
    description String
    An optional environment description.

    Outputs

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

    EnvironmentId string
    The stable Dokploy environment ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether this is the default environment.
    EnvironmentId string
    The stable Dokploy environment ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether this is the default environment.
    environment_id string
    The stable Dokploy environment ID.
    id string
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Whether this is the default environment.
    environmentId String
    The stable Dokploy environment ID.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether this is the default environment.
    environmentId string
    The stable Dokploy environment ID.
    id string
    The provider-assigned unique ID for this managed resource.
    isDefault boolean
    Whether this is the default environment.
    environment_id str
    The stable Dokploy environment ID.
    id str
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Whether this is the default environment.
    environmentId String
    The stable Dokploy environment ID.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether this is the default environment.

    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