Appwrite

Appwrite MongoDB API

Managed MongoDB databases, with backup policies, archives and restorations. 31 operations across 21 paths in the Appwrite 2.0.0 OpenAPI.

GitHub OpenAPI

Operations 31

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 /mongo List dedicated Mongo databases · List databases #
Ask an LLM
“Which dedicated Mongo databases do I have in Appwrite?”
“Can I page through my dedicated Mongo databases?”
Tell an agent
List all my dedicated Mongo databases.
List dedicated Mongo databases matching {queries}.
POST /mongo Provision a dedicated Mongo database · Create database #
Ask an LLM
“How do I spin up a dedicated Mongo database?”
“Can I turn on point-in-time recovery and storage autoscaling when provisioning a Mongo database?”
Tell an agent
Create a dedicated Mongo database {name} with ID {databaseId}.
Provision Mongo database {databaseId} named {name} on version {version} with specification {specification}.
GET /mongo/specifications List dedicated Mongo compute specifications · List specifications #
Ask an LLM
“What Mongo database sizes can I choose on my current plan?”
“How much does each dedicated Mongo specification cost, including overage?”
Tell an agent
Show the dedicated Mongo specifications available on my plan.
List Mongo compute sizes with their resource limits and prices.
GET /mongo/{databaseId} Get a dedicated Mongo database · Get database #
Ask an LLM
“What is the configuration and status of my Mongo database?”
“Has my new Mongo database finished provisioning?”
Tell an agent
Get dedicated Mongo database {databaseId}.
Show the configuration of Mongo database {databaseId}.
PATCH /mongo/{databaseId} Update a dedicated Mongo database's configuration · Update database #
Ask an LLM
“Can I pause a Mongo database and resume it later?”
“How do I change the IP allowlist or replica count on a Mongo database without downtime?”
Tell an agent
Pause Mongo database {databaseId} by setting status to {status}.
Resize Mongo database {databaseId} to specification {specification}.
DELETE /mongo/{databaseId} Delete a dedicated Mongo database · Delete database #
Ask an LLM
“How do I permanently delete a dedicated Mongo database?”
“Can I re-run cleanup on a Mongo database stuck in deleting?”
Tell an agent destructive · confirm first
Delete dedicated Mongo database {databaseId}.
Tear down Mongo database {databaseId} and clean up its resources.
GET /mongo/{databaseId}/backups List backups of a Mongo database · List backups #
Ask an LLM
“Which backups exist for my Mongo database?”
“Can I filter a Mongo database's backups by status or type?”
Tell an agent
List backups for Mongo database {databaseId}.
List backups of {databaseId} matching {queries}.
POST /mongo/{databaseId}/backups Take a manual backup of a Mongo database · Create backup #
Ask an LLM
“How do I take an on-demand backup of my Mongo database right now?”
“Can I choose between a full and an incremental manual backup?”
Tell an agent
Back up Mongo database {databaseId} now.
Take a {type} backup of Mongo database {databaseId}.
GET /mongo/{databaseId}/backups/policies List scheduled backup policies · List backup policies #
Ask an LLM
“What scheduled backup policies are set on my Mongo database?”
“Are automatic backups configured for this Mongo database?”
Tell an agent
List backup schedules for Mongo database {databaseId}.
Show the backup policies on {databaseId} matching {queries}.
POST /mongo/{databaseId}/backups/policies Schedule recurring Mongo backups · Create backup policy #
Ask an LLM
“How do I schedule automatic backups for a Mongo database?”
“Can I set how long scheduled Mongo backups are retained?”
Tell an agent
Create backup policy {name} on Mongo database {databaseId} with schedule {schedule} and retention {retention}.
Add policy {policyId} to back up {databaseId} on {schedule}, keeping each for {retention}, named {name}.
GET /mongo/{databaseId}/backups/policies/{policyId} Get a scheduled backup policy · Get backup policy #
Ask an LLM
“What schedule and retention does a specific Mongo backup policy use?”
“Is a given Mongo backup policy currently enabled?”
Tell an agent
Get backup policy {policyId} on Mongo database {databaseId}.
Show the details of backup policy {policyId}.
PATCH /mongo/{databaseId}/backups/policies/{policyId} Change a scheduled backup policy · Update backup policy #
Ask an LLM
“Can I change the schedule of an existing Mongo backup policy?”
“Is it possible to temporarily disable a backup policy without deleting it?”
Tell an agent
Change backup policy {policyId} on {databaseId} to run on {schedule}.
Set enabled to {enabled} on backup policy {policyId} for {databaseId}.
DELETE /mongo/{databaseId}/backups/policies/{policyId} Delete a scheduled backup policy · Delete backup policy #
Ask an LLM
“How do I stop scheduled backups on a Mongo database?”
“Are backups already taken kept after I delete their policy?”
Tell an agent destructive · confirm first
Delete backup policy {policyId} from Mongo database {databaseId}.
Remove the backup schedule {policyId} on {databaseId}.
PUT /mongo/{databaseId}/backups/storage Configure off-cluster backup storage · Update backup storage #
Ask an LLM
“Can I send my Mongo backups to my own S3, GCS or Azure bucket?”
“Does the Mongo backup storage setting support S3-compatible endpoints like MinIO?”
Tell an agent
Store Mongo database {databaseId} backups in {provider} bucket {bucket} using key {accessKey} and secret {secretKey}.
Send {databaseId} backups to {provider} bucket {bucket} at endpoint {endpoint} with prefix {prefix}, key {accessKey}, secret {secretKey}.
GET /mongo/{databaseId}/backups/{backupId} Get a Mongo backup's details · Get backup #
Ask an LLM
“Has my Mongo backup finished and how big is it?”
“When was a specific Mongo backup taken?”
Tell an agent
Get backup {backupId} of Mongo database {databaseId}.
Check the status of backup {backupId}.
DELETE /mongo/{databaseId}/backups/{backupId} Delete a Mongo backup · Delete backup #
Ask an LLM
“How do I permanently remove an old Mongo backup?”
“Can a deleted Mongo backup be recovered?”
Tell an agent destructive · confirm first
Delete backup {backupId} of Mongo database {databaseId}.
Permanently remove backup {backupId} from storage for {databaseId}.
GET /mongo/{databaseId}/branches List ephemeral branches of a Mongo database · List branches #
Ask an LLM
“What test branches exist for my Mongo database?”
“When do my Mongo database branches expire?”
Tell an agent
List branches of Mongo database {databaseId}.
Show ephemeral branches and their expiry for {databaseId}.
POST /mongo/{databaseId}/branches Branch a Mongo database for testing · Create branch #
Ask an LLM
“Can I make a throwaway copy of my Mongo database to test a schema migration?”
“How long can an ephemeral Mongo branch live before it expires?”
Tell an agent
Create a branch of Mongo database {databaseId}.
Branch {databaseId} as {branchId} with a TTL of {ttl} seconds.
DELETE /mongo/{databaseId}/branches/{branchId} Delete an ephemeral Mongo branch · Delete branch #
Ask an LLM
“How do I delete a test branch of my Mongo database before it expires?”
“Is deleting a Mongo branch reversible?”
Tell an agent destructive · confirm first
Delete branch {branchId} of Mongo database {databaseId}.
Remove the ephemeral branch {branchId} now.
PATCH /mongo/{databaseId}/credentials Rotate a Mongo database's connection credentials · Update credentials #
Ask an LLM
“How do I rotate the primary connection password for my Mongo database?”
“Where do I get the new connection string after rotating Mongo credentials?”
Tell an agent
Rotate the connection credentials for Mongo database {databaseId}.
Queue a credential rotation on {databaseId}.
POST /mongo/{databaseId}/failovers Fail over a Mongo database to a replica · Create failover #
Ask an LLM
“How do I promote a replica to primary on my Mongo database?”
“Can I repair a stuck Mongo upgrade by failing over to a named replica?”
Tell an agent
Trigger a failover on Mongo database {databaseId}.
Fail over Mongo database {databaseId} to replica {targetReplicaId}.
PATCH /mongo/{databaseId}/maintenance Set a Mongo database's maintenance window · Update maintenance #
Ask an LLM
“When do minor version upgrades happen on my Mongo database?”
“Can I move the Mongo maintenance window to a quiet hour?”
Tell an agent
Set the maintenance window for Mongo database {databaseId} to {day} at {hourUtc} UTC.
Schedule maintenance on {databaseId} every {day} at hour {hourUtc}.
POST /mongo/{databaseId}/migrations Move a Mongo database between shared and dedicated · Create migration #
Ask an LLM
“Can I convert my Mongo database from shared serverless to dedicated always-on?”
“What happens when I move a dedicated Mongo database back to shared?”
Tell an agent
Migrate Mongo database {databaseId} to {targetType}.
Move {databaseId} to {targetType} on specification {specification}.
GET /mongo/{databaseId}/operations List lifecycle operations on a Mongo database · List operations #
Ask an LLM
“What provisioning, backup and replication actions have run on my Mongo database?”
“Has my Mongo credential rotation reached a final status yet?”
Tell an agent
List lifecycle operations for Mongo database {databaseId}.
Show the last {limit} Mongo operations on {databaseId} with status {status}.
GET /mongo/{databaseId}/pitr Get point-in-time recovery windows · Get PITR #
Ask an LLM
“How far back can I restore my Mongo database to a point in time?”
“What are the earliest and latest recovery points for this Mongo database?”
Tell an agent
Get the PITR recovery window for Mongo database {databaseId}.
Show the earliest and latest restore points for {databaseId}.
GET /mongo/{databaseId}/replicas Get Mongo replica and HA status · Get replicas #
Ask an LLM
“How much replication lag do my Mongo replicas have?”
“Are all replicas of my Mongo database healthy?”
Tell an agent
Get replica status for Mongo database {databaseId}.
Show Mongo replication lag and sync mode for {databaseId}.
GET /mongo/{databaseId}/restorations List restorations of a Mongo database · List restorations #
Ask an LLM
“What restores have been run on my Mongo database?”
“Can I filter Mongo restorations to only point-in-time ones?”
Tell an agent
List restorations for Mongo database {databaseId}.
List {type} restorations on {databaseId} with status {status}.
POST /mongo/{databaseId}/restorations Restore a Mongo database from backup or PITR · Create restoration #
Ask an LLM
“How do I restore my Mongo database from a backup?”
“Can I roll a Mongo database back to a specific moment in time?”
Tell an agent
Restore Mongo database {databaseId} from backup {backupId}.
Restore {databaseId} to {targetTime} using point-in-time recovery into {targetDatabaseId}.
GET /mongo/{databaseId}/restorations/{restorationId} Get a Mongo restoration's status · Get restoration #
Ask an LLM
“Has my Mongo restore finished?”
“What type and timestamps does a specific Mongo restoration have?”
Tell an agent
Get restoration {restorationId} for Mongo database {databaseId}.
Check progress of restore {restorationId}.
GET /mongo/{databaseId}/status Get health of a Mongo database · Get status #
Ask an LLM
“Is my Mongo database healthy and accepting connections?”
“Where can I see uptime and volume usage for a Mongo database?”
Tell an agent
Check the health of Mongo database {databaseId}.
Get real-time Mongo status and connection info for {databaseId}.
POST /mongo/{databaseId}/upgrades Upgrade a Mongo database's engine version · Create upgrade #
Ask an LLM
“How do I upgrade my Mongo database to a newer engine version?”
“Does a Mongo version upgrade cause downtime?”
Tell an agent
Upgrade Mongo database {databaseId} to version {targetVersion}.
Run a blue-green upgrade of {databaseId} to {targetVersion}.

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-mongo-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-mongo-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-mongo-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-mongo-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 2.0.0
  title: Appwrite Mongo 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 (109 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-mongo-api-openapi.yml