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
A remote server record in Dokploy; does not bootstrap or destroy the remote machine.
Create Server Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Server(name: string, args: ServerArgs, opts?: CustomResourceOptions);@overload
def Server(resource_name: str,
args: ServerArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Server(resource_name: str,
opts: Optional[ResourceOptions] = None,
ip_address: Optional[str] = None,
name: Optional[str] = None,
description: Optional[str] = None,
enable_docker_cleanup: Optional[bool] = None,
port: Optional[int] = None,
server_type: Optional[str] = None,
ssh_key_id: Optional[str] = None,
username: Optional[str] = None)func NewServer(ctx *Context, name string, args ServerArgs, opts ...ResourceOption) (*Server, error)public Server(string name, ServerArgs args, CustomResourceOptions? opts = null)
public Server(String name, ServerArgs args)
public Server(String name, ServerArgs args, CustomResourceOptions options)
type: dokploy:Server
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "dokploy_server" "name" {
# resource properties
}Parameters
- name string
- The unique name of the resource.
- args ServerArgs
- 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 ServerArgs
- 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 ServerArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args ServerArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args ServerArgs
- 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 serverResource = new Dokploy.Server("serverResource", new()
{
IpAddress = "string",
Name = "string",
Description = "string",
EnableDockerCleanup = false,
Port = 0,
ServerType = "string",
SshKeyId = "string",
Username = "string",
});
example, err := dokploy.NewServer(ctx, "serverResource", &dokploy.ServerArgs{
IpAddress: pulumi.String("string"),
Name: pulumi.String("string"),
Description: pulumi.String("string"),
EnableDockerCleanup: pulumi.Bool(false),
Port: pulumi.Int(0),
ServerType: pulumi.String("string"),
SshKeyId: pulumi.String("string"),
Username: pulumi.String("string"),
})
resource "dokploy_server" "serverResource" {
lifecycle {
create_before_destroy = true
}
ip_address = "string"
name = "string"
description = "string"
enable_docker_cleanup = false
port = 0
server_type = "string"
ssh_key_id = "string"
username = "string"
}
var serverResource = new Server("serverResource", ServerArgs.builder()
.ipAddress("string")
.name("string")
.description("string")
.enableDockerCleanup(false)
.port(0)
.serverType("string")
.sshKeyId("string")
.username("string")
.build());
server_resource = dokploy.Server("serverResource",
ip_address="string",
name="string",
description="string",
enable_docker_cleanup=False,
port=0,
server_type="string",
ssh_key_id="string",
username="string")
const serverResource = new dokploy.Server("serverResource", {
ipAddress: "string",
name: "string",
description: "string",
enableDockerCleanup: false,
port: 0,
serverType: "string",
sshKeyId: "string",
username: "string",
});
type: dokploy:Server
properties:
description: string
enableDockerCleanup: false
ipAddress: string
name: string
port: 0
serverType: string
sshKeyId: string
username: string
Server 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 Server resource accepts the following input properties:
- Ip
Address string - Hostname or IP address of the remote server.
- Name string
- Server name.
- Description string
- Optional description; omission clears the description.
- Enable
Docker boolCleanup - Enable Dokploy's recurring Docker cleanup schedule; defaults to false.
- Port int
- SSH port (1–65535); defaults to 22.
- Server
Type string - Server role: deploy or build; defaults to deploy.
- Ssh
Key stringId - Managed SSH key ID; omission clears the key.
- Username string
- SSH username; defaults to root.
- Ip
Address string - Hostname or IP address of the remote server.
- Name string
- Server name.
- Description string
- Optional description; omission clears the description.
- Enable
Docker boolCleanup - Enable Dokploy's recurring Docker cleanup schedule; defaults to false.
- Port int
- SSH port (1–65535); defaults to 22.
- Server
Type string - Server role: deploy or build; defaults to deploy.
- Ssh
Key stringId - Managed SSH key ID; omission clears the key.
- Username string
- SSH username; defaults to root.
- ip_
address string - Hostname or IP address of the remote server.
- name string
- Server name.
- description string
- Optional description; omission clears the description.
- enable_
docker_ boolcleanup - Enable Dokploy's recurring Docker cleanup schedule; defaults to false.
- port number
- SSH port (1–65535); defaults to 22.
- server_
type string - Server role: deploy or build; defaults to deploy.
- ssh_
key_ stringid - Managed SSH key ID; omission clears the key.
- username string
- SSH username; defaults to root.
- ip
Address String - Hostname or IP address of the remote server.
- name String
- Server name.
- description String
- Optional description; omission clears the description.
- enable
Docker BooleanCleanup - Enable Dokploy's recurring Docker cleanup schedule; defaults to false.
- port Integer
- SSH port (1–65535); defaults to 22.
- server
Type String - Server role: deploy or build; defaults to deploy.
- ssh
Key StringId - Managed SSH key ID; omission clears the key.
- username String
- SSH username; defaults to root.
- ip
Address string - Hostname or IP address of the remote server.
- name string
- Server name.
- description string
- Optional description; omission clears the description.
- enable
Docker booleanCleanup - Enable Dokploy's recurring Docker cleanup schedule; defaults to false.
- port number
- SSH port (1–65535); defaults to 22.
- server
Type string - Server role: deploy or build; defaults to deploy.
- ssh
Key stringId - Managed SSH key ID; omission clears the key.
- username string
- SSH username; defaults to root.
- ip_
address str - Hostname or IP address of the remote server.
- name str
- Server name.
- description str
- Optional description; omission clears the description.
- enable_
docker_ boolcleanup - Enable Dokploy's recurring Docker cleanup schedule; defaults to false.
- port int
- SSH port (1–65535); defaults to 22.
- server_
type str - Server role: deploy or build; defaults to deploy.
- ssh_
key_ strid - Managed SSH key ID; omission clears the key.
- username str
- SSH username; defaults to root.
- ip
Address String - Hostname or IP address of the remote server.
- name String
- Server name.
- description String
- Optional description; omission clears the description.
- enable
Docker BooleanCleanup - Enable Dokploy's recurring Docker cleanup schedule; defaults to false.
- port Number
- SSH port (1–65535); defaults to 22.
- server
Type String - Server role: deploy or build; defaults to deploy.
- ssh
Key StringId - Managed SSH key ID; omission clears the key.
- username String
- SSH username; defaults to root.
Outputs
All input properties are implicitly available as output properties. Additionally, the Server resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Server
Id string - Stable Dokploy server ID.
- Organization
Id string - Owning Dokploy organization ID.
- Status string
- Dokploy server status (not a readiness guarantee).
- Id string
- The provider-assigned unique ID for this managed resource.
- Server
Id string - Stable Dokploy server ID.
- Organization
Id string - Owning Dokploy organization ID.
- Status string
- Dokploy server status (not a readiness guarantee).
- id string
- The provider-assigned unique ID for this managed resource.
- server_
id string - Stable Dokploy server ID.
- organization_
id string - Owning Dokploy organization ID.
- status string
- Dokploy server status (not a readiness guarantee).
- id String
- The provider-assigned unique ID for this managed resource.
- server
Id String - Stable Dokploy server ID.
- organization
Id String - Owning Dokploy organization ID.
- status String
- Dokploy server status (not a readiness guarantee).
- id string
- The provider-assigned unique ID for this managed resource.
- server
Id string - Stable Dokploy server ID.
- organization
Id string - Owning Dokploy organization ID.
- status string
- Dokploy server status (not a readiness guarantee).
- id str
- The provider-assigned unique ID for this managed resource.
- server_
id str - Stable Dokploy server ID.
- organization_
id str - Owning Dokploy organization ID.
- status str
- Dokploy server status (not a readiness guarantee).
- id String
- The provider-assigned unique ID for this managed resource.
- server
Id String - Stable Dokploy server ID.
- organization
Id String - Owning Dokploy organization ID.
- status String
- Dokploy server status (not a readiness guarantee).
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