1. Registry
  2. Packages
  3. Dokploy
  4. API Docs
  5. Project
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj
dokploy logo Dokploy
Viewing docs for Dokploy v0.3.1
published on Tuesday, Sep 29, 2026 by dimeskigj

    A Dokploy project.

    Create Project Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Project(name: string, args: ProjectArgs, opts?: CustomResourceOptions);
    @overload
    def Project(resource_name: str,
                args: ProjectArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Project(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                name: Optional[str] = None,
                description: Optional[str] = None)
    func NewProject(ctx *Context, name string, args ProjectArgs, opts ...ResourceOption) (*Project, error)
    public Project(string name, ProjectArgs args, CustomResourceOptions? opts = null)
    public Project(String name, ProjectArgs args)
    public Project(String name, ProjectArgs args, CustomResourceOptions options)
    
    type: dokploy:Project
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "dokploy_project" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ProjectArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var projectResource = new Dokploy.Project("projectResource", new()
    {
        Name = "string",
        Description = "string",
    });
    
    example, err := dokploy.NewProject(ctx, "projectResource", &dokploy.ProjectArgs{
    	Name:        pulumi.String("string"),
    	Description: pulumi.String("string"),
    })
    
    resource "dokploy_project" "projectResource" {
      lifecycle {
        create_before_destroy = true
      }
      name        = "string"
      description = "string"
    }
    
    var projectResource = new Project("projectResource", ProjectArgs.builder()
        .name("string")
        .description("string")
        .build());
    
    project_resource = dokploy.Project("projectResource",
        name="string",
        description="string")
    
    const projectResource = new dokploy.Project("projectResource", {
        name: "string",
        description: "string",
    });
    
    type: dokploy:Project
    properties:
        description: string
        name: string
    

    Project Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Project resource accepts the following input properties:

    Name string
    The project name.
    Description string
    An optional project description.
    Name string
    The project name.
    Description string
    An optional project description.
    name string
    The project name.
    description string
    An optional project description.
    name String
    The project name.
    description String
    An optional project description.
    name string
    The project name.
    description string
    An optional project description.
    name str
    The project name.
    description str
    An optional project description.
    name String
    The project name.
    description String
    An optional project description.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Project resource produces the following output properties:

    DefaultEnvironmentId string
    The project's default environment ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    The stable Dokploy project ID.
    DefaultEnvironmentId string
    The project's default environment ID.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    The stable Dokploy project ID.
    default_environment_id string
    The project's default environment ID.
    id string
    The provider-assigned unique ID for this managed resource.
    project_id string
    The stable Dokploy project ID.
    defaultEnvironmentId String
    The project's default environment ID.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    The stable Dokploy project ID.
    defaultEnvironmentId string
    The project's default environment ID.
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    The stable Dokploy project ID.
    default_environment_id str
    The project's default environment ID.
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    The stable Dokploy project ID.
    defaultEnvironmentId String
    The project's default environment ID.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    The stable Dokploy project ID.

    Package Details

    Repository
    dokploy dimeskigj/pulumi-dokploy
    License
    Apache-2.0
    dokploy logo Dokploy
    Viewing docs for Dokploy v0.3.1
    published on Tuesday, Sep 29, 2026 by dimeskigj

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial