Appwrite

Appwrite Console API

The Console service allows you to interact with console relevant information. 19 operations across 19 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

GET /console/campaigns/{campaignId} Get a marketing campaign's details · Get campaign details #
Ask an LLM
“What does a particular console campaign offer?”
“Can I look up a campaign by its ID?”
Tell an agent
Show the details of campaign {campaignId}.
Get campaign {campaignId}.
GET /console/coupons/{couponId} Look up a coupon code in the console · Get coupon details #
Ask an LLM
“Is a coupon code valid, and what credit does it give?”
“Can the console look up any coupon by its code?”
Tell an agent
Look up console coupon {couponId}.
Check the console details of coupon code {couponId}.
GET /console/databases List every database in the project · List databases #
Ask an LLM
“Can I see all my project's databases across every type in one call?”
“Can I search the project's databases by name?”
Tell an agent
List every database in my project across all types.
Search my project's databases for {search}.
GET /console/oauth2-providers List supported OAuth2 login providers · List OAuth2 providers #
Ask an LLM
“Which OAuth2 providers can I enable for sign-in?”
“What settings does each OAuth2 provider need to be configured?”
Tell an agent
List the OAuth2 providers the server supports.
Show the configuration parameters required for each OAuth2 provider.
GET /console/plans List available billing plans · Get plans #
Ask an LLM
“What billing plans are available?”
“Can I list plans for a specific platform only?”
Tell an agent
List all available billing plans.
List plans for platform {platform}.
GET /console/plans/{planId} Get one billing plan's details · Get plan #
Ask an LLM
“What limits and pricing come with a specific plan?”
“Can I fetch a single plan by its ID?”
Tell an agent
Show the details of plan {planId}.
Get pricing and limits for plan {planId}.
GET /console/postgres-extensions List installable Postgres extensions · List Postgres extensions #
Ask an LLM
“Which Postgres extensions can I install on a dedicated database?”
“Is pgvector in the catalog of available Postgres extensions?”
Tell an agent
List the Postgres extensions available for dedicated databases.
Show the catalog of installable Postgres extensions.
GET /console/programs/{programId} Get a program's details · Get program details #
Ask an LLM
“What does a console program such as a startup program include?”
“Can I look up a program by its ID?”
Tell an agent
Show the details of program {programId}.
Get program {programId}.
POST /console/programs/{programId}/memberships Join a program · Create program membership #
Ask an LLM
“How do I enroll my account in a program?”
“Can I sign up for a console program from the API?”
Tell an agent
Enroll my account in program {programId}.
Create a membership for me in program {programId}.
GET /console/regions List regions available in the console · List Regions #
Ask an LLM
“Which regions can I create a project in?”
“What cloud regions does the console offer?”
Tell an agent
List the regions available in the console.
Show me where I can host a new project.
GET /console/resources Check if a resource ID is available · Check resource ID availability #
Ask an LLM
“Is a project or resource ID I want still free to use?”
“Can I check whether a custom ID is already taken before creating something?”
Tell an agent
Check whether {type} ID {value} is available.
See if {value} is free as a {type} identifier.
GET /console/scopes/organization List scopes for organization API keys · List organization scopes #
Ask an LLM
“Which permission scopes can an organization API key have?”
“What does each organization key scope allow?”
Tell an agent
List all scopes available for organization API keys.
Describe each organization key scope.
GET /console/scopes/project List scopes for project API keys · List project scopes #
Ask an LLM
“Which permission scopes can a project API key be given?”
“What does each project key scope grant access to?”
Tell an agent
List all scopes available for project API keys.
Describe each project API key scope.
POST /console/sources Record where a sign-up came from · Create source #
Ask an LLM
“How do I record the UTM source and campaign for a new console sign-up?”
“Can I track the referrer that brought a user to the console?”
Tell an agent
Record a source with UTM source {utmSource}, campaign {utmCampaign} and medium {utmMedium}.
Create a source for referrer {referrer} with ref code {ref}.
GET /console/suggestions/columns Suggest columns for a table · Get column suggestions with size limits for a table, using database context and… #
Ask an LLM
“Can Appwrite suggest column names and sizes for a new table?”
“Can I give extra context to get better column suggestions?”
Tell an agent
Suggest columns for table {tableId} in database {databaseId}.
Suggest columns for {tableId} in {databaseId} given the context {context}.
GET /console/suggestions/indexes Suggest indexes for a table · Get index suggestions for table columns, using database context #
Ask an LLM
“Which indexes would speed up queries on my table?”
“Can I get index recommendations based on my table's columns?”
Tell an agent
Suggest indexes for table {tableId} in database {databaseId}.
Recommend between {min} and {max} indexes for {tableId} in {databaseId}.
GET /console/suggestions/queries Turn plain text into Appwrite list queries · Get query suggestions for a list resource from free-text intent #
Ask an LLM
“Can I describe a filter in plain English and get valid query JSON back?”
“Which list resources support query suggestions from free text?”
Tell an agent
Suggest queries for {resource} from the request {input}.
Turn {input} into query JSON for rows in table {tableId} of database {databaseId}, resource {resource}.
GET /console/templates/email/{templateId} Get a built-in default email template · Get email template #
Ask an LLM
“What does the default verification or recovery email template look like?”
“Can I get the built-in email template in another locale?”
Tell an agent
Show the default {templateId} email template.
Get the built-in {templateId} email template in locale {locale}.
GET /console/variables Get the console's environment variables · Get variables #
Ask an LLM
“Which environment variables does the console rely on?”
“Can I read the console-relevant configuration of this server?”
Tell an agent
Show the environment variables relevant to the console.
Get the console configuration variables.

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