Skip to content

Save SFTP/FTP external storage configuration

Request

Security
bearerAuth and apiKeyAuth
Bodyapplication/jsonrequired
namestringrequired

Configuration name

hoststringrequired

Host name or IP

portinteger, (int32)required

Port number

userstringrequired

User name

passwordstring

Password for authentication

privateKeystring

Private key for key-based SFTP authentication

publicKeystring

Public key

pathPrefixstring

Remote path prefix

protocolstring
additionalobject

Additional protocol-specific configuration

curl -i -X POST \
  https://developer.sprinklr.com/_mock/apis/sprinklr-v3/externalStorage/sftp \
  -H 'Authorization: Bearer <YOUR_Token_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Key: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "host": "string",
    "port": 0,
    "user": "string",
    "password": "string",
    "privateKey": "string",
    "publicKey": "string",
    "pathPrefix": "string",
    "protocol": "string",
    "additional": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Success

Bodyapplication/json
idstring

External source id

namestring

Configuration name

hoststring

Host name or IP

portinteger, (int32)

Port number

userstring

User name

passwordstring
privateKeystring
publicKeystring

Public key

pathPrefixstring

Remote path prefix

protocolstring
additionalobject

Additional protocol-specific configuration

ownerUserIdinteger, (int64)

Owner user id from the linked external source

Response
{ "id": "string", "name": "string", "host": "string", "port": 0, "user": "string", "password": "string", "privateKey": "string", "publicKey": "string", "pathPrefix": "string", "protocol": "string", "additional": { "property1": "string", "property2": "string" }, "ownerUserId": 0 }