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 server by ID without managing it.
Using getServer
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 getServer(args: GetServerArgs, opts?: InvokeOptions): Promise<GetServerResult>
function getServerOutput(args: GetServerOutputArgs, opts?: InvokeOutputOptions): Output<GetServerResult>def get_server(server_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetServerResult
def get_server_output(server_id: pulumi.Input[Optional[str]] = None,
opts: Optional[InvokeOutputOptions] = None) -> Output[GetServerResult]func LookupServer(ctx *Context, args *LookupServerArgs, opts ...InvokeOption) (*LookupServerResult, error)
func LookupServerOutput(ctx *Context, args *LookupServerOutputArgs, opts ...InvokeOption) LookupServerResultOutput> Note: This function is named LookupServer in the Go SDK.
public static class GetServer
{
public static Task<GetServerResult> InvokeAsync(GetServerArgs args, InvokeOptions? opts = null)
public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOptions? opts = null)
public static Output<GetServerResult> Invoke(GetServerInvokeArgs args, InvokeOutputOptions opts)
}public static CompletableFuture<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
public static Output<GetServerResult> getServer(GetServerArgs args, InvokeOptions options)
public static Output<GetServerResult> getServer(GetServerArgs args, InvokeOutputOptions options)
fn::invoke:
function: dokploy:getServer
arguments:
# arguments dictionarydata "dokploy_get_server" "name" {
# arguments
}The following arguments are supported:
- Server
Id string - The ID of the existing Dokploy server to read.
- Server
Id string - The ID of the existing Dokploy server to read.
- server_
id string - The ID of the existing Dokploy server to read.
- server
Id String - The ID of the existing Dokploy server to read.
- server
Id string - The ID of the existing Dokploy server to read.
- server_
id str - The ID of the existing Dokploy server to read.
- server
Id String - The ID of the existing Dokploy server to read.
getServer Result
The following output properties are available:
- Name string
- The server name.
- Server
Id string - The stable Dokploy server ID.
- Description string
- The optional description metadata.
- Ip
Address string - The optional IP address metadata.
- Organization
Id string - The optional organization ID metadata.
- Port int
- The optional port metadata.
- Server
Type string - The optional server type metadata.
- Ssh
Key stringId - The optional SSH key ID metadata.
- Status string
- The optional status metadata.
- Username string
- The optional username metadata.
- Name string
- The server name.
- Server
Id string - The stable Dokploy server ID.
- Description string
- The optional description metadata.
- Ip
Address string - The optional IP address metadata.
- Organization
Id string - The optional organization ID metadata.
- Port int
- The optional port metadata.
- Server
Type string - The optional server type metadata.
- Ssh
Key stringId - The optional SSH key ID metadata.
- Status string
- The optional status metadata.
- Username string
- The optional username metadata.
- name string
- The server name.
- server_
id string - The stable Dokploy server ID.
- description string
- The optional description metadata.
- ip_
address string - The optional IP address metadata.
- organization_
id string - The optional organization ID metadata.
- port number
- The optional port metadata.
- server_
type string - The optional server type metadata.
- ssh_
key_ stringid - The optional SSH key ID metadata.
- status string
- The optional status metadata.
- username string
- The optional username metadata.
- name String
- The server name.
- server
Id String - The stable Dokploy server ID.
- description String
- The optional description metadata.
- ip
Address String - The optional IP address metadata.
- organization
Id String - The optional organization ID metadata.
- port Integer
- The optional port metadata.
- server
Type String - The optional server type metadata.
- ssh
Key StringId - The optional SSH key ID metadata.
- status String
- The optional status metadata.
- username String
- The optional username metadata.
- name string
- The server name.
- server
Id string - The stable Dokploy server ID.
- description string
- The optional description metadata.
- ip
Address string - The optional IP address metadata.
- organization
Id string - The optional organization ID metadata.
- port number
- The optional port metadata.
- server
Type string - The optional server type metadata.
- ssh
Key stringId - The optional SSH key ID metadata.
- status string
- The optional status metadata.
- username string
- The optional username metadata.
- name str
- The server name.
- server_
id str - The stable Dokploy server ID.
- description str
- The optional description metadata.
- ip_
address str - The optional IP address metadata.
- organization_
id str - The optional organization ID metadata.
- port int
- The optional port metadata.
- server_
type str - The optional server type metadata.
- ssh_
key_ strid - The optional SSH key ID metadata.
- status str
- The optional status metadata.
- username str
- The optional username metadata.
- name String
- The server name.
- server
Id String - The stable Dokploy server ID.
- description String
- The optional description metadata.
- ip
Address String - The optional IP address metadata.
- organization
Id String - The optional organization ID metadata.
- port Number
- The optional port metadata.
- server
Type String - The optional server type metadata.
- ssh
Key StringId - The optional SSH key ID metadata.
- status String
- The optional status metadata.
- username String
- The optional username metadata.
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