1. Home
  2. Docs
  3. Developer Documentation
  4. File Interface

File Interface

The XcooBee file interface allows any system that can communicate via the SFTP protocol to write and read files and to participate in the XcooBee privacy processes. Though this is a lower level interface it is still very extensive. It is designed to handle high volume batch processes.


In computing, the SSH File Transfer Protocol (also Secure File Transfer Protocol, or SFTP) is a network protocol that provides file access, file transfer, and file management over any reliable data stream. It was designed by the Internet Engineering Task Force (IETF) as an extension of the Secure Shell protocol (SSH) version 2.0 to provide secure file transfer capabilities. The IETF Internet Draft states that, even though this protocol is described in the context of the SSH-2 protocol, it could be used in a number of different applications, such as secure file transfer over Transport Layer Security (TLS) and transfer of management information in VPN applications.

This protocol assumes that it is run over a secure channel, such as SSH, that the server has already authenticated the client, and that the identity of the client user is available to the protocol.

SFTP Endpoint and Port

The SFTP endpoint is the URL to the SFTP service. Each XcooBee instance has an SFTP endpoint in each Region. When you signup for your developer account you should receive your designated endpoint. Please also note that XcooBee does not use the standard port. You have to ensure that your network allows communication over the XcooBee SFTP port. An example would be (non functional):


Access Key and Secret

After you signup to your XcooBee developer account, you will be able to generate a developer access key and access secret in your settings area of the UI. Please note that the access secret needs to be saved by you. You will not be able to retrieve it afterwards.

Your access key and secret are your username and password for SFTP access.



Was this article helpful to you? Yes No

How can we help?