external_sources

Home >> External sources

External sources

Many settings like imports or targets like list, each or switch support loading their data from external sources.

{
    "deploy.reloaded": {
        "targets": [
            {
                "name": "My SFTP switch",
                "type": "switch",

                "options": "sftp://myUser:myPassword@example.com:666/myProject/list-settings.json",
            },

            {
                "name": "sftp1",
                "type": "sftp",
                
                // ...
            },
            {
                "name": "sftp2",
                "type": "sftp",
                
                // ...
            }
        ]
    }
}

The example downloads the data for options property of My SFTP switch target from the SFTP server example.com:666 and requests the file /myProject/list-settings.json by using myUser and myPassword as credentials.

Supported protocols

DropBox

dropbox:///myProjectsSubFolder/test.json?accessToken=<YOUR-ACCESS-TOKEN>

Parameters

The client supports the following query parameters (s. DropBox target):

Name	Type
accessToken	string

FTP

ftp://myUser:myPassword@example.com/subFolder/test.json?engine=jsftp

Parameters

The client supports the following query parameters (s. FTP target):

Name	Type
engine	string

Local files

E:/myProject/file.json

SFTP

sftp://myUser:myPassword@example.com/subFolder/test.json?readyTimeout=10000&tryKeyboard=true

Parameters

The client supports the following query parameters (s. SFTP target):

Name	Type
agent	string
agentForward	bool
debug	bool
hashAlgorithm	string
hashes	string list
privateKey	string
privateKeyPassphrase	string
readyTimeout	integer
tryKeyboard	bool

Slack

slack://<CHANNEL-ID>/test.json?token=<YOUR-ACCESS-TOKEN>

Parameters

The client supports the following query parameters (s. Slack target):

Name	Type
token	string

Data types

Bool

Possible values for (true) are:

• 1
• true
• y
• yes

Values, that are empty or containing whitespaces only, will be unset.

All other values will be converted to (false).

String list

A comma separated list of values.

1,4,2,3, for example, will be converted to [ "1", "4", "2", "3" ].