config_backup

config_backup

This call can be used to retrieve a full backup of the current system configuration, in the same format as would be written to the config file if the server were to do so right now.

config_backup and config_restore are guaranteed to be executed first, before any other API call is evaluated. If both config_backup and config_restore are called simultaneously, the backup is executed before the restore. This is to allow for atomically backing up the existing config while overriding it with a complete new config.

It is sent as follows:

{
  "config_backup": true //value ignored
}

The response looks like:

{
  "config_backup": {
    //Object containing the exact same JSON as the config file would contain when written
  }
}