1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. getProject
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 project by ID without managing it.

    Using getProject

    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 getProject(args: GetProjectArgs, opts?: InvokeOptions): Promise<GetProjectResult>
    function getProjectOutput(args: GetProjectOutputArgs, opts?: InvokeOutputOptions): Output<GetProjectResult>
    def get_project(project_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetProjectResult
    def get_project_output(project_id: pulumi.Input[Optional[str]] = None,
                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetProjectResult]
    func LookupProject(ctx *Context, args *LookupProjectArgs, opts ...InvokeOption) (*LookupProjectResult, error)
    func LookupProjectOutput(ctx *Context, args *LookupProjectOutputArgs, opts ...InvokeOption) LookupProjectResultOutput

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

    public static class GetProject 
    {
        public static Task<GetProjectResult> InvokeAsync(GetProjectArgs args, InvokeOptions? opts = null)
        public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetProjectResult> Invoke(GetProjectInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
    public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOptions options)
    public static Output<GetProjectResult> getProject(GetProjectArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: dokploy:getProject
      arguments:
        # arguments dictionary
    data "dokploy_get_project" "name" {
        # arguments
    }

    The following arguments are supported:

    ProjectId string
    The ID of the existing Dokploy project to read.
    ProjectId string
    The ID of the existing Dokploy project to read.
    project_id string
    The ID of the existing Dokploy project to read.
    projectId String
    The ID of the existing Dokploy project to read.
    projectId string
    The ID of the existing Dokploy project to read.
    project_id str
    The ID of the existing Dokploy project to read.
    projectId String
    The ID of the existing Dokploy project to read.

    getProject Result

    The following output properties are available:

    Name string
    The project name.
    ProjectId string
    The stable Dokploy project ID.
    DefaultEnvironmentId string
    The optional default environment ID metadata.
    Description string
    The optional description metadata.
    Name string
    The project name.
    ProjectId string
    The stable Dokploy project ID.
    DefaultEnvironmentId string
    The optional default environment ID metadata.
    Description string
    The optional description metadata.
    name string
    The project name.
    project_id string
    The stable Dokploy project ID.
    default_environment_id string
    The optional default environment ID metadata.
    description string
    The optional description metadata.
    name String
    The project name.
    projectId String
    The stable Dokploy project ID.
    defaultEnvironmentId String
    The optional default environment ID metadata.
    description String
    The optional description metadata.
    name string
    The project name.
    projectId string
    The stable Dokploy project ID.
    defaultEnvironmentId string
    The optional default environment ID metadata.
    description string
    The optional description metadata.
    name str
    The project name.
    project_id str
    The stable Dokploy project ID.
    default_environment_id str
    The optional default environment ID metadata.
    description str
    The optional description metadata.
    name String
    The project name.
    projectId String
    The stable Dokploy project ID.
    defaultEnvironmentId String
    The optional default environment ID metadata.
    description String
    The optional description 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