Skip to main content
POST
/
api
/
v2
/
billing
/
adrExportConfig
Configure ADR Export Settings
curl --request POST \
  --url 'https://api.vida.dev/api/v2/billing/adrExportConfig?token=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "deliveryProtocol": "sftp",
  "rotationMinutes": "somekey",
  "host": "sftp.domain.com",
  "port": 2202,
  "username": "someuser",
  "password": "somepassword",
  "path": "/path/"
}
'
{
  "success": true,
  "message": "Success"
}

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"