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 Compose deployment by ID without managing it.
Using getCompose
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 getCompose(args: GetComposeArgs, opts?: InvokeOptions): Promise<GetComposeResult>
function getComposeOutput(args: GetComposeOutputArgs, opts?: InvokeOutputOptions): Output<GetComposeResult>def get_compose(compose_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetComposeResult
def get_compose_output(compose_id: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetComposeResult]func LookupCompose(ctx *Context, args *LookupComposeArgs, opts ...InvokeOption) (*LookupComposeResult, error)
func LookupComposeOutput(ctx *Context, args *LookupComposeOutputArgs, opts ...InvokeOption) LookupComposeResultOutput> Note: This function is named LookupCompose in the Go SDK.
public static class GetCompose
{
public static Task<GetComposeResult> InvokeAsync(GetComposeArgs args, InvokeOptions? opts = null)
public static Output<GetComposeResult> Invoke(GetComposeInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetComposeResult> Invoke(GetComposeInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetComposeResult> getCompose(GetComposeArgs args, InvokeOptions options)
public static Output<GetComposeResult> getCompose(GetComposeArgs args, InvokeOptions options)
public static Output<GetComposeResult> getCompose(GetComposeArgs args, InvokeOutputOptions options)
fn::invoke:
function: dokploy:getCompose
arguments:
# arguments dictionarydata "dokploy_get_compose" "name" {
# arguments
}The following arguments are supported:
- Compose
Id string - The ID of the existing Dokploy Compose deployment to read.
- Compose
Id string - The ID of the existing Dokploy Compose deployment to read.
- compose_
id string - The ID of the existing Dokploy Compose deployment to read.
- compose
Id String - The ID of the existing Dokploy Compose deployment to read.
- compose
Id string - The ID of the existing Dokploy Compose deployment to read.
- compose_
id str - The ID of the existing Dokploy Compose deployment to read.
- compose
Id String - The ID of the existing Dokploy Compose deployment to read.
getCompose Result
The following output properties are available:
- Compose
Id string - The stable Dokploy Compose ID.
- Name string
- The Compose deployment name.
- App
Name string - The optional application name metadata.
- Compose
Type string - The optional Compose type.
- Description string
- The optional description metadata.
- Environment
Id string - The optional environment ID metadata.
- Server
Id string - The optional server ID metadata.
- Status string
- The optional Compose status.
- Compose
Id string - The stable Dokploy Compose ID.
- Name string
- The Compose deployment name.
- App
Name string - The optional application name metadata.
- Compose
Type string - The optional Compose type.
- Description string
- The optional description metadata.
- Environment
Id string - The optional environment ID metadata.
- Server
Id string - The optional server ID metadata.
- Status string
- The optional Compose status.
- compose_
id string - The stable Dokploy Compose ID.
- name string
- The Compose deployment name.
- app_
name string - The optional application name metadata.
- compose_
type string - The optional Compose type.
- description string
- The optional description metadata.
- environment_
id string - The optional environment ID metadata.
- server_
id string - The optional server ID metadata.
- status string
- The optional Compose status.
- compose
Id String - The stable Dokploy Compose ID.
- name String
- The Compose deployment name.
- app
Name String - The optional application name metadata.
- compose
Type String - The optional Compose type.
- description String
- The optional description metadata.
- environment
Id String - The optional environment ID metadata.
- server
Id String - The optional server ID metadata.
- status String
- The optional Compose status.
- compose
Id string - The stable Dokploy Compose ID.
- name string
- The Compose deployment name.
- app
Name string - The optional application name metadata.
- compose
Type string - The optional Compose type.
- description string
- The optional description metadata.
- environment
Id string - The optional environment ID metadata.
- server
Id string - The optional server ID metadata.
- status string
- The optional Compose status.
- compose_
id str - The stable Dokploy Compose ID.
- name str
- The Compose deployment name.
- app_
name str - The optional application name metadata.
- compose_
type str - The optional Compose type.
- description str
- The optional description metadata.
- environment_
id str - The optional environment ID metadata.
- server_
id str - The optional server ID metadata.
- status str
- The optional Compose status.
- compose
Id String - The stable Dokploy Compose ID.
- name String
- The Compose deployment name.
- app
Name String - The optional application name metadata.
- compose
Type String - The optional Compose type.
- description String
- The optional description metadata.
- environment
Id String - The optional environment ID metadata.
- server
Id String - The optional server ID metadata.
- status String
- The optional Compose status.
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