Appwrite

Appwrite Projects API

The Project service allows you to manage all the projects in your Appwrite server. 18 operations across 14 paths in the Appwrite 2.0.0 OpenAPI.

GitHub OpenAPI

Operations 18

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 /projects/{projectId}/addons List a project's billing addons · List project addons #
Ask an LLM
“Which paid addons are active on my Appwrite project?”
“Where can I see every billing addon attached to one project?”
Tell an agent
List the billing addons on project {projectId}.
Show me which addons project {projectId} is paying for.
POST /projects/{projectId}/addons/premium-geo-db Add the Premium Geo DB addon to a project · Create Premium Geo DB addon for project #
Ask an LLM
“How do I turn on the Premium Geo DB addon for a project?”
“Can I buy premium geolocation data as an addon for just one project?”
Tell an agent
Add the Premium Geo DB addon to project {projectId}.
Subscribe project {projectId} to premium geo database lookups.
GET /projects/{projectId}/addons/{addonId} Get one project addon · Get project addon #
Ask an LLM
“What are the details of a specific billing addon on my project?”
“Can I check the status of one addon by its ID?”
Tell an agent
Show addon {addonId} on project {projectId}.
Get the billing details of addon {addonId} for project {projectId}.
DELETE /projects/{projectId}/addons/{addonId} Remove a billing addon from a project · Delete project addon #
Ask an LLM
“How do I cancel a paid addon on one of my projects?”
“Can I drop an addon I no longer need from a project?”
Tell an agent destructive · confirm first
Delete addon {addonId} from project {projectId}.
Cancel the billing addon {addonId} on project {projectId}.
POST /projects/{projectId}/addons/{addonId}/confirmations Confirm an addon payment after 3DS · Confirm project addon payment after 3DS authentication #
Ask an LLM
“My addon purchase asked for 3D Secure, how do I finish the payment?”
“What call completes an addon payment once card authentication succeeds?”
Tell an agent
Confirm the payment for addon {addonId} on project {projectId} after 3DS authentication.
Finalize the 3D Secure payment for project {projectId} addon {addonId}.
GET /projects/{projectId}/addons/{addon}/price Check what an addon will cost a project · Get project addon price #
Ask an LLM
“How much will an addon cost if I add it partway through my billing cycle?”
“Can I see the prorated price of an addon before buying it?”
Tell an agent
Get the price of the {addon} addon for project {projectId}.
Show the prorated amount for adding {addon} to project {projectId} this cycle.
PATCH /projects/{projectId}/console-access Record console access to a project · Record console access to a project #
Ask an LLM
“How does the console track when a project was last opened?”
“Can I update a project's last-accessed timestamp?”
Tell an agent
Record console access to project {projectId}.
Bump the last accessed time on project {projectId}.
GET /projects/{projectId}/dev-keys List a project's dev keys · List dev keys #
Ask an LLM
“Which dev keys exist for my project?”
“Can I filter a project's dev keys with queries?”
Tell an agent
List the dev keys for project {projectId}.
List dev keys on project {projectId} matching {queries}.
GET /projects/{projectId}/dev-keys/{keyId} Get one dev key · Get dev key #
Ask an LLM
“When does a particular dev key expire?”
“How do I look up a single dev key by its ID?”
Tell an agent
Show dev key {keyId} on project {projectId}.
Get the name and expiry of dev key {keyId} in project {projectId}.
PUT /projects/{projectId}/dev-keys/{keyId} Rename a dev key or change its expiry · Update dev key #
Ask an LLM
“Can I extend the expiration of an existing dev key?”
“How do I rename a dev key without creating a new one?”
Tell an agent
Rename dev key {keyId} in project {projectId} to {name} and set it to expire at {expire}.
Update dev key {keyId} on project {projectId}: name {name}, expiry {expire}.
DELETE /projects/{projectId}/dev-keys/{keyId} Delete a dev key · Delete dev key #
Ask an LLM
“How do I revoke a dev key so it stops bypassing rate limits?”
“What happens to debugging and rate limits once a dev key is deleted?”
Tell an agent destructive · confirm first
Delete dev key {keyId} from project {projectId}.
Revoke the dev key {keyId} on project {projectId}.
GET /projects/{projectId}/schedules List a project's schedules · List schedules #
Ask an LLM
“What scheduled jobs are set up in my project?”
“Can I filter a project's resource schedules with queries?”
Tell an agent
List all schedules in project {projectId}.
List schedules on project {projectId} matching {queries}.
POST /projects/{projectId}/schedules Schedule a resource to run on a cron · Create schedule #
Ask an LLM
“How do I put a function or other resource on a recurring schedule?”
“Can I create a schedule that starts out inactive?”
Tell an agent
Create a schedule in project {projectId} for {resourceType} {resourceId} running on {schedule}.
Schedule {resourceType} {resourceId} in project {projectId} with cron {schedule}, active: {active}.
GET /projects/{projectId}/schedules/{scheduleId} Get one schedule · Get schedule #
Ask an LLM
“What cron expression and resource does a given schedule use?”
“Is a specific schedule still active?”
Tell an agent
Show schedule {scheduleId} in project {projectId}.
Get the cron and target of schedule {scheduleId} on project {projectId}.
GET /projects/{projectId}/stages List a project's onboarding stages · List stages #
Ask an LLM
“Which onboarding steps have I finished or skipped for my project?”
“Can I see the SDK method tied to each onboarding stage?”
Tell an agent
List the onboarding stages for project {projectId}.
Show which onboarding stages are still pending on project {projectId}.
PATCH /projects/{projectId}/stages/{stageId} Skip an onboarding stage · Update stage #
Ask an LLM
“Can I skip an onboarding step without doing the API action it asks for?”
“How do I mark a project onboarding stage as skipped?”
Tell an agent
Skip onboarding stage {stageId} on project {projectId}.
Set skip to {skip} for stage {stageId} in project {projectId}.
PATCH /projects/{projectId}/status Archive, restore or unpause a project · Update the status of a project #
Ask an LLM
“How do I archive a project I'm not using anymore?”
“Can I bring a paused project back online?”
Tell an agent
Set the status of project {projectId} to {status}.
Archive project {projectId} by changing its status to {status}.
PATCH /projects/{projectId}/team Transfer a project to another team · Update project team #
Ask an LLM
“Can I move a project to a different team?”
“What call hands ownership of a project over to another team?”
Tell an agent
Transfer project {projectId} to team {teamId}.
Change the owning team of project {projectId} to {teamId}.

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