Skip to main content
Version: 1.0

Database backups

API V2

There is an API v2 version of this endpoint. Where possible we recommend basing any new integrations on our API v2 endpoints. You can find documentation for the API v2 Database Backup API by clicking this link.

Allows API users to trigger Mambu database backups and download them once they are ready.

Execution flow example:

  1. Use POST call to request the database backup to be generated and register/define the callback endpoint.
    • This call triggers the database copy creation, which is a prerequisite to download a backup.
    • The callback parameter is not required but recommended.
  2. If a callback parameter is defined, a callback will be sent to the endpoint, confirming that step 1 has been completed and that the database backup can be downloaded.
    • The response to this callback should be OK (200).
    • The endpoint is useful to ensure that the creation process has finished and step 3 can be performed.
  3. Use a GET call to request the download of the database backup.
    • If an endpoint is defined, it can be triggered immediately after the callback (step 2) is received.
    • If there is no endpoint defined, please wait several minutes, up to one hour (depending on the size of your database), to allow Mambu some time to finish the creation of the database from step 1.

Required permissions:

  • Download Backups for triggering and downloading a database backup

Contact

Mambu: