v1

latestOpenAPI 3.0.3AGPL-3.0-only2026-07-17120116247.0 KB
maintenance

Dump data

Backups data as data provider independent JSON. The backup can be saved in a local file on the server, to avoid exposing sensitive data over the network, or returned as response body. The output of dumpdata can be used as input for loaddata

get/dumpdata

Query parameters

output-filestring

Path for the file to write the JSON serialized data to. This path is relative to the configured "backups_path". If this file already exists it will be overwritten. To return the backup as response body set output_data to true instead.

output-data0 | 1

output data:

  • 0 or any other value != 1, the backup will be saved to a file on the server, output_file is required
  • 1 the backup will be returned as response body
indent0 | 1

indent:

  • 0 no indentation. This is the default
  • 1 format the output JSON
scopesDumpDataScopes[]

You can limit the dump contents to the specified scopes. Empty or missing means any supported scope. Scopes must be specified comma separated

Response

successful operation

OR