A backup set is not one file. It is a group of archives — one for the database, usually several for files — that only mean anything together.
updraftplus/get-backup opens one set up: what it contains, which archive files it is made of, how big they are, and where they sit.
At a glance
| Ability | updraftplus/get-backup |
| Toolset | UpdraftPlus — toolset/updraftplus |
| Group | UpdraftPlus › Backup sets |
| Requires | UpdraftPlus, active on the site |
| Capability | manage_options |
| Safety | Read-only — changes nothing |
| Repeatable | Idempotent — running it twice leaves the same result |
| Ships in | AcrossAI Abilities Manager 0.0.34 and later |
How it works
This is the call to make immediately before a restore. A set missing an archive it should have is a set that will restore incompletely, and finding that out beforehand is very much cheaper than finding out afterwards.
Component names map to what would be replaced on restore — db, plugins, themes, uploads, others. The restore ability can be pointed at a subset of them.
The id must be exactly the one updraftplus/list-backups returned. It is opaque and plugin-owned; do not construct or normalise it.
Input
| Name | Type | Required | What it is |
|---|---|---|---|
id | string | Yes | Backup identifier, exactly as returned by updraftplus/list-backups. |
What comes back
| Name | Type | What it is |
|---|---|---|
backup | object | The set in full: timestamp, components, archive files, sizes and location. |
success | boolean | Whether the call completed. |
message | string | A one-line summary of what happened, suitable for showing a human. |
error_code | string | Present only on failure — a stable machine-readable reason, such as a missing field, a wrong field type or an unmet confirmation. |
Example
Ask your assistant:
What exactly is in the backup from Monday night?
It resolves to one call:
{
"ability": "updraftplus/get-backup",
"parameters": {
"id": "1758672000"
}
}Worth knowing
- Read this before restoring. An incomplete set restores incompletely.
- Size is worth a glance — a database archive far smaller than usual is a sign the backup ran against an empty or partial database.
- Remote copies are not described here. This reads what is on this server.
Related abilities
- List Backups — find the id first
- Restore Backup — what this set can be used for
- Delete Backup — remove it and free the space
Get the plugins:
AcrossAI Abilities Manager · AcrossAI MCP Manager
Browse the rest: Every ability, by category