1. Registry
  2. Packages
  3. Files.com
  4. API Docs
  5. getSftpHostKey
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady
filescom logo
Viewing docs for Files.com v0.1.1
published on Thursday, Aug 20, 2026 by jschady

    An SFTP Host Key is a cryptographic key used to verify the identity of the server during an SFTP connection. This allows the client to be sure that it is connecting to the intended server, preventing man-in-the-middle attacks and ensuring secure communication between the client and Files.com.

    Files.com allows you to provide custom SFTP Host Keys, which is particularly useful when migrating to Files.com from an existing SFTP server, allowing the Files.com platform to match your previously-installed host key for a seamless transition.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as filescom from "pulumi-filescom";
    
    const exampleSftpHostKey = filescom.getSftpHostKey({
        id: 1,
    });
    
    import pulumi
    import pulumi_filescom as filescom
    
    example_sftp_host_key = filescom.get_sftp_host_key(id=1)
    
    package main
    
    import (
    	"github.com/jschady/pulumi-filescom/sdk/go/filescom"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := filescom.GetSftpHostKey(ctx, &filescom.LookupSftpHostKeyArgs{
    			Id: 1,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Filescom = Jschady.Filescom;
    
    return await Deployment.RunAsync(() => 
    {
        var exampleSftpHostKey = Filescom.GetSftpHostKey.Invoke(new()
        {
            Id = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.filescom.FilescomFunctions;
    import com.pulumi.filescom.inputs.GetSftpHostKeyArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var exampleSftpHostKey = FilescomFunctions.getSftpHostKey(GetSftpHostKeyArgs.builder()
                .id(1)
                .build());
    
        }
    }
    
    variables:
      exampleSftpHostKey:
        fn::invoke:
          function: filescom:getSftpHostKey
          arguments:
            id: 1
    
    pulumi {
      required_providers {
        filescom = {
          source = "pulumi/filescom"
        }
      }
    }
    
    data "filescom_getsftphostkey" "exampleSftpHostKey" {
      id = 1
    }
    

    Using getSftpHostKey

    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 getSftpHostKey(args: GetSftpHostKeyArgs, opts?: InvokeOptions): Promise<GetSftpHostKeyResult>
    function getSftpHostKeyOutput(args: GetSftpHostKeyOutputArgs, opts?: InvokeOutputOptions): Output<GetSftpHostKeyResult>
    def get_sftp_host_key(id: Optional[int] = None,
                          opts: Optional[InvokeOptions] = None) -> GetSftpHostKeyResult
    def get_sftp_host_key_output(id: pulumi.Input[Optional[int]] = None,
                          opts: Optional[InvokeOutputOptions] = None) -> Output[GetSftpHostKeyResult]
    func LookupSftpHostKey(ctx *Context, args *LookupSftpHostKeyArgs, opts ...InvokeOption) (*LookupSftpHostKeyResult, error)
    func LookupSftpHostKeyOutput(ctx *Context, args *LookupSftpHostKeyOutputArgs, opts ...InvokeOption) LookupSftpHostKeyResultOutput

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

    public static class GetSftpHostKey 
    {
        public static Task<GetSftpHostKeyResult> InvokeAsync(GetSftpHostKeyArgs args, InvokeOptions? opts = null)
        public static Output<GetSftpHostKeyResult> Invoke(GetSftpHostKeyInvokeArgs args, InvokeOptions? opts = null)
        public static Output<GetSftpHostKeyResult> Invoke(GetSftpHostKeyInvokeArgs args, InvokeOutputOptions opts)
    }
    public static CompletableFuture<GetSftpHostKeyResult> getSftpHostKey(GetSftpHostKeyArgs args, InvokeOptions options)
    public static Output<GetSftpHostKeyResult> getSftpHostKey(GetSftpHostKeyArgs args, InvokeOptions options)
    public static Output<GetSftpHostKeyResult> getSftpHostKey(GetSftpHostKeyArgs args, InvokeOutputOptions options)
    
    fn::invoke:
      function: filescom:index/getSftpHostKey:getSftpHostKey
      arguments:
        # arguments dictionary
    data "filescom_get_sftp_host_key" "name" {
        # arguments
    }

    The following arguments are supported:

    Id int
    SFTP Host Key ID
    Id int
    SFTP Host Key ID
    id number
    SFTP Host Key ID
    id Integer
    SFTP Host Key ID
    id number
    SFTP Host Key ID
    id int
    SFTP Host Key ID
    id Number
    SFTP Host Key ID

    getSftpHostKey Result

    The following output properties are available:

    FingerprintMd5 string
    MD5 Fingerprint of the public key
    FingerprintSha256 string
    SHA256 Fingerprint of the public key
    Id int
    SFTP Host Key ID
    Name string
    The friendly name of this SFTP Host Key.
    FingerprintMd5 string
    MD5 Fingerprint of the public key
    FingerprintSha256 string
    SHA256 Fingerprint of the public key
    Id int
    SFTP Host Key ID
    Name string
    The friendly name of this SFTP Host Key.
    fingerprint_md5 string
    MD5 Fingerprint of the public key
    fingerprint_sha256 string
    SHA256 Fingerprint of the public key
    id number
    SFTP Host Key ID
    name string
    The friendly name of this SFTP Host Key.
    fingerprintMd5 String
    MD5 Fingerprint of the public key
    fingerprintSha256 String
    SHA256 Fingerprint of the public key
    id Integer
    SFTP Host Key ID
    name String
    The friendly name of this SFTP Host Key.
    fingerprintMd5 string
    MD5 Fingerprint of the public key
    fingerprintSha256 string
    SHA256 Fingerprint of the public key
    id number
    SFTP Host Key ID
    name string
    The friendly name of this SFTP Host Key.
    fingerprint_md5 str
    MD5 Fingerprint of the public key
    fingerprint_sha256 str
    SHA256 Fingerprint of the public key
    id int
    SFTP Host Key ID
    name str
    The friendly name of this SFTP Host Key.
    fingerprintMd5 String
    MD5 Fingerprint of the public key
    fingerprintSha256 String
    SHA256 Fingerprint of the public key
    id Number
    SFTP Host Key ID
    name String
    The friendly name of this SFTP Host Key.

    Package Details

    Repository
    filescom jschady/pulumi-filescom
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the filescom Terraform Provider.
    filescom logo
    Viewing docs for Files.com v0.1.1
    published on Thursday, Aug 20, 2026 by jschady

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial