Db Backup

1 minute read.

Namespace	Name	Admin Only	Log Summary	Generates Event	Version Added
cluster	db_backup	No	Yes	No	1.1

This API call will return a list of all the NAS database backups that are stored on TrueCommand.

WARNING:

This can only be performed for systems that the user has write access to. All other systems will be ignored.
NAS backup functionality requires a valid, non-expired license from iXsystems. This API will return a FORBIDDEN error otherwise.

Required:
- “tvid” (string or JSON array of strings) : Fetch the current configuration of these systems and save them for later.
Optional:
- none ({})

ARGUMENTS ONLY: See the basics of API requests for additional formatting information.

{
  "tvid" : "1da1363e-98ac-481c-a47d-54b87bfecbcd"
}

{
  "started_backup" : ["1da1363e-98ac-481c-a47d-54b87bfecbcd"]
}

{
  "started_backup" : ["1da1363e-98ac-481c-a47d-54b87bfecbcd"]
}

This API call does not emit any middleware events.