Create backups
Creates one manual backup for each website you list in sites, over each website’s configured areas unless included names them. Exclusions always come from the website’s backup settings.
Each created backup starts in phase in_progress and takes minutes: follow it with “List backups” (filter[id][]) or “Retrieve a backup” and read phase; only done is a usable copy. The work finishes later: see Writes and asynchronous operations. Websites that cannot be processed are reported in meta.skipped, each with a reason_code and a message, and do not fail the call. Their backup_id is always null. A website is skipped as SITE_UNREACHABLE (not connected), UNSUPPORTED (no backup global configuration), CONFLICT (a backup or a restoration is already running) or PERMISSION_DENIED (a website your token cannot reach, with a null site_name).
Your organization’s plan must include manual backups and your role must be allowed to create them; without either the request answers 404.
Body
sites(array of integers, required): ids of the websites to act on, 1 to 50.included(array of strings, optional): areas to copy instead of the configured ones:database,core,plugins,themes,mu_plugins,content,uploads.
Errors
- 409: the organization’s storage quota is exhausted and no overage add-on is active. Nothing is created.
- 422:
sitesis missing, empty, has more than 50 ids or contains an id that is not a website; anincludedvalue is invalid.
Authentication
Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.
Request
Response
202 Accepted - one copy created, one website skipped
