Appwrite

Appwrite Backups API

The Backups service allows you to manage backup policies, archives, and restorations for your project. 12 operations across 7 paths in the Appwrite 2.0.0 OpenAPI.

GitHub OpenAPI

Operations 12

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /backups/archives List the project's backup archives · List archives #
Ask an LLM
“Which backup archives exist for my project?”
“Can I filter the list of backup archives with queries?”
Tell an agent
List all backup archives in this project.
List backup archives matching {queries}.
POST /backups/archives Take an on-demand backup archive · Create archive #
Ask an LLM
“How do I take a one-off backup of my project right now?”
“Can I archive just one database instead of every service?”
Tell an agent
Create a backup archive of {services} now.
Archive {services} for resource {resourceId} immediately.
GET /backups/archives/{archiveId} Get a backup archive's details · Get backup archive #
Ask an LLM
“What's the status and size of one specific backup archive?”
“Is a particular archive finished and ready to restore from?”
Tell an agent
Show backup archive {archiveId}.
Check whether archive {archiveId} has completed.
DELETE /backups/archives/{archiveId} Delete a backup archive · Delete archive #
Ask an LLM
“Can I remove an old backup archive to free up space?”
“What's the way to get rid of one backup archive permanently?”
Tell an agent destructive · confirm first
Delete backup archive {archiveId}.
Permanently remove archive {archiveId} from this project.
GET /backups/policies List scheduled backup policies · List backup policies #
Ask an LLM
“Which scheduled backup policies are set up on my project?”
“Can I search my backup policies with a query filter?”
Tell an agent
List every backup policy in this project.
List backup policies matching {queries}.
POST /backups/policies Schedule automatic backups with a retention · Create backup policy #
Ask an LLM
“How do I schedule automatic daily backups of my databases?”
“How long can I keep backups, and can I set a retention period on a schedule?”
Tell an agent
Create backup policy {policyId} for {services} on schedule {schedule}, keeping them {retention} days.
Set up a backup policy named {name} that backs up resource {resourceId} on {schedule} with {retention} days retention, id {policyId}, services {services}.
GET /backups/policies/{policyId} Get a backup policy's configuration · Get backup policy #
Ask an LLM
“What schedule and retention does one of my backup policies use?”
“Is a specific backup policy currently enabled?”
Tell an agent
Show backup policy {policyId}.
Tell me the schedule and retention of policy {policyId}.
PATCH /backups/policies/{policyId} Change a backup policy's schedule or retention · Update backup policy #
Ask an LLM
“Can I change how often an existing backup policy runs?”
“Is it possible to pause an existing backup policy without deleting it?”
Tell an agent
Change backup policy {policyId} to run on {schedule}.
Set retention on existing policy {policyId} to {retention} days.
DELETE /backups/policies/{policyId} Delete a backup policy · Delete backup policy #
Ask an LLM
“How do I stop and remove a scheduled backup policy entirely?”
“Can I delete a backup policy I no longer want?”
Tell an agent destructive · confirm first
Delete backup policy {policyId}.
Remove the scheduled backups defined by policy {policyId}.
POST /backups/restoration Restore a backup archive · Create restoration #
Ask an LLM
“How do I restore my database from a backup archive?”
“Can I restore a backup as a new database instead of overwriting the original?”
Tell an agent
Restore {services} from archive {archiveId} in place.
Restore archive {archiveId} ({services}) as a new database {newResourceId} named {newResourceName}.
GET /backups/restorations List backup restorations · List restorations #
Ask an LLM
“Which restorations have been run on my project?”
“Can I filter past backup restorations with queries?”
Tell an agent
List all backup restorations for this project.
List restorations matching {queries}.
GET /backups/restorations/{restorationId} Check a restoration's status · Get backup restoration #
Ask an LLM
“Has my backup restore finished yet?”
“What's the current status of one specific restoration?”
Tell an agent
Check the status of restoration {restorationId}.
Show restoration {restorationId}.

Documentation

📖
Documentation
https://appwrite.io/docs
📖
APIReference
https://appwrite.io/docs/references

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-backups-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/appwrite/appwrite

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/overlays/appwrite-backups-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/appwrite:appwrite-backups-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

appwrite-backups-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.0.0
  title: Appwrite Backups API
  description: Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to https://appwrite.io/docs
  termsOfService: https://appwrite.io/policy/terms
  contact:
    name: Appwrite Team
    url: https://appwrite.io/support
    email: team@appwrite.io
  license:
    name: BSD-3-Clause
    url: https://raw.githubusercontent.com/appwrite/appwrite/master/LICENSE
servers:
- url: https://cloud.appwrite.io/v1
  description: Appwrite Cloud endpoint.
- url: https://{region}.cloud.appwrite.io/v1
  description: Appwrite Cloud regional endpoint. Replace `{region}` with your project region.
  variables:
    region:
      default: fra
      description: Appwrite Cloud region.
tags:


# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-backups-api-openapi.yml