Sign in
backups

add new backup for the central server

Changed on
<h3>Generates a new central server backup.</h3> <p> This endpoint can also return metadata in the error response. The metadata array contains the output of a failed backup generation script. </p>
post/backups

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
  • Auth: API key in header Authorization

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