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

    Using getSSHKey

    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 getSSHKey(args: GetSSHKeyArgs, opts?: InvokeOptions): Promise<GetSSHKeyResult>
    function getSSHKeyOutput(args: GetSSHKeyOutputArgs, opts?: InvokeOutputOptions): Output<GetSSHKeyResult>
    def get_ssh_key(ssh_key_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetSSHKeyResult
    def get_ssh_key_output(ssh_key_id: pulumi.Input[Optional[str]] = None,
                    opts: Optional[InvokeOutputOptions] = None) -> Output[GetSSHKeyResult]
    func LookupSSHKey(ctx *Context, args *LookupSSHKeyArgs, opts ...InvokeOption) (*LookupSSHKeyResult, error)
    func LookupSSHKeyOutput(ctx *Context, args *LookupSSHKeyOutputArgs, opts ...InvokeOption) LookupSSHKeyResultOutput

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

    public static class GetSSHKey 
    {
        public static Task<GetSSHKeyResult> InvokeAsync(GetSSHKeyArgs args, InvokeOptions? opts = null)
        public static Output<GetSSHKeyResult> Invoke(GetSSHKeyInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetSSHKeyResult> Invoke(GetSSHKeyInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetSSHKeyResult> getSSHKey(GetSSHKeyArgs args, InvokeOptions options)
    public static Output<GetSSHKeyResult> getSSHKey(GetSSHKeyArgs args, InvokeOptions options)
    public static Output<GetSSHKeyResult> getSSHKey(GetSSHKeyArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: dokploy:getSSHKey
      arguments:
        # arguments dictionary
    data "dokploy_get_s_s_h_key" "name" {
        # arguments
    }

    The following arguments are supported:

    SshKeyId string
    The ID of the existing Dokploy SSH key to read.
    SshKeyId string
    The ID of the existing Dokploy SSH key to read.
    ssh_key_id string
    The ID of the existing Dokploy SSH key to read.
    sshKeyId String
    The ID of the existing Dokploy SSH key to read.
    sshKeyId string
    The ID of the existing Dokploy SSH key to read.
    ssh_key_id str
    The ID of the existing Dokploy SSH key to read.
    sshKeyId String
    The ID of the existing Dokploy SSH key to read.

    getSSHKey Result

    The following output properties are available:

    Name string
    The SSH key name.
    SshKeyId string
    The stable Dokploy SSH key ID.
    Description string
    The optional description metadata.
    OrganizationId string
    The optional organization ID metadata.
    PublicKey string
    The optional public key metadata.
    Name string
    The SSH key name.
    SshKeyId string
    The stable Dokploy SSH key ID.
    Description string
    The optional description metadata.
    OrganizationId string
    The optional organization ID metadata.
    PublicKey string
    The optional public key metadata.
    name string
    The SSH key name.
    ssh_key_id string
    The stable Dokploy SSH key ID.
    description string
    The optional description metadata.
    organization_id string
    The optional organization ID metadata.
    public_key string
    The optional public key metadata.
    name String
    The SSH key name.
    sshKeyId String
    The stable Dokploy SSH key ID.
    description String
    The optional description metadata.
    organizationId String
    The optional organization ID metadata.
    publicKey String
    The optional public key metadata.
    name string
    The SSH key name.
    sshKeyId string
    The stable Dokploy SSH key ID.
    description string
    The optional description metadata.
    organizationId string
    The optional organization ID metadata.
    publicKey string
    The optional public key metadata.
    name str
    The SSH key name.
    ssh_key_id str
    The stable Dokploy SSH key ID.
    description str
    The optional description metadata.
    organization_id str
    The optional organization ID metadata.
    public_key str
    The optional public key metadata.
    name String
    The SSH key name.
    sshKeyId String
    The stable Dokploy SSH key ID.
    description String
    The optional description metadata.
    organizationId String
    The optional organization ID metadata.
    publicKey String
    The optional public key 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