Appwrite Sites API
The Sites Service allows you view, create and manage your web applications. 27 operations across 18 paths in the Appwrite 2.0.0 OpenAPI.
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.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/appwrite-sites-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.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.0.0
info:
title: Appwrite Sites 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](https://appwrite.io/docs)
version: 2.0.0
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:
- name: sites
description: The Sites Service allows you view, create and manage your web applications.
paths:
/sites:
get:
summary: List sites
operationId: sitesList
tags:
- sites
description: Get a list of all the project's sites. You can use the query params to filter your results.
responses:
'200':
description: Sites List
content:
application/json:
schema:
$ref: '#/components/schemas/siteList'
deprecated: false
x-appwrite:
group: sites
demo: sites/list.md
rate-limit: 0
rate-time: 3600
rate-key: url:{url},ip:{ip}
scope: sites.read
platforms:
- console
- server
packaging: false
public: true
auth:
console:
Project: []
server:
Project: []
Key: []
security:
- Project: []
Key: []
parameters:
- name: queries
description: 'Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId'
required: false
schema:
type: array
items:
type: string
default: []
in: query
- name: search
description: 'Search term to filter your list results. Max length: 256 chars.'
required: false
schema:
type: string
example: <SEARCH>
default: ''
in: query
- name: total
description: When set to false, the total count returned will be 0 and will not be calculated.
required: false
schema:
type: boolean
example: false
default: true
in: query
post:
summary: Create site
operationId: sitesCreate
tags:
- sites
description: Create a new site.
responses:
'201':
description: Site
content:
application/json:
schema:
$ref: '#/components/schemas/site'
deprecated: false
x-appwrite:
group: sites
demo: sites/create.md
rate-limit: 0
rate-time: 3600
rate-key: url:{url},ip:{ip}
scope: sites.write
platforms:
- console
- server
packaging: false
public: true
auth:
console:
Project: []
server:
Project: []
Key: []
security:
- Project: []
Key: []
requestBody:
content:
application/json:
schema:
type: object
properties:
siteId:
description: Site ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.
type: string
example: <SITE_ID>
x-appwrite:
idGenerator: ID.unique
name:
description: 'Site name. Max length: 128 chars.'
type: string
example: <NAME>
framework:
description: Sites framework.
type: string
example: analog
title: Framework
oneOf:
- type: string
enum:
- analog
title: analog
- type: string
enum:
- angular
title: angular
- type: string
enum:
- nextjs
title: nextjs
- type: string
enum:
- react
title: react
- type: string
enum:
- nuxt
title: nuxt
- type: string
enum:
- vue
title: vue
- type: string
enum:
- sveltekit
title: sveltekit
- type: string
enum:
- astro
title: astro
- type: string
enum:
- tanstack-start
title: tanstack-start
- type: string
enum:
- remix
title: remix
- type: string
enum:
- lynx
title: lynx
- type: string
enum:
- flutter
title: flutter
- type: string
enum:
- react-native
title: react-native
- type: string
enum:
- vite
title: vite
- type: string
enum:
- other
title: other
enabled:
description: Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.
type: boolean
default: true
example: false
logging:
description: When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.
type: boolean
default: true
example: false
timeout:
description: Maximum request time in seconds.
type: integer
default: 30
example: 1
format: int32
installCommand:
description: Install Command.
type: string
default: ''
example: <INSTALL_COMMAND>
buildCommand:
description: Build Command.
type: string
default: ''
example: <BUILD_COMMAND>
startCommand:
description: Custom start command. Leave empty to use default.
type: string
default: ''
example: <START_COMMAND>
outputDirectory:
description: Output Directory for site.
type: string
default: ''
example: <OUTPUT_DIRECTORY>
buildRuntime:
description: Runtime to use during build step.
type: string
example: node-14.5
title: BuildRuntime
oneOf:
- type: string
enum:
- node-14.5
title: node-14.5
- type: string
enum:
- node-16.0
title: node-16.0
- type: string
enum:
- node-18.0
title: node-18.0
- type: string
enum:
- node-19.0
title: node-19.0
- type: string
enum:
- node-20.0
title: node-20.0
- type: string
enum:
- node-21.0
title: node-21.0
- type: string
enum:
- node-22
title: node-22
- type: string
enum:
- node-23
title: node-23
- type: string
enum:
- node-24
title: node-24
- type: string
enum:
- node-25
title: node-25
- type: string
enum:
- node-26
title: node-26
- type: string
enum:
- php-8.0
title: php-8.0
- type: string
enum:
- php-8.1
title: php-8.1
- type: string
enum:
- php-8.2
title: php-8.2
- type: string
enum:
- php-8.3
title: php-8.3
- type: string
enum:
- php-8.4
title: php-8.4
- type: string
enum:
- ruby-3.0
title: ruby-3.0
- type: string
enum:
- ruby-3.1
title: ruby-3.1
- type: string
enum:
- ruby-3.2
title: ruby-3.2
- type: string
enum:
- ruby-3.3
title: ruby-3.3
- type: string
enum:
- ruby-3.4
title: ruby-3.4
- type: string
enum:
- ruby-4.0
title: ruby-4.0
- type: string
enum:
- python-3.8
title: python-3.8
- type: string
enum:
- python-3.9
title: python-3.9
- type: string
enum:
- python-3.10
title: python-3.10
- type: string
enum:
- python-3.11
title: python-3.11
- type: string
enum:
- python-3.12
title: python-3.12
- type: string
enum:
- python-3.13
title: python-3.13
- type: string
enum:
- python-3.14
title: python-3.14
- type: string
enum:
- python-ml-3.11
title: python-ml-3.11
- type: string
enum:
- python-ml-3.12
title: python-ml-3.12
- type: string
enum:
- python-ml-3.13
title: python-ml-3.13
- type: string
enum:
- deno-1.21
title: deno-1.21
- type: string
enum:
- deno-1.24
title: deno-1.24
- type: string
enum:
- deno-1.35
title: deno-1.35
- type: string
enum:
- deno-1.40
title: deno-1.40
- type: string
enum:
- deno-1.46
title: deno-1.46
- type: string
enum:
- deno-2.0
title: deno-2.0
- type: string
enum:
- deno-2.5
title: deno-2.5
- type: string
enum:
- deno-2.6
title: deno-2.6
- type: string
enum:
- dart-2.15
title: dart-2.15
- type: string
enum:
- dart-2.16
title: dart-2.16
- type: string
enum:
- dart-2.17
title: dart-2.17
- type: string
enum:
- dart-2.18
title: dart-2.18
- type: string
enum:
- dart-2.19
title: dart-2.19
- type: string
enum:
- dart-3.0
title: dart-3.0
- type: string
enum:
- dart-3.1
title: dart-3.1
- type: string
enum:
- dart-3.3
title: dart-3.3
- type: string
enum:
- dart-3.5
title: dart-3.5
- type: string
enum:
- dart-3.8
title: dart-3.8
- type: string
enum:
- dart-3.9
title: dart-3.9
- type: string
enum:
- dart-3.10
title: dart-3.10
- type: string
enum:
- dart-3.11
title: dart-3.11
- type: string
enum:
- dart-3.12
title: dart-3.12
- type: string
enum:
- dart-3.13
title: dart-3.13
- type: string
enum:
- dotnet-6.0
title: dotnet-6.0
- type: string
enum:
- dotnet-7.0
title: dotnet-7.0
- type: string
enum:
- dotnet-8.0
title: dotnet-8.0
- type: string
enum:
- dotnet-10
title: dotnet-10
- type: string
enum:
- java-8.0
title: java-8.0
- type: string
enum:
- java-11.0
title: java-11.0
- type: string
enum:
- java-17.0
title: java-17.0
- type: string
enum:
- java-18.0
title: java-18.0
- type: string
enum:
- java-21.0
title: java-21.0
- type: string
enum:
- java-22
title: java-22
- type: string
enum:
- java-25
title: java-25
- type: string
enum:
- swift-5.5
title: swift-5.5
- type: string
enum:
- swift-5.8
title: swift-5.8
- type: string
enum:
- swift-5.9
title: swift-5.9
- type: string
enum:
- swift-5.10
title: swift-5.10
- type: string
enum:
- swift-6.2
title: swift-6.2
- type: string
enum:
- kotlin-1.6
title: kotlin-1.6
- type: string
enum:
- kotlin-1.8
title: kotlin-1.8
- type: string
enum:
- kotlin-1.9
title: kotlin-1.9
- type: string
enum:
- kotlin-2.0
title: kotlin-2.0
- type: string
enum:
- kotlin-2.3
title: kotlin-2.3
- type: string
enum:
- cpp-17
title: cpp-17
- type: string
enum:
- cpp-20
title: cpp-20
- type: string
enum:
- bun-1.0
title: bun-1.0
- type: string
enum:
- bun-1.1
title: bun-1.1
- type: string
enum:
- bun-1.2
title: bun-1.2
- type: string
enum:
- bun-1.3
title: bun-1.3
- type: string
enum:
- bun-1.4
title: bun-1.4
- type: string
enum:
- go-1.23
title: go-1.23
- type: string
enum:
- go-1.24
title: go-1.24
- type: string
enum:
- go-1.25
title: go-1.25
- type: string
enum:
- go-1.26
title: go-1.26
- type: string
enum:
- rust-1.83
title: rust-1.83
- type: string
enum:
- static-1
title: static-1
- type: string
enum:
- flutter-3.24
title: flutter-3.24
- type: string
enum:
- flutter-3.27
title: flutter-3.27
- type: string
enum:
- flutter-3.29
title: flutter-3.29
- type: string
enum:
- flutter-3.32
title: flutter-3.32
- type: string
enum:
- flutter-3.35
title: flutter-3.35
- type: string
enum:
- flutter-3.38
title: flutter-3.38
- type: string
enum:
- flutter-3.41
title: flutter-3.41
- type: string
enum:
- flutter-3.44
title: flutter-3.44
- type: string
enum:
- flutter-3.47
title: flutter-3.47
adapter:
description: 'Framework adapter defining rendering strategy. Allowed values are: static, ssr'
type: string
example: static
title: Adapter
oneOf:
- type: string
enum:
- static
title: static
- type: string
enum:
- ssr
title: ssr
installationId:
description: Appwrite Installation ID for VCS (Version Control System) deployment.
type: string
default: ''
example: <INSTALLATION_ID>
fallbackFile:
description: Fallback file for single page application sites.
type: string
default: ''
example: <FALLBACK_FILE>
providerRepositoryId:
description: Repository ID of the repo linked to the site.
type: string
default: ''
example: <PROVIDER_REPOSITORY_ID>
providerBranch:
description: Production branch for the repo linked to the site.
type: string
default: ''
example: <PROVIDER_BRANCH>
providerSilentMode:
description: Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.
type: boolean
default: false
example: false
providerRootDirectory:
description: Path to site code in the linked repo.
type: string
default: ''
example: <PROVIDER_ROOT_DIRECTORY>
providerBranches:
description: List of branch name patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all branches.
type: array
default: []
items:
type: string
providerPaths:
description: List of file path patterns to trigger automatic deployments. Supports wildcards. Leave empty to deploy on all file changes.
type: array
default: []
items:
type: string
buildSpecification:
description: Build specification for the site deployments.
type: string
default: {}
example: s-1vcpu-512mb
runtimeSpecification:
description: Runtime specification for the SSR executions.
type: string
default: {}
example: s-1vcpu-512mb
deploymentRetention:
description: Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.
type: integer
default: 0
example: 0
format: int32
scopes:
description: List of scopes allowed for API key auto-generated for every site build and SSR execution. Maximum of 200 scopes are allowed.
type: array
default: []
items:
title: ProjectKeyScopes
type: string
oneOf:
- type: string
enum:
- project.read
title: project.read
- type: string
enum:
- project.write
title: project.write
- type: string
enum:
- usage.read
title: usage.read
- type: string
enum:
- keys.read
title: keys.read
- type: string
enum:
- keys.write
title: keys.write
- type: string
enum:
- platforms.read
title: platforms.read
- type: string
enum:
- platforms.write
title: platforms.write
- type: string
enum:
- mocks.read
title: mocks.read
- type: string
enum:
- mocks.write
title: mocks.write
- type: string
enum:
- policies.read
title: policies.read
- type: string
enum:
- policies.write
title: policies.write
- type: string
enum:
- project.policies.read
title: project.policies.read
- type: string
enum:
- project.policies.write
title: project.policies.write
- type: string
enum:
- project.oauth2.read
title: project.oauth2.read
- type: string
enum:
- project.oauth2.write
title: project.oauth2.write
- type: string
enum:
- templates.read
title: templates.read
- type: string
enum:
- templates.write
title: templates.write
- type: string
enum:
- stages.read
title: stages.read
- type: string
enum:
- stages.write
title: stages.write
- type: string
enum:
- users.read
title: users.read
- type: string
enum:
- users.write
title: users.write
- type: string
enum:
- sessions.read
title: sessions.read
- type: string
enum:
- sessions.write
title: sessions.write
- type: string
enum:
- teams.read
title: teams.read
- type: string
enum:
- teams.write
title: teams.write
- type: string
enum:
- databases.read
title: databases.read
- type: string
enum:
- databases.write
title: databases.write
- type: string
enum:
- tables.read
title: tables.read
- type: string
enum:
- tables.write
title: tables.write
- type: string
enum:
- columns.read
title: columns.read
- type: string
enum:
- columns.write
title: columns.write
- type: string
enum:
- indexes.read
title: indexes.read
- type: string
enum:
- indexes.write
title: indexes.write
- type: string
enum:
- rows.read
title: rows.read
- type: string
enum:
- rows.write
title: rows.write
- type: string
enum:
- embeddings.write
title: embeddings.write
- type: string
enum:
- collections.read
title: collections.read
- type: string
enum:
- collections.write
title: collections.write
- type: string
enum:
- attributes.read
title: attributes.read
- type: string
enum:
- attributes.write
title: attributes.write
- type: string
enum:
- documents.read
title: documents.read
- type: string
enum:
- documents.write
title: documents.write
- type: string
enum:
- documentsdb.read
title: documentsdb.read
- type: string
enum:
- documentsdb.write
title: documentsdb.write
- type: string
enum:
- documentsdb.collections.read
title: documentsdb.collections.read
- type: string
enum:
- documentsdb.collections.write
title: documentsdb.collections.write
- type: string
enum:
- documentsdb.documents.read
title: documentsdb.documents.read
- type: string
enum:
- documentsdb.documents.write
title: documentsdb.documents.write
- type: string
enum:
- documentsdb.indexes.read
title: documentsdb.indexes.read
- type: string
enum:
- documentsdb.indexes.write
title: documentsdb.indexes.write
- type: string
enum:
- vectorsdb.read
title: vectorsdb.read
- type: string
enum:
- vectorsdb.write
title: vectorsdb.write
- type: string
enum:
- vectorsdb.collections.read
title: vectorsdb.collections.read
- type: string
enum:
- vectorsdb.collections.write
title: vectorsdb.collections.write
- type: string
enum:
- vectorsdb.documents.read
title: vectorsdb.documents.read
- type: string
# --- truncated at 32 KB (156 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/appwrite/refs/heads/main/openapi/appwrite-sites-api-openapi.yml