Sign in
backups

upload new backup for the central server

Changed on
<h3>Uploads new central server backup to the system.</h3> <p> Note that it is possible to overwrite an existing backup file with the same name. <ul> <li>Attempt to upload a new backup file having the same name with an existing backup and with query parameter <code>ignore_warnings</code> = false causes the operation to fail with a warning in response's ErrorInfo object. </li> <li>Attempt to upload a new backup file having the same name with an existing backup and with query parameter <code>ignore_warnings</code> = true will overwrite the existing backup. </li> </ul> </p> <p>The warning response has a warning code <code>warning_file_already_exists</code> and the metadata field contains the name of the existing backup </p>
post/backups/upload

Request

  • Base URL: /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/backups/upload
  • Auth: API key in header Authorization

Query parameters

ignore_warningsboolean

If true, any ignorable warnings are ignored. if false (or missing), any warnings cause request to fail.

Response

item created

filenamestring filename required

backup filename

compatibleboolean required

whether this backup is compatible with this server's backup format

Example response

{
  "filename": "configuration_backup_20181224.tar"
}

Changes