Views:
Create a backup of the SMS database.

Definition

smsAdmin/backup

Parameters

Parameter Type Description
type string Destination type.
  • smb
  • nfs
  • scp
  • sftp
  • sms (Stored locally on the SMS. Only one backup allowed at a time.)
location string Destination path for backup file. Does not apply for type/sms.
username string Type-specific username. Required for type/smb, scp, or sftp.
password string Type-specific password. Required for type/smb, scp, or sftp .
domain string
Type-specific domain; only used for destination type smb
tos integer Number of most recent TOS packages to include. Default is 0.
dv integer Number of most recent DV packages to include. Default is 1.
events boolean Whether to include events data.
  • true
  • false (default)
sslPrivateKeys boolean Whether to include SSL private key.
  • true
  • false (default)
notify boolean Whether to send email notifications when a backup has completed or failed.
  • true (default)
  • false
timestamp boolean Whether to include the timestamp.
  • true (default)
  • false
encryptionPass string Encrypt backup using supplied password. Default is null, do not encrypt.

Example

curl -k --header "X-SMS-API-KEY: <string>""https://<sms_server>/smsAdmin/backup?
type=<smb>&location=<//198.51.100.100/backups/sms.bak>&username=<smb_user>&
password=<smb_pwd>&domain=<dom00>&tos=<1>&dv=<1>&events=<false>&notify=<false>&
timestampName=<true>"