Appwrite

Appwrite Manager API

Console management surface for project-level WAF rules and operator tooling. 19 operations across 18 paths in the Appwrite 2.0.0 OpenAPI.

GitHub OpenAPI

Operations 19

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

POST /manager/blocks Block a resource type for a project · Create a new resource block for a project #
Ask an LLM
“How do I block a project from using a certain resource type?”
“Can a resource block be set to expire automatically?”
Tell an agent
Block {resourceType} for project {projectId}.
Block {resourceType} {resourceId} in project {projectId} until {expiredAt} because {reason}.
DELETE /manager/blocks Lift resource blocks on a project · Delete resource blocks for a project #
Ask an LLM
“Can I remove a block I placed on a project's resources?”
“What's the way to unblock a single resource rather than a whole resource type?”
Tell an agent destructive · confirm first
Remove the {resourceType} blocks on project {projectId}.
Unblock {resourceType} {resourceId} in project {projectId}.
GET /manager/blocks/{projectId} List resource blocks on a project · List all resource blocks for a project #
Ask an LLM
“Which resources are currently blocked for a given project?”
“Is anything blocked on this project right now?”
Tell an agent
List all resource blocks on project {projectId}.
Show what is blocked for project {projectId}.
DELETE /manager/cache Clear the internal cache · Clear internal cache #
Ask an LLM
“How do I flush the internal cache for one project?”
“Can I clear the cached copy of a single document instead of everything?”
Tell an agent destructive · confirm first
Clear the {cache} cache for project {projectId}.
Clear the cached document {documentId} in collection {collectionId} of project {projectId}.
PATCH /manager/database/{databaseId} Report a database container's status · Update database status (used by Edge) #
Ask an LLM
“How does Edge tell Cloud that a database container spun down?”
“Can I update the container status of a database after spindown?”
Tell an agent
Set the container status of database {databaseId} to {containerStatus}.
Mark database {databaseId} in project {projectId} as {containerStatus}.
POST /manager/databases/activity Sync database last-active timestamps in bulk · Sync database last-active timestamps in bulk #
Ask an LLM
“How are last-active times for many databases synced in one call?”
“Will an older activity timestamp overwrite a newer last-accessed time?”
Tell an agent
Sync these database activity entries: {databases}.
Push the last-active timestamps {databases} from the edge cache.
POST /manager/databases/metrics Submit dedicated database metrics in bulk · Submit database metrics in bulk #
Ask an LLM
“How do I report CPU, memory and storage readings for dedicated databases?”
“Can I send queries-per-second and IOPS samples for several databases at once?”
Tell an agent
Submit metrics for databases {databaseIds} in projects {projectIds} with CPU {cpuPercents} and memory {memoryPercents}.
Record storage used {storageUsedBytes} and active connections {connectionsActive} for databases {databaseIds} in projects {projectIds}.
POST /manager/databases/{databaseId}/event Send a database lifecycle event · Create a database lifecycle event #
Ask an LLM
“How does Edge notify Cloud that a database failover or provisioning finished?”
“Can a lifecycle event be used to start or spin down a database?”
Tell an agent
Send a {event} lifecycle event for database {databaseId}.
Emit event {event} on database {databaseId} with data {data}.
GET /manager/domain Look up DNS details for a domain · Find the DNS details for given domain #
Ask an LLM
“What DNS details does the manager hold for a domain?”
“Can I check the DNS setup of a custom domain?”
Tell an agent
Get the DNS details for {domain}.
Look up domain {domain} in the manager.
GET /manager/domains/records List the DNS records for a domain · Find the DNS details for given domain #
Ask an LLM
“Which DNS records are configured for my domain?”
“Can I see the individual A, CNAME and TXT records on a domain?”
Tell an agent
List the DNS records of {domain}.
Show every DNS record set on {domain}.
GET /manager/domains/{domain}/zone Download a domain's DNS zone file · Retrieve the DNS zone file for the given domain #
Ask an LLM
“How do I export the DNS zone file for a domain?”
“Can I get the full zone file for one of my domains?”
Tell an agent
Get the zone file for {domain}.
Export the DNS zone of {domain}.
POST /manager/events Publish a CloudEvents manager event · Create a new event for the manager using CloudEvents specification #
Ask an LLM
“How do I send a manager event in CloudEvents format?”
“Which fields does a CloudEvents manager event require?”
Tell an agent
Publish a {type} event about {subject} with data {data}.
Create a CloudEvent of type {type} from {source} for subject {subject} carrying {data}.
GET /manager/projects/{projectId}/databases/{databaseId} Get database routing info for the edge proxy · Get database routing info #
Ask an LLM
“What hostname and port does the edge proxy use to reach a database?”
“Which engine and backend type does a given database run on?”
Tell an agent
Get routing info for database {databaseId} in project {projectId}.
Show the host, port and status of database {databaseId} in project {projectId}.
POST /manager/projects/{projectId}/keys Validate a project API key secret · Get project key authorization data #
Ask an LLM
“How does the edge check whether an API key secret is valid for a project?”
“Can I find out which scopes a project API key grants?”
Tell an agent
Validate API key {apiKey} for project {projectId}.
Return the scopes of key {apiKey} on project {projectId}.
POST /manager/projects/{projectId}/user Resolve a user JWT to a project user · Resolve a user JWT to a project user #
Ask an LLM
“How can the edge router tell which user a JWT belongs to?”
“Does this user token actually belong to the given project?”
Tell an agent
Resolve JWT {jwt} to a user in project {projectId}.
Confirm the user behind token {jwt} is a member of project {projectId}.
GET /manager/projects/{projectId}/waf-rules List a project's enabled WAF rules · List enabled WAF rules for a project #
Ask an LLM
“Which web application firewall rules are active on a project?”
“How many WAF rules does this project have enabled?”
Tell an agent
List the enabled WAF rules for project {projectId}.
Count the active firewall rules on project {projectId}.
GET /manager/rule Find the deployment rule for a domain · Find the deployment rule for a given domain #
Ask an LLM
“Which deployment does a given domain route to?”
“What deployment rule is attached to my custom domain?”
Tell an agent
Find the deployment rule for {domain}.
Show where {domain} is routed.
PATCH /manager/users/status Change a console user's status · Update a user status by ID or email #
Ask an LLM
“How do I suspend or reactivate a console user by email?”
“Can I record a reason when changing a console user's status?”
Tell an agent
Set console user {email} to status {status}.
Change user {userId} status to {status} because {reason}.
POST /manager/verify-s3-signature Verify an S3 SigV4 signature · Verify an AWS SigV4 signature against a project's API keys #
Ask an LLM
“How do I check an AWS SigV4 signature against a project's API keys?”
“What comes back when an S3-style signature doesn't match any key?”
Tell an agent
Verify SigV4 {signature} for {accessKey}, {region}/{service}, {dateStamp} {amzDate}, hash {canonicalRequestHash}.
Check whether SigV4 signature {signature} from project {accessKey} is valid.

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