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

    The following arguments are supported:

    ServerId string
    The ID of the existing Dokploy server to read.
    ServerId string
    The ID of the existing Dokploy server to read.
    server_id string
    The ID of the existing Dokploy server to read.
    serverId String
    The ID of the existing Dokploy server to read.
    serverId string
    The ID of the existing Dokploy server to read.
    server_id str
    The ID of the existing Dokploy server to read.
    serverId String
    The ID of the existing Dokploy server to read.

    getServer Result

    The following output properties are available:

    Name string
    The server name.
    ServerId string
    The stable Dokploy server ID.
    Description string
    The optional description metadata.
    IpAddress string
    The optional IP address metadata.
    OrganizationId string
    The optional organization ID metadata.
    Port int
    The optional port metadata.
    ServerType string
    The optional server type metadata.
    SshKeyId string
    The optional SSH key ID metadata.
    Status string
    The optional status metadata.
    Username string
    The optional username metadata.
    Name string
    The server name.
    ServerId string
    The stable Dokploy server ID.
    Description string
    The optional description metadata.
    IpAddress string
    The optional IP address metadata.
    OrganizationId string
    The optional organization ID metadata.
    Port int
    The optional port metadata.
    ServerType string
    The optional server type metadata.
    SshKeyId string
    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_id string
    The optional SSH key ID metadata.
    status string
    The optional status metadata.
    username string
    The optional username metadata.
    name String
    The server name.
    serverId String
    The stable Dokploy server ID.
    description String
    The optional description metadata.
    ipAddress String
    The optional IP address metadata.
    organizationId String
    The optional organization ID metadata.
    port Integer
    The optional port metadata.
    serverType String
    The optional server type metadata.
    sshKeyId String
    The optional SSH key ID metadata.
    status String
    The optional status metadata.
    username String
    The optional username metadata.
    name string
    The server name.
    serverId string
    The stable Dokploy server ID.
    description string
    The optional description metadata.
    ipAddress string
    The optional IP address metadata.
    organizationId string
    The optional organization ID metadata.
    port number
    The optional port metadata.
    serverType string
    The optional server type metadata.
    sshKeyId string
    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_id str
    The optional SSH key ID metadata.
    status str
    The optional status metadata.
    username str
    The optional username metadata.
    name String
    The server name.
    serverId String
    The stable Dokploy server ID.
    description String
    The optional description metadata.
    ipAddress String
    The optional IP address metadata.
    organizationId String
    The optional organization ID metadata.
    port Number
    The optional port metadata.
    serverType String
    The optional server type metadata.
    sshKeyId String
    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
    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