1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. getEnvironment
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj
dokploy logo Dokploy
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj

    Read non-secret metadata for an existing Dokploy environment by ID without managing it.

    Using getEnvironment

    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 getEnvironment(args: GetEnvironmentArgs, opts?: InvokeOptions): Promise<GetEnvironmentResult>
    function getEnvironmentOutput(args: GetEnvironmentOutputArgs, opts?: InvokeOutputOptions): Output<GetEnvironmentResult>
    def get_environment(environment_id: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEnvironmentResult
    def get_environment_output(environment_id: pulumi.Input[Optional[str]] = None,
                        opts: Optional[InvokeOutputOptions] = None) -> Output[GetEnvironmentResult]
    func LookupEnvironment(ctx *Context, args *LookupEnvironmentArgs, opts ...InvokeOption) (*LookupEnvironmentResult, error)
    func LookupEnvironmentOutput(ctx *Context, args *LookupEnvironmentOutputArgs, opts ...InvokeOption) LookupEnvironmentResultOutput

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

    public static class GetEnvironment 
    {
        public static Task<GetEnvironmentResult> InvokeAsync(GetEnvironmentArgs args, InvokeOptions? opts = null)
        public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetEnvironmentResult> Invoke(GetEnvironmentInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
    public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOptions options)
    public static Output<GetEnvironmentResult> getEnvironment(GetEnvironmentArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: dokploy:getEnvironment
      arguments:
        # arguments dictionary
    data "dokploy_get_environment" "name" {
        # arguments
    }

    The following arguments are supported:

    EnvironmentId string
    The ID of the existing Dokploy environment to read.
    EnvironmentId string
    The ID of the existing Dokploy environment to read.
    environment_id string
    The ID of the existing Dokploy environment to read.
    environmentId String
    The ID of the existing Dokploy environment to read.
    environmentId string
    The ID of the existing Dokploy environment to read.
    environment_id str
    The ID of the existing Dokploy environment to read.
    environmentId String
    The ID of the existing Dokploy environment to read.

    getEnvironment Result

    The following output properties are available:

    EnvironmentId string
    The stable Dokploy environment ID.
    Name string
    The environment name.
    Description string
    The optional description metadata.
    IsDefault bool
    The optional is default metadata.
    ProjectId string
    The optional project ID metadata.
    EnvironmentId string
    The stable Dokploy environment ID.
    Name string
    The environment name.
    Description string
    The optional description metadata.
    IsDefault bool
    The optional is default metadata.
    ProjectId string
    The optional project ID metadata.
    environment_id string
    The stable Dokploy environment ID.
    name string
    The environment name.
    description string
    The optional description metadata.
    is_default bool
    The optional is default metadata.
    project_id string
    The optional project ID metadata.
    environmentId String
    The stable Dokploy environment ID.
    name String
    The environment name.
    description String
    The optional description metadata.
    isDefault Boolean
    The optional is default metadata.
    projectId String
    The optional project ID metadata.
    environmentId string
    The stable Dokploy environment ID.
    name string
    The environment name.
    description string
    The optional description metadata.
    isDefault boolean
    The optional is default metadata.
    projectId string
    The optional project ID metadata.
    environment_id str
    The stable Dokploy environment ID.
    name str
    The environment name.
    description str
    The optional description metadata.
    is_default bool
    The optional is default metadata.
    project_id str
    The optional project ID metadata.
    environmentId String
    The stable Dokploy environment ID.
    name String
    The environment name.
    description String
    The optional description metadata.
    isDefault Boolean
    The optional is default metadata.
    projectId String
    The optional project ID metadata.

    Package Details

    Repository
    dokploy dimeskigj/pulumi-dokploy
    License
    Apache-2.0
    dokploy logo Dokploy
    Viewing docs for Dokploy v0.4.4
    published on Thursday, Nov 5, 2026 by dimeskigj

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial