1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. getCompose
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 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 dictionary
    data "dokploy_get_compose" "name" {
        # arguments
    }

    The following arguments are supported:

    ComposeId string
    The ID of the existing Dokploy Compose deployment to read.
    ComposeId string
    The ID of the existing Dokploy Compose deployment to read.
    compose_id string
    The ID of the existing Dokploy Compose deployment to read.
    composeId String
    The ID of the existing Dokploy Compose deployment to read.
    composeId string
    The ID of the existing Dokploy Compose deployment to read.
    compose_id str
    The ID of the existing Dokploy Compose deployment to read.
    composeId String
    The ID of the existing Dokploy Compose deployment to read.

    getCompose Result

    The following output properties are available:

    ComposeId string
    The stable Dokploy Compose ID.
    Name string
    The Compose deployment name.
    AppName string
    The optional application name metadata.
    ComposeType string
    The optional Compose type.
    Description string
    The optional description metadata.
    EnvironmentId string
    The optional environment ID metadata.
    ServerId string
    The optional server ID metadata.
    Status string
    The optional Compose status.
    ComposeId string
    The stable Dokploy Compose ID.
    Name string
    The Compose deployment name.
    AppName string
    The optional application name metadata.
    ComposeType string
    The optional Compose type.
    Description string
    The optional description metadata.
    EnvironmentId string
    The optional environment ID metadata.
    ServerId 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.
    composeId String
    The stable Dokploy Compose ID.
    name String
    The Compose deployment name.
    appName String
    The optional application name metadata.
    composeType String
    The optional Compose type.
    description String
    The optional description metadata.
    environmentId String
    The optional environment ID metadata.
    serverId String
    The optional server ID metadata.
    status String
    The optional Compose status.
    composeId string
    The stable Dokploy Compose ID.
    name string
    The Compose deployment name.
    appName string
    The optional application name metadata.
    composeType string
    The optional Compose type.
    description string
    The optional description metadata.
    environmentId string
    The optional environment ID metadata.
    serverId 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.
    composeId String
    The stable Dokploy Compose ID.
    name String
    The Compose deployment name.
    appName String
    The optional application name metadata.
    composeType String
    The optional Compose type.
    description String
    The optional description metadata.
    environmentId String
    The optional environment ID metadata.
    serverId String
    The optional server ID metadata.
    status String
    The optional Compose status.

    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