Step 1: "Apply for an API key

Applying for a free Evaluation Key for the Sync API is easy. Simply fill out this form and we will get back to you as quickly as possible. This Evaluation Key can be used to test the Sync API. If you are ready to purchase a Licensed Key for for the Sync API, click here.

Step 2: Set up your environment

To enable the API, you must run Resilio Sync with a special config file. The config file enables you to run Sync silently, and improves integration with your app.

On Mac and Linux, run the Sync executable with --config argument.

On Windows, use /config .

Sync uses JSON format for the configuration file. The config file must have "api_key" value set to your API key to enable using API.

Here is a sample config file that you can use to enable API:

{
    // path to folder where Sync will store its internal data,
    // folder must exist on disk
    "storage_path" : "/Users/user/.SyncAPI",
    // run Sync in GUIĀ­less mode
    "use_gui" : false,
    "webui" : {
        // IP address and port to access HTTP API
        "listen" : "127.0.0.1:8888",
        // login and password for HTTP basic authentication
        // authentication is optional, but it's recommended to use
        // some secret values unique for each Sync installation
        "login" : "api",
        "password" : "secret",
        // replace xxx with API key received from Resilio
        "api_key" : "xxx"
    }
}
              

You should create your own login and password for security reasons to replace the default settings above.

You should place a valid api_key instead of "xxx".

The config file may be located in any directory on your drive.

Looking for instructions on how to silently install Resilio Sync? Click here.

Step 3: Check out the documentation and examples

See our documentation for detailed information on how to use the Sync API.

Check out these GitHub pages for examples: Resilio Sync API v2 tutorial & Sync sample integration with Slack.

Step 4: Join the conversation

Jump over to the Sync API forums to ask questions, give feedback and share your work.