Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj
published on Thursday, Nov 5, 2026 by dimeskigj
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj
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 dictionarydata "dokploy_get_environment" "name" {
# arguments
}The following arguments are supported:
- Environment
Id string - The ID of the existing Dokploy environment to read.
- Environment
Id string - The ID of the existing Dokploy environment to read.
- environment_
id string - The ID of the existing Dokploy environment to read.
- environment
Id String - The ID of the existing Dokploy environment to read.
- environment
Id string - The ID of the existing Dokploy environment to read.
- environment_
id str - The ID of the existing Dokploy environment to read.
- environment
Id String - The ID of the existing Dokploy environment to read.
getEnvironment Result
The following output properties are available:
- 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.
- 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.
- 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.
- environment
Id String - The stable Dokploy environment ID.
- name String
- The environment name.
- description String
- The optional description metadata.
- is
Default Boolean - The optional is default metadata.
- project
Id 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 boolean - The optional is default metadata.
- project
Id 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.
- environment
Id String - The stable Dokploy environment ID.
- name String
- The environment name.
- description String
- The optional description metadata.
- is
Default Boolean - The optional is default metadata.
- project
Id String - The optional project ID metadata.
Package Details
- Repository
- dokploy dimeskigj/pulumi-dokploy
- License
- Apache-2.0
Viewing docs for Dokploy v0.4.4
published on Thursday, Nov 5, 2026 by dimeskigj
published on Thursday, Nov 5, 2026 by dimeskigj