Skip to main content
POST
Configure ADR Export Settings

Authorizations

token
string
query
required

Vida API Token

Body

application/json
deliveryProtocol
string
required

SFTP, FTPS, or FTP

Example:

"sftp"

rotationMinutes
string
default:60
required

How many minutes of records should be contained in each file

Example:

"somekey"

host
string
required

hostname or IP address where to ship the ADR files to

Example:

"sftp.domain.com"

port
integer
required

Port for the SFTP or FTP service

Example:

2202

username
string
required

username for the sftp or ftp account

Example:

"someuser"

password
string
required

password for the sftp or ftp account

Example:

"somepassword"

path
string

Folder path to deposit the files to. Defaults to the users home directory

Example:

"/path/"

Response

Successful response

success
boolean
Example:

true

message
string
Example:

"Success"