Elgato_dark/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite synced 2026-04-21 13:37:16 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
appwrite/app/config/specs/open-api3-latest-console.json

64707 lines
No EOL
2.7 MiB
Raw Blame History

{
"openapi": "3.0.0",
"info": {
"version": "1.8.1",
"title": "Appwrite",
"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)",
"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"
},
{
"url": "https:\/\/<REGION>.cloud.appwrite.io\/v1"
}
],
"paths": {
"\/account": {
"get": {
"summary": "Get account",
"operationId": "accountGet",
"tags": [
"account"
],
"description": "Get the currently logged in user.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": "account",
"weight": 9,
"cookies": false,
"type": "",
"demo": "account\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
},
"post": {
"summary": "Create account",
"operationId": "accountCreate",
"tags": [
"account"
],
"description": "Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [\/account\/verfication](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createEmailSession).",
"responses": {
"201": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "create",
"group": "account",
"weight": 8,
"cookies": false,
"type": "",
"demo": "account\/create.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"password": {
"type": "string",
"description": "New user password. Must be between 8 and 256 chars.",
"x-example": null
},
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"userId",
"email",
"password"
]
}
}
}
}
},
"delete": {
"summary": "Delete account",
"operationId": "accountDelete",
"tags": [
"account"
],
"description": "Delete the currently logged in user.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "account",
"weight": 10,
"cookies": false,
"type": "",
"demo": "account\/delete.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
]
}
},
"\/account\/email": {
"patch": {
"summary": "Update email",
"operationId": "accountUpdateEmail",
"tags": [
"account"
],
"description": "Update currently logged in user account email address. After changing user address, the user confirmation status will get reset. A new confirmation email is not sent automatically however you can use the send confirmation email endpoint again to send the confirmation email. For security measures, user password is required to complete this request.\nThis endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.\n",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateEmail",
"group": "account",
"weight": 34,
"cookies": false,
"type": "",
"demo": "account\/update-email.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"password": {
"type": "string",
"description": "User password. Must be at least 8 chars.",
"x-example": "password",
"format": "password"
}
},
"required": [
"email",
"password"
]
}
}
}
}
}
},
"\/account\/identities": {
"get": {
"summary": "List identities",
"operationId": "accountListIdentities",
"tags": [
"account"
],
"description": "Get the list of identities for the currently logged in user.",
"responses": {
"200": {
"description": "Identities List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/identityList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listIdentities",
"group": "identities",
"weight": 47,
"cookies": false,
"type": "",
"demo": "account\/list-identities.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/account\/identities\/{identityId}": {
"delete": {
"summary": "Delete identity",
"operationId": "accountDeleteIdentity",
"tags": [
"account"
],
"description": "Delete an identity by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteIdentity",
"group": "identities",
"weight": 48,
"cookies": false,
"type": "",
"demo": "account\/delete-identity.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "identityId",
"description": "Identity ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<IDENTITY_ID>"
},
"in": "path"
}
]
}
},
"\/account\/jwts": {
"post": {
"summary": "Create JWT",
"operationId": "accountCreateJWT",
"tags": [
"account"
],
"description": "Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate on behalf of the current user when working with the Appwrite server-side API and SDKs. The JWT secret is valid for 15 minutes from its creation and will be invalid if the user will logout in that time frame.",
"responses": {
"201": {
"description": "JWT",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/jwt"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createJWT",
"group": "tokens",
"weight": 29,
"cookies": false,
"type": "",
"demo": "account\/create-jwt.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "url:{url},userId:{userId}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.",
"x-example": 0,
"format": "int32"
}
}
}
}
}
}
}
},
"\/account\/logs": {
"get": {
"summary": "List logs",
"operationId": "accountListLogs",
"tags": [
"account"
],
"description": "Get the list of latest security activity logs for the currently logged in user. Each log returns user IP address, location and date and time of log.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
"weight": 31,
"cookies": false,
"type": "",
"demo": "account\/list-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/account\/mfa": {
"patch": {
"summary": "Update MFA",
"operationId": "accountUpdateMFA",
"tags": [
"account"
],
"description": "Enable or disable MFA on an account.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateMFA",
"group": "mfa",
"weight": 239,
"cookies": false,
"type": "",
"demo": "account\/update-mfa.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"mfa": {
"type": "boolean",
"description": "Enable or disable MFA.",
"x-example": false
}
},
"required": [
"mfa"
]
}
}
}
}
}
},
"\/account\/mfa\/authenticators\/{type}": {
"post": {
"summary": "Create authenticator",
"operationId": "accountCreateMfaAuthenticator",
"tags": [
"account"
],
"description": "Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.",
"responses": {
"200": {
"description": "MFAType",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/mfaType"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createMfaAuthenticator",
"group": "mfa",
"weight": 241,
"cookies": false,
"type": "",
"demo": "account\/create-mfa-authenticator.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.createMFAAuthenticator"
},
"methods": [
{
"name": "createMfaAuthenticator",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"type"
],
"required": [
"type"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaType"
}
],
"description": "Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.",
"demo": "account\/create-mfa-authenticator.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.createMFAAuthenticator"
}
},
{
"name": "createMFAAuthenticator",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"type"
],
"required": [
"type"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaType"
}
],
"description": "Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.",
"demo": "account\/create-mfa-authenticator.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "type",
"description": "Type of authenticator. Must be `totp`",
"required": true,
"schema": {
"type": "string",
"x-example": "totp",
"enum": [
"totp"
],
"x-enum-name": "AuthenticatorType",
"x-enum-keys": []
},
"in": "path"
}
]
},
"put": {
"summary": "Update authenticator (confirmation)",
"operationId": "accountUpdateMfaAuthenticator",
"tags": [
"account"
],
"description": "Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateMfaAuthenticator",
"group": "mfa",
"weight": 242,
"cookies": false,
"type": "",
"demo": "account\/update-mfa-authenticator.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.updateMFAAuthenticator"
},
"methods": [
{
"name": "updateMfaAuthenticator",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"type",
"otp"
],
"required": [
"type",
"otp"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/user"
}
],
"description": "Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.",
"demo": "account\/update-mfa-authenticator.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.updateMFAAuthenticator"
}
},
{
"name": "updateMFAAuthenticator",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"type",
"otp"
],
"required": [
"type",
"otp"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/user"
}
],
"description": "Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.",
"demo": "account\/update-mfa-authenticator.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "type",
"description": "Type of authenticator.",
"required": true,
"schema": {
"type": "string",
"x-example": "totp",
"enum": [
"totp"
],
"x-enum-name": "AuthenticatorType",
"x-enum-keys": []
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"otp": {
"type": "string",
"description": "Valid verification token.",
"x-example": "<OTP>"
}
},
"required": [
"otp"
]
}
}
}
}
},
"delete": {
"summary": "Delete authenticator",
"operationId": "accountDeleteMfaAuthenticator",
"tags": [
"account"
],
"description": "Delete an authenticator for a user by ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": true,
"x-appwrite": {
"method": "deleteMfaAuthenticator",
"group": "mfa",
"weight": 243,
"cookies": false,
"type": "",
"demo": "account\/delete-mfa-authenticator.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.deleteMFAAuthenticator"
},
"methods": [
{
"name": "deleteMfaAuthenticator",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"type"
],
"required": [
"type"
],
"responses": [
{
"code": 204
}
],
"description": "Delete an authenticator for a user by ID.",
"demo": "account\/delete-mfa-authenticator.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.deleteMFAAuthenticator"
}
},
{
"name": "deleteMFAAuthenticator",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"type"
],
"required": [
"type"
],
"responses": [
{
"code": 204
}
],
"description": "Delete an authenticator for a user by ID.",
"demo": "account\/delete-mfa-authenticator.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "type",
"description": "Type of authenticator.",
"required": true,
"schema": {
"type": "string",
"x-example": "totp",
"enum": [
"totp"
],
"x-enum-name": "AuthenticatorType",
"x-enum-keys": []
},
"in": "path"
}
]
}
},
"\/account\/mfa\/challenges": {
"post": {
"summary": "Create MFA challenge",
"operationId": "accountCreateMfaChallenge",
"tags": [
"account"
],
"description": "Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.",
"responses": {
"201": {
"description": "MFA Challenge",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/mfaChallenge"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createMfaChallenge",
"group": "mfa",
"weight": 247,
"cookies": false,
"type": "",
"demo": "account\/create-mfa-challenge.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "url:{url},userId:{userId}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.createMFAChallenge"
},
"methods": [
{
"name": "createMfaChallenge",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"factor"
],
"required": [
"factor"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/mfaChallenge"
}
],
"description": "Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.",
"demo": "account\/create-mfa-challenge.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.createMFAChallenge"
}
},
{
"name": "createMFAChallenge",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"factor"
],
"required": [
"factor"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/mfaChallenge"
}
],
"description": "Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.",
"demo": "account\/create-mfa-challenge.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"factor": {
"type": "string",
"description": "Factor used for verification. Must be one of following: `email`, `phone`, `totp`, `recoveryCode`.",
"x-example": "email",
"enum": [
"email",
"phone",
"totp",
"recoverycode"
],
"x-enum-name": "AuthenticationFactor",
"x-enum-keys": []
}
},
"required": [
"factor"
]
}
}
}
}
},
"put": {
"summary": "Update MFA challenge (confirmation)",
"operationId": "accountUpdateMfaChallenge",
"tags": [
"account"
],
"description": "Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
"responses": {
"200": {
"description": "Session",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/session"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateMfaChallenge",
"group": "mfa",
"weight": 248,
"cookies": false,
"type": "",
"demo": "account\/update-mfa-challenge.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "url:{url},challengeId:{param-challengeId}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.updateMFAChallenge"
},
"methods": [
{
"name": "updateMfaChallenge",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"challengeId",
"otp"
],
"required": [
"challengeId",
"otp"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/session"
}
],
"description": "Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
"demo": "account\/update-mfa-challenge.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.updateMFAChallenge"
}
},
{
"name": "updateMFAChallenge",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"challengeId",
"otp"
],
"required": [
"challengeId",
"otp"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/session"
}
],
"description": "Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
"demo": "account\/update-mfa-challenge.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"challengeId": {
"type": "string",
"description": "ID of the challenge.",
"x-example": "<CHALLENGE_ID>"
},
"otp": {
"type": "string",
"description": "Valid verification token.",
"x-example": "<OTP>"
}
},
"required": [
"challengeId",
"otp"
]
}
}
}
}
}
},
"\/account\/mfa\/factors": {
"get": {
"summary": "List factors",
"operationId": "accountListMfaFactors",
"tags": [
"account"
],
"description": "List the factors available on the account to be used as a MFA challange.",
"responses": {
"200": {
"description": "MFAFactors",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/mfaFactors"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "listMfaFactors",
"group": "mfa",
"weight": 240,
"cookies": false,
"type": "",
"demo": "account\/list-mfa-factors.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.listMFAFactors"
},
"methods": [
{
"name": "listMfaFactors",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [],
"required": [],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaFactors"
}
],
"description": "List the factors available on the account to be used as a MFA challange.",
"demo": "account\/list-mfa-factors.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.listMFAFactors"
}
},
{
"name": "listMFAFactors",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [],
"required": [],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaFactors"
}
],
"description": "List the factors available on the account to be used as a MFA challange.",
"demo": "account\/list-mfa-factors.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
}
},
"\/account\/mfa\/recovery-codes": {
"get": {
"summary": "List MFA recovery codes",
"operationId": "accountGetMfaRecoveryCodes",
"tags": [
"account"
],
"description": "Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.",
"responses": {
"200": {
"description": "MFA Recovery Codes",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/mfaRecoveryCodes"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "getMfaRecoveryCodes",
"group": "mfa",
"weight": 246,
"cookies": false,
"type": "",
"demo": "account\/get-mfa-recovery-codes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.getMFARecoveryCodes"
},
"methods": [
{
"name": "getMfaRecoveryCodes",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [],
"required": [],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.",
"demo": "account\/get-mfa-recovery-codes.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.getMFARecoveryCodes"
}
},
{
"name": "getMFARecoveryCodes",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [],
"required": [],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.",
"demo": "account\/get-mfa-recovery-codes.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
},
"post": {
"summary": "Create MFA recovery codes",
"operationId": "accountCreateMfaRecoveryCodes",
"tags": [
"account"
],
"description": "Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
"responses": {
"201": {
"description": "MFA Recovery Codes",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/mfaRecoveryCodes"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createMfaRecoveryCodes",
"group": "mfa",
"weight": 244,
"cookies": false,
"type": "",
"demo": "account\/create-mfa-recovery-codes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.createMFARecoveryCodes"
},
"methods": [
{
"name": "createMfaRecoveryCodes",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [],
"required": [],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
"demo": "account\/create-mfa-recovery-codes.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.createMFARecoveryCodes"
}
},
{
"name": "createMFARecoveryCodes",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [],
"required": [],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
"demo": "account\/create-mfa-recovery-codes.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
},
"patch": {
"summary": "Update MFA recovery codes (regenerate)",
"operationId": "accountUpdateMfaRecoveryCodes",
"tags": [
"account"
],
"description": "Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.",
"responses": {
"200": {
"description": "MFA Recovery Codes",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/mfaRecoveryCodes"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateMfaRecoveryCodes",
"group": "mfa",
"weight": 245,
"cookies": false,
"type": "",
"demo": "account\/update-mfa-recovery-codes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.updateMFARecoveryCodes"
},
"methods": [
{
"name": "updateMfaRecoveryCodes",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [],
"required": [],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.",
"demo": "account\/update-mfa-recovery-codes.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.updateMFARecoveryCodes"
}
},
{
"name": "updateMFARecoveryCodes",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [],
"required": [],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.",
"demo": "account\/update-mfa-recovery-codes.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
}
},
"\/account\/name": {
"patch": {
"summary": "Update name",
"operationId": "accountUpdateName",
"tags": [
"account"
],
"description": "Update currently logged in user account name.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateName",
"group": "account",
"weight": 32,
"cookies": false,
"type": "",
"demo": "account\/update-name.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"name"
]
}
}
}
}
}
},
"\/account\/password": {
"patch": {
"summary": "Update password",
"operationId": "accountUpdatePassword",
"tags": [
"account"
],
"description": "Update currently logged in user password. For validation, user is required to pass in the new password, and the old password. For users created with OAuth, Team Invites and Magic URL, oldPassword is optional.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePassword",
"group": "account",
"weight": 33,
"cookies": false,
"type": "",
"demo": "account\/update-password.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": "New user password. Must be at least 8 chars.",
"x-example": null
},
"oldPassword": {
"type": "string",
"description": "Current user password. Must be at least 8 chars.",
"x-example": "password",
"format": "password"
}
},
"required": [
"password"
]
}
}
}
}
}
},
"\/account\/phone": {
"patch": {
"summary": "Update phone",
"operationId": "accountUpdatePhone",
"tags": [
"account"
],
"description": "Update the currently logged in user's phone number. After updating the phone number, the phone verification status will be reset. A confirmation SMS is not sent automatically, however you can use the [POST \/account\/verification\/phone](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createPhoneVerification) endpoint to send a confirmation SMS.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePhone",
"group": "account",
"weight": 35,
"cookies": false,
"type": "",
"demo": "account\/update-phone.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"phone": {
"type": "string",
"description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.",
"x-example": "+12065550100",
"format": "phone"
},
"password": {
"type": "string",
"description": "User password. Must be at least 8 chars.",
"x-example": "password",
"format": "password"
}
},
"required": [
"phone",
"password"
]
}
}
}
}
}
},
"\/account\/prefs": {
"get": {
"summary": "Get account preferences",
"operationId": "accountGetPrefs",
"tags": [
"account"
],
"description": "Get the preferences as a key-value object for the currently logged in user.",
"responses": {
"200": {
"description": "Preferences",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/preferences"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getPrefs",
"group": "account",
"weight": 30,
"cookies": false,
"type": "",
"demo": "account\/get-prefs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
},
"patch": {
"summary": "Update preferences",
"operationId": "accountUpdatePrefs",
"tags": [
"account"
],
"description": "Update currently logged in user account preferences. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePrefs",
"group": "account",
"weight": 36,
"cookies": false,
"type": "",
"demo": "account\/update-prefs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"prefs": {
"type": "object",
"description": "Prefs key-value JSON object.",
"x-example": "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}"
}
},
"required": [
"prefs"
]
}
}
}
}
}
},
"\/account\/recovery": {
"post": {
"summary": "Create password recovery",
"operationId": "accountCreateRecovery",
"tags": [
"account"
],
"description": "Sends the user an email with a temporary secret key for password reset. When the user clicks the confirmation link he is redirected back to your app password reset URL with the secret key and email address values attached to the URL query string. Use the query string params to submit a request to the [PUT \/account\/recovery](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.",
"responses": {
"201": {
"description": "Token",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/token"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createRecovery",
"group": "recovery",
"weight": 38,
"cookies": false,
"type": "",
"demo": "account\/create-recovery.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": [
"url:{url},email:{param-email}",
"url:{url},ip:{ip}"
],
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"url": {
"type": "string",
"description": "URL to redirect the user back to your app from the recovery email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.",
"x-example": "https:\/\/example.com",
"format": "url"
}
},
"required": [
"email",
"url"
]
}
}
}
}
},
"put": {
"summary": "Update password recovery (confirmation)",
"operationId": "accountUpdateRecovery",
"tags": [
"account"
],
"description": "Use this endpoint to complete the user account password reset. Both the **userId** and **secret** arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the [POST \/account\/recovery](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createRecovery) endpoint.\n\nPlease note that in order to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.",
"responses": {
"200": {
"description": "Token",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/token"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateRecovery",
"group": "recovery",
"weight": 39,
"cookies": false,
"type": "",
"demo": "account\/update-recovery.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "url:{url},userId:{param-userId}",
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "<USER_ID>"
},
"secret": {
"type": "string",
"description": "Valid reset token.",
"x-example": "<SECRET>"
},
"password": {
"type": "string",
"description": "New user password. Must be between 8 and 256 chars.",
"x-example": null
}
},
"required": [
"userId",
"secret",
"password"
]
}
}
}
}
}
},
"\/account\/sessions": {
"get": {
"summary": "List sessions",
"operationId": "accountListSessions",
"tags": [
"account"
],
"description": "Get the list of active sessions across different devices for the currently logged in user.",
"responses": {
"200": {
"description": "Sessions List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/sessionList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listSessions",
"group": "sessions",
"weight": 11,
"cookies": false,
"type": "",
"demo": "account\/list-sessions.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
},
"delete": {
"summary": "Delete sessions",
"operationId": "accountDeleteSessions",
"tags": [
"account"
],
"description": "Delete all sessions from the user account and remove any sessions cookies from the end client.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteSessions",
"group": "sessions",
"weight": 12,
"cookies": false,
"type": "",
"demo": "account\/delete-sessions.md",
"rate-limit": 100,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
}
},
"\/account\/sessions\/anonymous": {
"post": {
"summary": "Create anonymous session",
"operationId": "accountCreateAnonymousSession",
"tags": [
"account"
],
"description": "Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateEmail) or create an [OAuth2 session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#CreateOAuth2Session).",
"responses": {
"201": {
"description": "Session",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/session"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createAnonymousSession",
"group": "sessions",
"weight": 17,
"cookies": false,
"type": "",
"demo": "account\/create-anonymous-session.md",
"rate-limit": 50,
"rate-time": 3600,
"rate-key": "ip:{ip}",
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
}
},
"\/account\/sessions\/email": {
"post": {
"summary": "Create email password session",
"operationId": "accountCreateEmailPasswordSession",
"tags": [
"account"
],
"description": "Allow the user to login into their account by providing a valid email and password combination. This route will create a new session for the user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).",
"responses": {
"201": {
"description": "Session",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/session"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createEmailPasswordSession",
"group": "sessions",
"weight": 16,
"cookies": false,
"type": "",
"demo": "account\/create-email-password-session.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "url:{url},email:{param-email}",
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"password": {
"type": "string",
"description": "User password. Must be at least 8 chars.",
"x-example": "password",
"format": "password"
}
},
"required": [
"email",
"password"
]
}
}
}
}
}
},
"\/account\/sessions\/magic-url": {
"put": {
"summary": "Update magic URL session",
"operationId": "accountUpdateMagicURLSession",
"tags": [
"account"
],
"description": "Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.",
"responses": {
"201": {
"description": "Session",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/session"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateMagicURLSession",
"group": "sessions",
"weight": 26,
"cookies": false,
"type": "",
"demo": "account\/update-magic-url-session.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "ip:{ip},userId:{param-userId}",
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"deprecated": {
"since": "1.6.0",
"replaceWith": "account.createSession"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"secret": {
"type": "string",
"description": "Valid verification token.",
"x-example": "<SECRET>"
}
},
"required": [
"userId",
"secret"
]
}
}
}
}
}
},
"\/account\/sessions\/oauth2\/{provider}": {
"get": {
"summary": "Create OAuth2 session",
"operationId": "accountCreateOAuth2Session",
"tags": [
"account"
],
"description": "Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed.\n\nIf there is already an active session, the new session will be attached to the logged-in account. If there are no active sessions, the server will attempt to look for a user with the same email address as the email received from the OAuth2 provider and attach the new session to the existing user. If no matching user is found - the server will create a new user.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n",
"responses": {
"301": {
"description": "File"
}
},
"deprecated": false,
"x-appwrite": {
"method": "createOAuth2Session",
"group": "sessions",
"weight": 19,
"cookies": false,
"type": "webAuth",
"demo": "account\/create-o-auth-2-session.md",
"rate-limit": 50,
"rate-time": 3600,
"rate-key": "ip:{ip}",
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "provider",
"description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.",
"required": true,
"schema": {
"type": "string",
"x-example": "amazon",
"enum": [
"amazon",
"apple",
"auth0",
"authentik",
"autodesk",
"bitbucket",
"bitly",
"box",
"dailymotion",
"discord",
"disqus",
"dropbox",
"etsy",
"facebook",
"figma",
"github",
"gitlab",
"google",
"linkedin",
"microsoft",
"notion",
"oidc",
"okta",
"paypal",
"paypalSandbox",
"podio",
"salesforce",
"slack",
"spotify",
"stripe",
"tradeshift",
"tradeshiftBox",
"twitch",
"wordpress",
"yahoo",
"yammer",
"yandex",
"zoho",
"zoom"
],
"x-enum-name": "OAuthProvider",
"x-enum-keys": []
},
"in": "path"
},
{
"name": "success",
"description": "URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.",
"required": false,
"schema": {
"type": "string",
"format": "url",
"x-example": "https:\/\/example.com",
"default": ""
},
"in": "query"
},
{
"name": "failure",
"description": "URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.",
"required": false,
"schema": {
"type": "string",
"format": "url",
"x-example": "https:\/\/example.com",
"default": ""
},
"in": "query"
},
{
"name": "scopes",
"description": "A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
}
},
"\/account\/sessions\/phone": {
"put": {
"summary": "Update phone session",
"operationId": "accountUpdatePhoneSession",
"tags": [
"account"
],
"description": "Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.",
"responses": {
"201": {
"description": "Session",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/session"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updatePhoneSession",
"group": "sessions",
"weight": 27,
"cookies": false,
"type": "",
"demo": "account\/update-phone-session.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "ip:{ip},userId:{param-userId}",
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"deprecated": {
"since": "1.6.0",
"replaceWith": "account.createSession"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"secret": {
"type": "string",
"description": "Valid verification token.",
"x-example": "<SECRET>"
}
},
"required": [
"userId",
"secret"
]
}
}
}
}
}
},
"\/account\/sessions\/token": {
"post": {
"summary": "Create session",
"operationId": "accountCreateSession",
"tags": [
"account"
],
"description": "Use this endpoint to create a session from token. Provide the **userId** and **secret** parameters from the successful response of authentication flows initiated by token creation. For example, magic URL and phone login.",
"responses": {
"201": {
"description": "Session",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/session"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createSession",
"group": "sessions",
"weight": 18,
"cookies": false,
"type": "",
"demo": "account\/create-session.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "ip:{ip},userId:{param-userId}",
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"secret": {
"type": "string",
"description": "Secret of a token generated by login methods. For example, the `createMagicURLToken` or `createPhoneToken` methods.",
"x-example": "<SECRET>"
}
},
"required": [
"userId",
"secret"
]
}
}
}
}
}
},
"\/account\/sessions\/{sessionId}": {
"get": {
"summary": "Get session",
"operationId": "accountGetSession",
"tags": [
"account"
],
"description": "Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.",
"responses": {
"200": {
"description": "Session",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/session"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getSession",
"group": "sessions",
"weight": 13,
"cookies": false,
"type": "",
"demo": "account\/get-session.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "sessionId",
"description": "Session ID. Use the string 'current' to get the current device session.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SESSION_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Update session",
"operationId": "accountUpdateSession",
"tags": [
"account"
],
"description": "Use this endpoint to extend a session's length. Extending a session is useful when session expiry is short. If the session was created using an OAuth provider, this endpoint refreshes the access token from the provider.",
"responses": {
"200": {
"description": "Session",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/session"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateSession",
"group": "sessions",
"weight": 15,
"cookies": false,
"type": "",
"demo": "account\/update-session.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "sessionId",
"description": "Session ID. Use the string 'current' to update the current device session.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SESSION_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete session",
"operationId": "accountDeleteSession",
"tags": [
"account"
],
"description": "Logout the user. Use 'current' as the session ID to logout on this device, use a session ID to logout on another device. If you're looking to logout the user on all devices, use [Delete Sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#deleteSessions) instead.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteSession",
"group": "sessions",
"weight": 14,
"cookies": false,
"type": "",
"demo": "account\/delete-session.md",
"rate-limit": 100,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "sessionId",
"description": "Session ID. Use the string 'current' to delete the current device session.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SESSION_ID>"
},
"in": "path"
}
]
}
},
"\/account\/status": {
"patch": {
"summary": "Update status",
"operationId": "accountUpdateStatus",
"tags": [
"account"
],
"description": "Block the currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. To completely delete a user, use the Users API instead.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateStatus",
"group": "account",
"weight": 37,
"cookies": false,
"type": "",
"demo": "account\/update-status.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
}
},
"\/account\/targets\/push": {
"post": {
"summary": "Create push target",
"operationId": "accountCreatePushTarget",
"tags": [
"account"
],
"description": "Use this endpoint to register a device for push notifications. Provide a target ID (custom or generated using ID.unique()), a device identifier (usually a device token), and optionally specify which provider should send notifications to this target. The target is automatically linked to the current session and includes device information like brand and model.",
"responses": {
"201": {
"description": "Target",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/target"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createPushTarget",
"group": "pushTargets",
"weight": 44,
"cookies": false,
"type": "",
"demo": "account\/create-push-target.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "targets.write",
"platforms": [
"console",
"client"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-push-target.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"targetId": {
"type": "string",
"description": "Target 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.",
"x-example": "<TARGET_ID>"
},
"identifier": {
"type": "string",
"description": "The target identifier (token, email, phone etc.)",
"x-example": "<IDENTIFIER>"
},
"providerId": {
"type": "string",
"description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.",
"x-example": "<PROVIDER_ID>"
}
},
"required": [
"targetId",
"identifier"
]
}
}
}
}
}
},
"\/account\/targets\/{targetId}\/push": {
"put": {
"summary": "Update push target",
"operationId": "accountUpdatePushTarget",
"tags": [
"account"
],
"description": "Update the currently logged in user's push notification target. You can modify the target's identifier (device token) and provider ID (token, email, phone etc.). The target must exist and belong to the current user. If you change the provider ID, notifications will be sent through the new messaging provider instead.",
"responses": {
"200": {
"description": "Target",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/target"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePushTarget",
"group": "pushTargets",
"weight": 45,
"cookies": false,
"type": "",
"demo": "account\/update-push-target.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "targets.write",
"platforms": [
"console",
"client"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-push-target.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "targetId",
"description": "Target ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TARGET_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The target identifier (token, email, phone etc.)",
"x-example": "<IDENTIFIER>"
}
},
"required": [
"identifier"
]
}
}
}
}
},
"delete": {
"summary": "Delete push target",
"operationId": "accountDeletePushTarget",
"tags": [
"account"
],
"description": "Delete a push notification target for the currently logged in user. After deletion, the device will no longer receive push notifications. The target must exist and belong to the current user.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deletePushTarget",
"group": "pushTargets",
"weight": 46,
"cookies": false,
"type": "",
"demo": "account\/delete-push-target.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "targets.write",
"platforms": [
"console",
"client"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-push-target.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "targetId",
"description": "Target ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TARGET_ID>"
},
"in": "path"
}
]
}
},
"\/account\/tokens\/email": {
"post": {
"summary": "Create email token (OTP)",
"operationId": "accountCreateEmailToken",
"tags": [
"account"
],
"description": "Sends the user an email with a secret key for creating a session. If the email address has never been used, a **new account is created** using the provided `userId`. Otherwise, if the email address is already attached to an account, the **user ID is ignored**. Then, the user will receive an email with the one-time password. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n",
"responses": {
"201": {
"description": "Token",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/token"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createEmailToken",
"group": "tokens",
"weight": 25,
"cookies": false,
"type": "",
"demo": "account\/create-email-token.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": [
"url:{url},email:{param-email}",
"url:{url},ip:{ip}"
],
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"phrase": {
"type": "boolean",
"description": "Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.",
"x-example": false
}
},
"required": [
"userId",
"email"
]
}
}
}
}
}
},
"\/account\/tokens\/magic-url": {
"post": {
"summary": "Create magic URL token",
"operationId": "accountCreateMagicURLToken",
"tags": [
"account"
],
"description": "Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n",
"responses": {
"201": {
"description": "Token",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/token"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createMagicURLToken",
"group": "tokens",
"weight": 24,
"cookies": false,
"type": "",
"demo": "account\/create-magic-url-token.md",
"rate-limit": 60,
"rate-time": 3600,
"rate-key": [
"url:{url},email:{param-email}",
"url:{url},ip:{ip}"
],
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "Unique 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. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"url": {
"type": "string",
"description": "URL to redirect the user back to your app from the magic URL login. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.",
"x-example": "https:\/\/example.com",
"format": "url"
},
"phrase": {
"type": "boolean",
"description": "Toggle for security phrase. If enabled, email will be send with a randomly generated phrase and the phrase will also be included in the response. Confirming phrases match increases the security of your authentication flow.",
"x-example": false
}
},
"required": [
"userId",
"email"
]
}
}
}
}
}
},
"\/account\/tokens\/oauth2\/{provider}": {
"get": {
"summary": "Create OAuth2 token",
"operationId": "accountCreateOAuth2Token",
"tags": [
"account"
],
"description": "Allow the user to login to their account using the OAuth2 provider of their choice. Each OAuth2 provider should be enabled from the Appwrite console first. Use the success and failure arguments to provide a redirect URL's back to your app when login is completed. \n\nIf authentication succeeds, `userId` and `secret` of a token will be appended to the success URL as query parameters. These can be used to create a new session using the [Create session](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).",
"responses": {
"301": {
"description": "File"
}
},
"deprecated": false,
"x-appwrite": {
"method": "createOAuth2Token",
"group": "tokens",
"weight": 23,
"cookies": false,
"type": "webAuth",
"demo": "account\/create-o-auth-2-token.md",
"rate-limit": 50,
"rate-time": 3600,
"rate-key": "ip:{ip}",
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "provider",
"description": "OAuth2 Provider. Currently, supported providers are: amazon, apple, auth0, authentik, autodesk, bitbucket, bitly, box, dailymotion, discord, disqus, dropbox, etsy, facebook, figma, github, gitlab, google, linkedin, microsoft, notion, oidc, okta, paypal, paypalSandbox, podio, salesforce, slack, spotify, stripe, tradeshift, tradeshiftBox, twitch, wordpress, yahoo, yammer, yandex, zoho, zoom.",
"required": true,
"schema": {
"type": "string",
"x-example": "amazon",
"enum": [
"amazon",
"apple",
"auth0",
"authentik",
"autodesk",
"bitbucket",
"bitly",
"box",
"dailymotion",
"discord",
"disqus",
"dropbox",
"etsy",
"facebook",
"figma",
"github",
"gitlab",
"google",
"linkedin",
"microsoft",
"notion",
"oidc",
"okta",
"paypal",
"paypalSandbox",
"podio",
"salesforce",
"slack",
"spotify",
"stripe",
"tradeshift",
"tradeshiftBox",
"twitch",
"wordpress",
"yahoo",
"yammer",
"yandex",
"zoho",
"zoom"
],
"x-enum-name": "OAuthProvider",
"x-enum-keys": []
},
"in": "path"
},
{
"name": "success",
"description": "URL to redirect back to your app after a successful login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.",
"required": false,
"schema": {
"type": "string",
"format": "url",
"x-example": "https:\/\/example.com",
"default": ""
},
"in": "query"
},
{
"name": "failure",
"description": "URL to redirect back to your app after a failed login attempt. Only URLs from hostnames in your project's platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.",
"required": false,
"schema": {
"type": "string",
"format": "url",
"x-example": "https:\/\/example.com",
"default": ""
},
"in": "query"
},
{
"name": "scopes",
"description": "A list of custom OAuth2 scopes. Check each provider internal docs for a list of supported scopes. Maximum of 100 scopes are allowed, each 4096 characters long.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
}
},
"\/account\/tokens\/phone": {
"post": {
"summary": "Create phone token",
"operationId": "accountCreatePhoneToken",
"tags": [
"account"
],
"description": "Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).",
"responses": {
"201": {
"description": "Token",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/token"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createPhoneToken",
"group": "tokens",
"weight": 28,
"cookies": false,
"type": "",
"demo": "account\/create-phone-token.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": [
"url:{url},phone:{param-phone}",
"url:{url},ip:{ip}"
],
"scope": "sessions.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "Unique 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. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.",
"x-example": "<USER_ID>"
},
"phone": {
"type": "string",
"description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.",
"x-example": "+12065550100",
"format": "phone"
}
},
"required": [
"userId",
"phone"
]
}
}
}
}
}
},
"\/account\/verifications\/email": {
"post": {
"summary": "Create email verification",
"operationId": "accountCreateEmailVerification",
"tags": [
"account"
],
"description": "Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease note that in order to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.\n",
"responses": {
"201": {
"description": "Token",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/token"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createEmailVerification",
"group": "verification",
"weight": 40,
"cookies": false,
"type": "",
"demo": "account\/create-email-verification.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "url:{url},userId:{userId}",
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md",
"methods": [
{
"name": "createEmailVerification",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"url"
],
"required": [
"url"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/token"
}
],
"description": "Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease note that in order to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.\n",
"demo": "account\/create-email-verification.md",
"public": true
},
{
"name": "createVerification",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"url"
],
"required": [
"url"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/token"
}
],
"description": "Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updateVerification). The verification link sent to the user's email address is valid for 7 days.\n\nPlease note that in order to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.\n",
"demo": "account\/create-verification.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.createEmailVerification"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"url": {
"type": "string",
"description": "URL to redirect the user back to your app from the verification email. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.",
"x-example": "https:\/\/example.com",
"format": "url"
}
},
"required": [
"url"
]
}
}
}
}
},
"put": {
"summary": "Update email verification (confirmation)",
"operationId": "accountUpdateEmailVerification",
"tags": [
"account"
],
"description": "Use this endpoint to complete the user email verification process. Use both the **userId** and **secret** parameters that were attached to your app URL to verify the user email ownership. If confirmed this route will return a 200 status code.",
"responses": {
"200": {
"description": "Token",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/token"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateEmailVerification",
"group": "verification",
"weight": 41,
"cookies": false,
"type": "",
"demo": "account\/update-email-verification.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "url:{url},userId:{param-userId}",
"scope": "public",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md",
"methods": [
{
"name": "updateEmailVerification",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId",
"secret"
],
"required": [
"userId",
"secret"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/token"
}
],
"description": "Use this endpoint to complete the user email verification process. Use both the **userId** and **secret** parameters that were attached to your app URL to verify the user email ownership. If confirmed this route will return a 200 status code.",
"demo": "account\/update-email-verification.md",
"public": true
},
{
"name": "updateVerification",
"namespace": "account",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId",
"secret"
],
"required": [
"userId",
"secret"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/token"
}
],
"description": "Use this endpoint to complete the user email verification process. Use both the **userId** and **secret** parameters that were attached to your app URL to verify the user email ownership. If confirmed this route will return a 200 status code.",
"demo": "account\/update-verification.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "account.updateEmailVerification"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "<USER_ID>"
},
"secret": {
"type": "string",
"description": "Valid verification token.",
"x-example": "<SECRET>"
}
},
"required": [
"userId",
"secret"
]
}
}
}
}
}
},
"\/account\/verifications\/phone": {
"post": {
"summary": "Create phone verification",
"operationId": "accountCreatePhoneVerification",
"tags": [
"account"
],
"description": "Use this endpoint to send a verification SMS to the currently logged in user. This endpoint is meant for use after updating a user's phone number using the [accountUpdatePhone](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhone) endpoint. Learn more about how to [complete the verification process](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes.",
"responses": {
"201": {
"description": "Token",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/token"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createPhoneVerification",
"group": "verification",
"weight": 42,
"cookies": false,
"type": "",
"demo": "account\/create-phone-verification.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": [
"url:{url},userId:{userId}",
"url:{url},ip:{ip}"
],
"scope": "account",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
]
},
"put": {
"summary": "Update phone verification (confirmation)",
"operationId": "accountUpdatePhoneVerification",
"tags": [
"account"
],
"description": "Use this endpoint to complete the user phone verification process. Use the **userId** and **secret** that were sent to your user's phone number to verify the user email ownership. If confirmed this route will return a 200 status code.",
"responses": {
"200": {
"description": "Token",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/token"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePhoneVerification",
"group": "verification",
"weight": 43,
"cookies": false,
"type": "",
"demo": "account\/update-phone-verification.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "userId:{param-userId}",
"scope": "public",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "<USER_ID>"
},
"secret": {
"type": "string",
"description": "Valid verification token.",
"x-example": "<SECRET>"
}
},
"required": [
"userId",
"secret"
]
}
}
}
}
}
},
"\/avatars\/browsers\/{code}": {
"get": {
"summary": "Get browser icon",
"operationId": "avatarsGetBrowser",
"tags": [
"avatars"
],
"description": "You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET \/account\/sessions](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.",
"responses": {
"200": {
"description": "Image"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getBrowser",
"group": null,
"weight": 250,
"cookies": false,
"type": "location",
"demo": "avatars\/get-browser.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "avatars.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "code",
"description": "Browser Code.",
"required": true,
"schema": {
"type": "string",
"x-example": "aa",
"enum": [
"aa",
"an",
"ch",
"ci",
"cm",
"cr",
"ff",
"sf",
"mf",
"ps",
"oi",
"om",
"op",
"on"
],
"x-enum-name": "Browser",
"x-enum-keys": [
"Avant Browser",
"Android WebView Beta",
"Google Chrome",
"Google Chrome (iOS)",
"Google Chrome (Mobile)",
"Chromium",
"Mozilla Firefox",
"Safari",
"Mobile Safari",
"Microsoft Edge",
"Microsoft Edge (iOS)",
"Opera Mini",
"Opera",
"Opera (Next)"
]
},
"in": "path"
},
{
"name": "width",
"description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 100
},
"in": "query"
},
{
"name": "height",
"description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 100
},
"in": "query"
},
{
"name": "quality",
"description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": -1,
"default": -1
},
"in": "query"
}
]
}
},
"\/avatars\/credit-cards\/{code}": {
"get": {
"summary": "Get credit card icon",
"operationId": "avatarsGetCreditCard",
"tags": [
"avatars"
],
"description": "The credit card endpoint will return you the icon of the credit card provider you need. Use width, height and quality arguments to change the output settings.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n",
"responses": {
"200": {
"description": "Image"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getCreditCard",
"group": null,
"weight": 249,
"cookies": false,
"type": "location",
"demo": "avatars\/get-credit-card.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "avatars.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "code",
"description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.",
"required": true,
"schema": {
"type": "string",
"x-example": "amex",
"enum": [
"amex",
"argencard",
"cabal",
"cencosud",
"diners",
"discover",
"elo",
"hipercard",
"jcb",
"mastercard",
"naranja",
"targeta-shopping",
"unionpay",
"visa",
"mir",
"maestro",
"rupay"
],
"x-enum-name": "CreditCard",
"x-enum-keys": [
"American Express",
"Argencard",
"Cabal",
"Cencosud",
"Diners Club",
"Discover",
"Elo",
"Hipercard",
"JCB",
"Mastercard",
"Naranja",
"Tarjeta Shopping",
"Union Pay",
"Visa",
"MIR",
"Maestro",
"Rupay"
]
},
"in": "path"
},
{
"name": "width",
"description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 100
},
"in": "query"
},
{
"name": "height",
"description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 100
},
"in": "query"
},
{
"name": "quality",
"description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": -1,
"default": -1
},
"in": "query"
}
]
}
},
"\/avatars\/favicon": {
"get": {
"summary": "Get favicon",
"operationId": "avatarsGetFavicon",
"tags": [
"avatars"
],
"description": "Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.\n\nThis endpoint does not follow HTTP redirects.",
"responses": {
"200": {
"description": "Image"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getFavicon",
"group": null,
"weight": 253,
"cookies": false,
"type": "location",
"demo": "avatars\/get-favicon.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "avatars.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "url",
"description": "Website URL which you want to fetch the favicon from.",
"required": true,
"schema": {
"type": "string",
"format": "url",
"x-example": "https:\/\/example.com"
},
"in": "query"
}
]
}
},
"\/avatars\/flags\/{code}": {
"get": {
"summary": "Get country flag",
"operationId": "avatarsGetFlag",
"tags": [
"avatars"
],
"description": "You can use this endpoint to show different country flags icons to your users. The code argument receives the 2 letter country code. Use width, height and quality arguments to change the output settings. Country codes follow the [ISO 3166-1](https:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) standard.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n",
"responses": {
"200": {
"description": "Image"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getFlag",
"group": null,
"weight": 251,
"cookies": false,
"type": "location",
"demo": "avatars\/get-flag.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "avatars.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "code",
"description": "Country Code. ISO Alpha-2 country code format.",
"required": true,
"schema": {
"type": "string",
"x-example": "af",
"enum": [
"af",
"ao",
"al",
"ad",
"ae",
"ar",
"am",
"ag",
"au",
"at",
"az",
"bi",
"be",
"bj",
"bf",
"bd",
"bg",
"bh",
"bs",
"ba",
"by",
"bz",
"bo",
"br",
"bb",
"bn",
"bt",
"bw",
"cf",
"ca",
"ch",
"cl",
"cn",
"ci",
"cm",
"cd",
"cg",
"co",
"km",
"cv",
"cr",
"cu",
"cy",
"cz",
"de",
"dj",
"dm",
"dk",
"do",
"dz",
"ec",
"eg",
"er",
"es",
"ee",
"et",
"fi",
"fj",
"fr",
"fm",
"ga",
"gb",
"ge",
"gh",
"gn",
"gm",
"gw",
"gq",
"gr",
"gd",
"gt",
"gy",
"hn",
"hr",
"ht",
"hu",
"id",
"in",
"ie",
"ir",
"iq",
"is",
"il",
"it",
"jm",
"jo",
"jp",
"kz",
"ke",
"kg",
"kh",
"ki",
"kn",
"kr",
"kw",
"la",
"lb",
"lr",
"ly",
"lc",
"li",
"lk",
"ls",
"lt",
"lu",
"lv",
"ma",
"mc",
"md",
"mg",
"mv",
"mx",
"mh",
"mk",
"ml",
"mt",
"mm",
"me",
"mn",
"mz",
"mr",
"mu",
"mw",
"my",
"na",
"ne",
"ng",
"ni",
"nl",
"no",
"np",
"nr",
"nz",
"om",
"pk",
"pa",
"pe",
"ph",
"pw",
"pg",
"pl",
"pf",
"kp",
"pt",
"py",
"qa",
"ro",
"ru",
"rw",
"sa",
"sd",
"sn",
"sg",
"sb",
"sl",
"sv",
"sm",
"so",
"rs",
"ss",
"st",
"sr",
"sk",
"si",
"se",
"sz",
"sc",
"sy",
"td",
"tg",
"th",
"tj",
"tm",
"tl",
"to",
"tt",
"tn",
"tr",
"tv",
"tz",
"ug",
"ua",
"uy",
"us",
"uz",
"va",
"vc",
"ve",
"vn",
"vu",
"ws",
"ye",
"za",
"zm",
"zw"
],
"x-enum-name": "Flag",
"x-enum-keys": [
"Afghanistan",
"Angola",
"Albania",
"Andorra",
"United Arab Emirates",
"Argentina",
"Armenia",
"Antigua and Barbuda",
"Australia",
"Austria",
"Azerbaijan",
"Burundi",
"Belgium",
"Benin",
"Burkina Faso",
"Bangladesh",
"Bulgaria",
"Bahrain",
"Bahamas",
"Bosnia and Herzegovina",
"Belarus",
"Belize",
"Bolivia",
"Brazil",
"Barbados",
"Brunei Darussalam",
"Bhutan",
"Botswana",
"Central African Republic",
"Canada",
"Switzerland",
"Chile",
"China",
"C\u00f4te d'Ivoire",
"Cameroon",
"Democratic Republic of the Congo",
"Republic of the Congo",
"Colombia",
"Comoros",
"Cape Verde",
"Costa Rica",
"Cuba",
"Cyprus",
"Czech Republic",
"Germany",
"Djibouti",
"Dominica",
"Denmark",
"Dominican Republic",
"Algeria",
"Ecuador",
"Egypt",
"Eritrea",
"Spain",
"Estonia",
"Ethiopia",
"Finland",
"Fiji",
"France",
"Micronesia (Federated States of)",
"Gabon",
"United Kingdom",
"Georgia",
"Ghana",
"Guinea",
"Gambia",
"Guinea-Bissau",
"Equatorial Guinea",
"Greece",
"Grenada",
"Guatemala",
"Guyana",
"Honduras",
"Croatia",
"Haiti",
"Hungary",
"Indonesia",
"India",
"Ireland",
"Iran (Islamic Republic of)",
"Iraq",
"Iceland",
"Israel",
"Italy",
"Jamaica",
"Jordan",
"Japan",
"Kazakhstan",
"Kenya",
"Kyrgyzstan",
"Cambodia",
"Kiribati",
"Saint Kitts and Nevis",
"South Korea",
"Kuwait",
"Lao People's Democratic Republic",
"Lebanon",
"Liberia",
"Libya",
"Saint Lucia",
"Liechtenstein",
"Sri Lanka",
"Lesotho",
"Lithuania",
"Luxembourg",
"Latvia",
"Morocco",
"Monaco",
"Moldova",
"Madagascar",
"Maldives",
"Mexico",
"Marshall Islands",
"North Macedonia",
"Mali",
"Malta",
"Myanmar",
"Montenegro",
"Mongolia",
"Mozambique",
"Mauritania",
"Mauritius",
"Malawi",
"Malaysia",
"Namibia",
"Niger",
"Nigeria",
"Nicaragua",
"Netherlands",
"Norway",
"Nepal",
"Nauru",
"New Zealand",
"Oman",
"Pakistan",
"Panama",
"Peru",
"Philippines",
"Palau",
"Papua New Guinea",
"Poland",
"French Polynesia",
"North Korea",
"Portugal",
"Paraguay",
"Qatar",
"Romania",
"Russia",
"Rwanda",
"Saudi Arabia",
"Sudan",
"Senegal",
"Singapore",
"Solomon Islands",
"Sierra Leone",
"El Salvador",
"San Marino",
"Somalia",
"Serbia",
"South Sudan",
"Sao Tome and Principe",
"Suriname",
"Slovakia",
"Slovenia",
"Sweden",
"Eswatini",
"Seychelles",
"Syria",
"Chad",
"Togo",
"Thailand",
"Tajikistan",
"Turkmenistan",
"Timor-Leste",
"Tonga",
"Trinidad and Tobago",
"Tunisia",
"Turkey",
"Tuvalu",
"Tanzania",
"Uganda",
"Ukraine",
"Uruguay",
"United States",
"Uzbekistan",
"Vatican City",
"Saint Vincent and the Grenadines",
"Venezuela",
"Vietnam",
"Vanuatu",
"Samoa",
"Yemen",
"South Africa",
"Zambia",
"Zimbabwe"
]
},
"in": "path"
},
{
"name": "width",
"description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 100
},
"in": "query"
},
{
"name": "height",
"description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 100
},
"in": "query"
},
{
"name": "quality",
"description": "Image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": -1,
"default": -1
},
"in": "query"
}
]
}
},
"\/avatars\/image": {
"get": {
"summary": "Get image from URL",
"operationId": "avatarsGetImage",
"tags": [
"avatars"
],
"description": "Use this endpoint to fetch a remote image URL and crop it to any image size you want. This endpoint is very useful if you need to crop and display remote images in your app or in case you want to make sure a 3rd party image is properly served using a TLS protocol.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 400x400px.\n\nThis endpoint does not follow HTTP redirects.",
"responses": {
"200": {
"description": "Image"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getImage",
"group": null,
"weight": 252,
"cookies": false,
"type": "location",
"demo": "avatars\/get-image.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "avatars.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "url",
"description": "Image URL which you want to crop.",
"required": true,
"schema": {
"type": "string",
"format": "url",
"x-example": "https:\/\/example.com"
},
"in": "query"
},
{
"name": "width",
"description": "Resize preview image width, Pass an integer between 0 to 2000. Defaults to 400.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 400
},
"in": "query"
},
{
"name": "height",
"description": "Resize preview image height, Pass an integer between 0 to 2000. Defaults to 400.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 400
},
"in": "query"
}
]
}
},
"\/avatars\/initials": {
"get": {
"summary": "Get user initials",
"operationId": "avatarsGetInitials",
"tags": [
"avatars"
],
"description": "Use this endpoint to show your user initials avatar icon on your website or app. By default, this route will try to print your logged-in user name or email initials. You can also overwrite the user name if you pass the 'name' parameter. If no name is given and no user is logged, an empty avatar will be returned.\n\nYou can use the color and background params to change the avatar colors. By default, a random theme will be selected. The random theme will persist for the user's initials when reloading the same theme will always return for the same initials.\n\nWhen one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px.\n",
"responses": {
"200": {
"description": "Image"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getInitials",
"group": null,
"weight": 255,
"cookies": false,
"type": "location",
"demo": "avatars\/get-initials.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "avatars.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "name",
"description": "Full Name. When empty, current user name or email will be used. Max length: 128 chars.",
"required": false,
"schema": {
"type": "string",
"x-example": "<NAME>",
"default": ""
},
"in": "query"
},
{
"name": "width",
"description": "Image width. Pass an integer between 0 to 2000. Defaults to 100.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 500
},
"in": "query"
},
{
"name": "height",
"description": "Image height. Pass an integer between 0 to 2000. Defaults to 100.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 500
},
"in": "query"
},
{
"name": "background",
"description": "Changes background color. By default a random color will be picked and stay will persistent to the given name.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"in": "query"
}
]
}
},
"\/avatars\/qr": {
"get": {
"summary": "Get QR code",
"operationId": "avatarsGetQR",
"tags": [
"avatars"
],
"description": "Converts a given plain text to a QR code image. You can use the query parameters to change the size and style of the resulting image.\n",
"responses": {
"200": {
"description": "Image"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQR",
"group": null,
"weight": 254,
"cookies": false,
"type": "location",
"demo": "avatars\/get-qr.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "avatars.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "text",
"description": "Plain text to be converted to QR code image.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEXT>"
},
"in": "query"
},
{
"name": "size",
"description": "QR code size. Pass an integer between 1 to 1000. Defaults to 400.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 1,
"default": 400
},
"in": "query"
},
{
"name": "margin",
"description": "Margin from edge. Pass an integer between 0 to 10. Defaults to 1.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 1
},
"in": "query"
},
{
"name": "download",
"description": "Return resulting image with 'Content-Disposition: attachment ' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.",
"required": false,
"schema": {
"type": "boolean",
"x-example": false,
"default": false
},
"in": "query"
}
]
}
},
"\/avatars\/screenshots": {
"get": {
"summary": "Get webpage screenshot",
"operationId": "avatarsGetScreenshot",
"tags": [
"avatars"
],
"description": "Use this endpoint to capture a screenshot of any website URL. This endpoint uses a headless browser to render the webpage and capture it as an image.\n\nYou can configure the browser viewport size, theme, user agent, geolocation, permissions, and more. Capture either just the viewport or the full page scroll.\n\nWhen width and height are specified, the image is resized accordingly. If both dimensions are 0, the API provides an image at original size. If dimensions are not specified, the default viewport size is 1280x720px.",
"responses": {
"200": {
"description": "Image"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getScreenshot",
"group": null,
"weight": 256,
"cookies": false,
"type": "location",
"demo": "avatars\/get-screenshot.md",
"rate-limit": 60,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "avatars.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-screenshot.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "url",
"description": "Website URL which you want to capture.",
"required": true,
"schema": {
"type": "string",
"format": "url",
"x-example": "https:\/\/example.com"
},
"in": "query"
},
{
"name": "headers",
"description": "HTTP headers to send with the browser request. Defaults to empty.",
"required": false,
"schema": {
"type": "object",
"x-example": "{\"Authorization\":\"Bearer token123\",\"X-Custom-Header\":\"value\"}",
"default": {}
},
"in": "query"
},
{
"name": "viewportWidth",
"description": "Browser viewport width. Pass an integer between 1 to 1920. Defaults to 1280.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": "1920",
"default": 1280
},
"in": "query"
},
{
"name": "viewportHeight",
"description": "Browser viewport height. Pass an integer between 1 to 1080. Defaults to 720.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": "1080",
"default": 720
},
"in": "query"
},
{
"name": "scale",
"description": "Browser scale factor. Pass a number between 0.1 to 3. Defaults to 1.",
"required": false,
"schema": {
"type": "number",
"format": "float",
"x-example": "2",
"default": 1
},
"in": "query"
},
{
"name": "theme",
"description": "Browser theme. Pass \"light\" or \"dark\". Defaults to \"light\".",
"required": false,
"schema": {
"type": "string",
"x-example": "dark",
"enum": [
"light",
"dark"
],
"x-enum-name": null,
"x-enum-keys": [],
"default": "light"
},
"in": "query"
},
{
"name": "userAgent",
"description": "Custom user agent string. Defaults to browser default.",
"required": false,
"schema": {
"type": "string",
"x-example": "Mozilla\/5.0 (iPhone; CPU iPhone OS 14_0 like Mac OS X) AppleWebKit\/605.1.15",
"default": ""
},
"in": "query"
},
{
"name": "fullpage",
"description": "Capture full page scroll. Pass 0 for viewport only, or 1 for full page. Defaults to 0.",
"required": false,
"schema": {
"type": "boolean",
"x-example": "true",
"default": false
},
"in": "query"
},
{
"name": "locale",
"description": "Browser locale (e.g., \"en-US\", \"fr-FR\"). Defaults to browser default.",
"required": false,
"schema": {
"type": "string",
"x-example": "en-US",
"default": ""
},
"in": "query"
},
{
"name": "timezone",
"description": "IANA timezone identifier (e.g., \"America\/New_York\", \"Europe\/London\"). Defaults to browser default.",
"required": false,
"schema": {
"type": "string",
"x-example": "america\/new_york",
"enum": [
"africa\/abidjan",
"africa\/accra",
"africa\/addis_ababa",
"africa\/algiers",
"africa\/asmara",
"africa\/bamako",
"africa\/bangui",
"africa\/banjul",
"africa\/bissau",
"africa\/blantyre",
"africa\/brazzaville",
"africa\/bujumbura",
"africa\/cairo",
"africa\/casablanca",
"africa\/ceuta",
"africa\/conakry",
"africa\/dakar",
"africa\/dar_es_salaam",
"africa\/djibouti",
"africa\/douala",
"africa\/el_aaiun",
"africa\/freetown",
"africa\/gaborone",
"africa\/harare",
"africa\/johannesburg",
"africa\/juba",
"africa\/kampala",
"africa\/khartoum",
"africa\/kigali",
"africa\/kinshasa",
"africa\/lagos",
"africa\/libreville",
"africa\/lome",
"africa\/luanda",
"africa\/lubumbashi",
"africa\/lusaka",
"africa\/malabo",
"africa\/maputo",
"africa\/maseru",
"africa\/mbabane",
"africa\/mogadishu",
"africa\/monrovia",
"africa\/nairobi",
"africa\/ndjamena",
"africa\/niamey",
"africa\/nouakchott",
"africa\/ouagadougou",
"africa\/porto-novo",
"africa\/sao_tome",
"africa\/tripoli",
"africa\/tunis",
"africa\/windhoek",
"america\/adak",
"america\/anchorage",
"america\/anguilla",
"america\/antigua",
"america\/araguaina",
"america\/argentina\/buenos_aires",
"america\/argentina\/catamarca",
"america\/argentina\/cordoba",
"america\/argentina\/jujuy",
"america\/argentina\/la_rioja",
"america\/argentina\/mendoza",
"america\/argentina\/rio_gallegos",
"america\/argentina\/salta",
"america\/argentina\/san_juan",
"america\/argentina\/san_luis",
"america\/argentina\/tucuman",
"america\/argentina\/ushuaia",
"america\/aruba",
"america\/asuncion",
"america\/atikokan",
"america\/bahia",
"america\/bahia_banderas",
"america\/barbados",
"america\/belem",
"america\/belize",
"america\/blanc-sablon",
"america\/boa_vista",
"america\/bogota",
"america\/boise",
"america\/cambridge_bay",
"america\/campo_grande",
"america\/cancun",
"america\/caracas",
"america\/cayenne",
"america\/cayman",
"america\/chicago",
"america\/chihuahua",
"america\/ciudad_juarez",
"america\/costa_rica",
"america\/coyhaique",
"america\/creston",
"america\/cuiaba",
"america\/curacao",
"america\/danmarkshavn",
"america\/dawson",
"america\/dawson_creek",
"america\/denver",
"america\/detroit",
"america\/dominica",
"america\/edmonton",
"america\/eirunepe",
"america\/el_salvador",
"america\/fort_nelson",
"america\/fortaleza",
"america\/glace_bay",
"america\/goose_bay",
"america\/grand_turk",
"america\/grenada",
"america\/guadeloupe",
"america\/guatemala",
"america\/guayaquil",
"america\/guyana",
"america\/halifax",
"america\/havana",
"america\/hermosillo",
"america\/indiana\/indianapolis",
"america\/indiana\/knox",
"america\/indiana\/marengo",
"america\/indiana\/petersburg",
"america\/indiana\/tell_city",
"america\/indiana\/vevay",
"america\/indiana\/vincennes",
"america\/indiana\/winamac",
"america\/inuvik",
"america\/iqaluit",
"america\/jamaica",
"america\/juneau",
"america\/kentucky\/louisville",
"america\/kentucky\/monticello",
"america\/kralendijk",
"america\/la_paz",
"america\/lima",
"america\/los_angeles",
"america\/lower_princes",
"america\/maceio",
"america\/managua",
"america\/manaus",
"america\/marigot",
"america\/martinique",
"america\/matamoros",
"america\/mazatlan",
"america\/menominee",
"america\/merida",
"america\/metlakatla",
"america\/mexico_city",
"america\/miquelon",
"america\/moncton",
"america\/monterrey",
"america\/montevideo",
"america\/montserrat",
"america\/nassau",
"america\/new_york",
"america\/nome",
"america\/noronha",
"america\/north_dakota\/beulah",
"america\/north_dakota\/center",
"america\/north_dakota\/new_salem",
"america\/nuuk",
"america\/ojinaga",
"america\/panama",
"america\/paramaribo",
"america\/phoenix",
"america\/port-au-prince",
"america\/port_of_spain",
"america\/porto_velho",
"america\/puerto_rico",
"america\/punta_arenas",
"america\/rankin_inlet",
"america\/recife",
"america\/regina",
"america\/resolute",
"america\/rio_branco",
"america\/santarem",
"america\/santiago",
"america\/santo_domingo",
"america\/sao_paulo",
"america\/scoresbysund",
"america\/sitka",
"america\/st_barthelemy",
"america\/st_johns",
"america\/st_kitts",
"america\/st_lucia",
"america\/st_thomas",
"america\/st_vincent",
"america\/swift_current",
"america\/tegucigalpa",
"america\/thule",
"america\/tijuana",
"america\/toronto",
"america\/tortola",
"america\/vancouver",
"america\/whitehorse",
"america\/winnipeg",
"america\/yakutat",
"antarctica\/casey",
"antarctica\/davis",
"antarctica\/dumontdurville",
"antarctica\/macquarie",
"antarctica\/mawson",
"antarctica\/mcmurdo",
"antarctica\/palmer",
"antarctica\/rothera",
"antarctica\/syowa",
"antarctica\/troll",
"antarctica\/vostok",
"arctic\/longyearbyen",
"asia\/aden",
"asia\/almaty",
"asia\/amman",
"asia\/anadyr",
"asia\/aqtau",
"asia\/aqtobe",
"asia\/ashgabat",
"asia\/atyrau",
"asia\/baghdad",
"asia\/bahrain",
"asia\/baku",
"asia\/bangkok",
"asia\/barnaul",
"asia\/beirut",
"asia\/bishkek",
"asia\/brunei",
"asia\/chita",
"asia\/colombo",
"asia\/damascus",
"asia\/dhaka",
"asia\/dili",
"asia\/dubai",
"asia\/dushanbe",
"asia\/famagusta",
"asia\/gaza",
"asia\/hebron",
"asia\/ho_chi_minh",
"asia\/hong_kong",
"asia\/hovd",
"asia\/irkutsk",
"asia\/jakarta",
"asia\/jayapura",
"asia\/jerusalem",
"asia\/kabul",
"asia\/kamchatka",
"asia\/karachi",
"asia\/kathmandu",
"asia\/khandyga",
"asia\/kolkata",
"asia\/krasnoyarsk",
"asia\/kuala_lumpur",
"asia\/kuching",
"asia\/kuwait",
"asia\/macau",
"asia\/magadan",
"asia\/makassar",
"asia\/manila",
"asia\/muscat",
"asia\/nicosia",
"asia\/novokuznetsk",
"asia\/novosibirsk",
"asia\/omsk",
"asia\/oral",
"asia\/phnom_penh",
"asia\/pontianak",
"asia\/pyongyang",
"asia\/qatar",
"asia\/qostanay",
"asia\/qyzylorda",
"asia\/riyadh",
"asia\/sakhalin",
"asia\/samarkand",
"asia\/seoul",
"asia\/shanghai",
"asia\/singapore",
"asia\/srednekolymsk",
"asia\/taipei",
"asia\/tashkent",
"asia\/tbilisi",
"asia\/tehran",
"asia\/thimphu",
"asia\/tokyo",
"asia\/tomsk",
"asia\/ulaanbaatar",
"asia\/urumqi",
"asia\/ust-nera",
"asia\/vientiane",
"asia\/vladivostok",
"asia\/yakutsk",
"asia\/yangon",
"asia\/yekaterinburg",
"asia\/yerevan",
"atlantic\/azores",
"atlantic\/bermuda",
"atlantic\/canary",
"atlantic\/cape_verde",
"atlantic\/faroe",
"atlantic\/madeira",
"atlantic\/reykjavik",
"atlantic\/south_georgia",
"atlantic\/st_helena",
"atlantic\/stanley",
"australia\/adelaide",
"australia\/brisbane",
"australia\/broken_hill",
"australia\/darwin",
"australia\/eucla",
"australia\/hobart",
"australia\/lindeman",
"australia\/lord_howe",
"australia\/melbourne",
"australia\/perth",
"australia\/sydney",
"europe\/amsterdam",
"europe\/andorra",
"europe\/astrakhan",
"europe\/athens",
"europe\/belgrade",
"europe\/berlin",
"europe\/bratislava",
"europe\/brussels",
"europe\/bucharest",
"europe\/budapest",
"europe\/busingen",
"europe\/chisinau",
"europe\/copenhagen",
"europe\/dublin",
"europe\/gibraltar",
"europe\/guernsey",
"europe\/helsinki",
"europe\/isle_of_man",
"europe\/istanbul",
"europe\/jersey",
"europe\/kaliningrad",
"europe\/kirov",
"europe\/kyiv",
"europe\/lisbon",
"europe\/ljubljana",
"europe\/london",
"europe\/luxembourg",
"europe\/madrid",
"europe\/malta",
"europe\/mariehamn",
"europe\/minsk",
"europe\/monaco",
"europe\/moscow",
"europe\/oslo",
"europe\/paris",
"europe\/podgorica",
"europe\/prague",
"europe\/riga",
"europe\/rome",
"europe\/samara",
"europe\/san_marino",
"europe\/sarajevo",
"europe\/saratov",
"europe\/simferopol",
"europe\/skopje",
"europe\/sofia",
"europe\/stockholm",
"europe\/tallinn",
"europe\/tirane",
"europe\/ulyanovsk",
"europe\/vaduz",
"europe\/vatican",
"europe\/vienna",
"europe\/vilnius",
"europe\/volgograd",
"europe\/warsaw",
"europe\/zagreb",
"europe\/zurich",
"indian\/antananarivo",
"indian\/chagos",
"indian\/christmas",
"indian\/cocos",
"indian\/comoro",
"indian\/kerguelen",
"indian\/mahe",
"indian\/maldives",
"indian\/mauritius",
"indian\/mayotte",
"indian\/reunion",
"pacific\/apia",
"pacific\/auckland",
"pacific\/bougainville",
"pacific\/chatham",
"pacific\/chuuk",
"pacific\/easter",
"pacific\/efate",
"pacific\/fakaofo",
"pacific\/fiji",
"pacific\/funafuti",
"pacific\/galapagos",
"pacific\/gambier",
"pacific\/guadalcanal",
"pacific\/guam",
"pacific\/honolulu",
"pacific\/kanton",
"pacific\/kiritimati",
"pacific\/kosrae",
"pacific\/kwajalein",
"pacific\/majuro",
"pacific\/marquesas",
"pacific\/midway",
"pacific\/nauru",
"pacific\/niue",
"pacific\/norfolk",
"pacific\/noumea",
"pacific\/pago_pago",
"pacific\/palau",
"pacific\/pitcairn",
"pacific\/pohnpei",
"pacific\/port_moresby",
"pacific\/rarotonga",
"pacific\/saipan",
"pacific\/tahiti",
"pacific\/tarawa",
"pacific\/tongatapu",
"pacific\/wake",
"pacific\/wallis",
"utc"
],
"x-enum-name": null,
"x-enum-keys": [],
"default": ""
},
"in": "query"
},
{
"name": "latitude",
"description": "Geolocation latitude. Pass a number between -90 to 90. Defaults to 0.",
"required": false,
"schema": {
"type": "number",
"format": "float",
"x-example": "37.7749",
"default": 0
},
"in": "query"
},
{
"name": "longitude",
"description": "Geolocation longitude. Pass a number between -180 to 180. Defaults to 0.",
"required": false,
"schema": {
"type": "number",
"format": "float",
"x-example": "-122.4194",
"default": 0
},
"in": "query"
},
{
"name": "accuracy",
"description": "Geolocation accuracy in meters. Pass a number between 0 to 100000. Defaults to 0.",
"required": false,
"schema": {
"type": "number",
"format": "float",
"x-example": "100",
"default": 0
},
"in": "query"
},
{
"name": "touch",
"description": "Enable touch support. Pass 0 for no touch, or 1 for touch enabled. Defaults to 0.",
"required": false,
"schema": {
"type": "boolean",
"x-example": "true",
"default": false
},
"in": "query"
},
{
"name": "permissions",
"description": "Browser permissions to grant. Pass an array of permission names like [\"geolocation\", \"camera\", \"microphone\"]. Defaults to empty.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"geolocation",
"camera",
"microphone",
"notifications",
"midi",
"push",
"clipboard-read",
"clipboard-write",
"payment-handler",
"usb",
"bluetooth",
"accelerometer",
"gyroscope",
"magnetometer",
"ambient-light-sensor",
"background-sync",
"persistent-storage",
"screen-wake-lock",
"web-share",
"xr-spatial-tracking"
],
"x-enum-name": "BrowserPermission",
"x-enum-keys": []
},
"x-example": "[\"geolocation\",\"notifications\"]",
"default": []
},
"in": "query"
},
{
"name": "sleep",
"description": "Wait time in seconds before taking the screenshot. Pass an integer between 0 to 10. Defaults to 0.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": "3",
"default": 0
},
"in": "query"
},
{
"name": "width",
"description": "Output image width. Pass 0 to use original width, or an integer between 1 to 2000. Defaults to 0 (original width).",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": "800",
"default": 0
},
"in": "query"
},
{
"name": "height",
"description": "Output image height. Pass 0 to use original height, or an integer between 1 to 2000. Defaults to 0 (original height).",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": "600",
"default": 0
},
"in": "query"
},
{
"name": "quality",
"description": "Screenshot quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": "85",
"default": -1
},
"in": "query"
},
{
"name": "output",
"description": "Output format type (jpeg, jpg, png, gif and webp).",
"required": false,
"schema": {
"type": "string",
"x-example": "jpeg",
"enum": [
"jpg",
"jpeg",
"png",
"webp",
"heic",
"avif",
"gif"
],
"x-enum-name": "ImageFormat",
"x-enum-keys": [],
"default": ""
},
"in": "query"
}
]
}
},
"\/console\/assistant": {
"post": {
"summary": "Create assistant query",
"operationId": "assistantChat",
"tags": [
"assistant"
],
"description": "Send a prompt to the AI assistant and receive a response. This endpoint allows you to interact with Appwrite's AI assistant by sending questions or prompts and receiving helpful responses in real-time through a server-sent events stream. ",
"responses": {
"200": {
"description": "File"
}
},
"deprecated": false,
"x-appwrite": {
"method": "chat",
"group": "console",
"weight": 502,
"cookies": false,
"type": "",
"demo": "assistant\/chat.md",
"rate-limit": 15,
"rate-time": 3600,
"rate-key": "userId:{userId}",
"scope": "assistant.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/assistant\/chat.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"prompt": {
"type": "string",
"description": "Prompt. A string containing questions asked to the AI assistant.",
"x-example": "<PROMPT>"
}
},
"required": [
"prompt"
]
}
}
}
}
}
},
"\/console\/resources": {
"get": {
"summary": "Check resource ID availability",
"operationId": "consoleGetResource",
"tags": [
"console"
],
"description": "Check if a resource ID is available.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getResource",
"group": null,
"weight": 503,
"cookies": false,
"type": "",
"demo": "console\/get-resource.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "userId:{userId}, url:{url}",
"scope": "rules.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "value",
"description": "Resource value.",
"required": true,
"schema": {
"type": "string",
"x-example": "<VALUE>"
},
"in": "query"
},
{
"name": "type",
"description": "Resource type.",
"required": true,
"schema": {
"type": "string",
"x-example": "rules",
"enum": [
"rules"
],
"x-enum-name": "ConsoleResourceType",
"x-enum-keys": []
},
"in": "query"
}
]
}
},
"\/console\/variables": {
"get": {
"summary": "Get variables",
"operationId": "consoleVariables",
"tags": [
"console"
],
"description": "Get all Environment Variables that are relevant for the console.",
"responses": {
"200": {
"description": "Console Variables",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/consoleVariables"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "variables",
"group": "console",
"weight": 501,
"cookies": false,
"type": "",
"demo": "console\/variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/console\/variables.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
]
}
},
"\/databases": {
"get": {
"summary": "List databases",
"operationId": "databasesList",
"tags": [
"databases"
],
"description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.",
"responses": {
"200": {
"description": "Databases List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/databaseList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "list",
"group": "databases",
"weight": 264,
"cookies": false,
"type": "",
"demo": "databases\/list.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.list"
},
"methods": [
{
"name": "list",
"namespace": "databases",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"queries",
"search",
"total"
],
"required": [],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/databaseList"
}
],
"description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.",
"demo": "databases\/list.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.list"
}
}
],
"auth": {
"Project": []
}
},
"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",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create database",
"operationId": "databasesCreate",
"tags": [
"databases"
],
"description": "Create a new Database.\n",
"responses": {
"201": {
"description": "Database",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/database"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "create",
"group": "databases",
"weight": 260,
"cookies": false,
"type": "",
"demo": "databases\/create.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.create"
},
"methods": [
{
"name": "create",
"namespace": "databases",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"name",
"enabled"
],
"required": [
"databaseId",
"name"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/database"
}
],
"description": "Create a new Database.\n",
"demo": "databases\/create.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.create"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"databaseId": {
"type": "string",
"description": "Unique 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.",
"x-example": "<DATABASE_ID>"
},
"name": {
"type": "string",
"description": "Database name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
}
},
"required": [
"databaseId",
"name"
]
}
}
}
}
}
},
"\/databases\/transactions": {
"get": {
"summary": "List transactions",
"operationId": "databasesListTransactions",
"tags": [
"databases"
],
"description": "List transactions across all databases.",
"responses": {
"200": {
"description": "Transaction List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/transactionList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listTransactions",
"group": "transactions",
"weight": 332,
"cookies": false,
"type": "",
"demo": "databases\/list-transactions.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "rows.read",
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-transactions.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"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).",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
},
"post": {
"summary": "Create transaction",
"operationId": "databasesCreateTransaction",
"tags": [
"databases"
],
"description": "Create a new transaction.",
"responses": {
"201": {
"description": "Transaction",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/transaction"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTransaction",
"group": "transactions",
"weight": 328,
"cookies": false,
"type": "",
"demo": "databases\/create-transaction.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "documents.write",
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-transaction.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"ttl": {
"type": "integer",
"description": "Seconds before the transaction expires.",
"x-example": 60,
"format": "int32"
}
}
}
}
}
}
}
},
"\/databases\/transactions\/{transactionId}": {
"get": {
"summary": "Get transaction",
"operationId": "databasesGetTransaction",
"tags": [
"databases"
],
"description": "Get a transaction by its unique ID.",
"responses": {
"200": {
"description": "Transaction",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/transaction"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getTransaction",
"group": "transactions",
"weight": 329,
"cookies": false,
"type": "",
"demo": "databases\/get-transaction.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "rows.read",
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-transaction.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "transactionId",
"description": "Transaction ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Update transaction",
"operationId": "databasesUpdateTransaction",
"tags": [
"databases"
],
"description": "Update a transaction, to either commit or roll back its operations.",
"responses": {
"200": {
"description": "Transaction",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/transaction"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTransaction",
"group": "transactions",
"weight": 330,
"cookies": false,
"type": "",
"demo": "databases\/update-transaction.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "documents.write",
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-transaction.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "transactionId",
"description": "Transaction ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"commit": {
"type": "boolean",
"description": "Commit transaction?",
"x-example": false
},
"rollback": {
"type": "boolean",
"description": "Rollback transaction?",
"x-example": false
}
}
}
}
}
}
},
"delete": {
"summary": "Delete transaction",
"operationId": "databasesDeleteTransaction",
"tags": [
"databases"
],
"description": "Delete a transaction by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteTransaction",
"group": "transactions",
"weight": 331,
"cookies": false,
"type": "",
"demo": "databases\/delete-transaction.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "documents.write",
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-transaction.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "transactionId",
"description": "Transaction ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"in": "path"
}
]
}
},
"\/databases\/transactions\/{transactionId}\/operations": {
"post": {
"summary": "Create operations",
"operationId": "databasesCreateOperations",
"tags": [
"databases"
],
"description": "Create multiple operations in a single transaction.",
"responses": {
"201": {
"description": "Transaction",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/transaction"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createOperations",
"group": "transactions",
"weight": 333,
"cookies": false,
"type": "",
"demo": "databases\/create-operations.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "documents.write",
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-operations.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "transactionId",
"description": "Transaction ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"operations": {
"type": "array",
"description": "Array of staged operations.",
"x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"collectionId\": \"<COLLECTION_ID>\",\n\t \"documentId\": \"<DOCUMENT_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]",
"items": {
"type": "object"
}
}
}
}
}
}
}
}
},
"\/databases\/usage": {
"get": {
"summary": "Get databases usage stats",
"operationId": "databasesListUsage",
"tags": [
"databases"
],
"description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"responses": {
"200": {
"description": "UsageDatabases",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageDatabases"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "listUsage",
"group": null,
"weight": 267,
"cookies": false,
"type": "",
"demo": "databases\/list-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-usage.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.listUsage"
},
"methods": [
{
"name": "listUsage",
"namespace": "databases",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"range"
],
"required": [],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/usageDatabases"
}
],
"description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"demo": "databases\/list-usage.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.listUsage"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/databases\/{databaseId}": {
"get": {
"summary": "Get database",
"operationId": "databasesGet",
"tags": [
"databases"
],
"description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.",
"responses": {
"200": {
"description": "Database",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/database"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "get",
"group": "databases",
"weight": 261,
"cookies": false,
"type": "",
"demo": "databases\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.get"
},
"methods": [
{
"name": "get",
"namespace": "databases",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId"
],
"required": [
"databaseId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/database"
}
],
"description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.",
"demo": "databases\/get.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.get"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update database",
"operationId": "databasesUpdate",
"tags": [
"databases"
],
"description": "Update a database by its unique ID.",
"responses": {
"200": {
"description": "Database",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/database"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "update",
"group": "databases",
"weight": 262,
"cookies": false,
"type": "",
"demo": "databases\/update.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.update"
},
"methods": [
{
"name": "update",
"namespace": "databases",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"name",
"enabled"
],
"required": [
"databaseId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/database"
}
],
"description": "Update a database by its unique ID.",
"demo": "databases\/update.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.update"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Database name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
}
}
}
}
}
}
},
"delete": {
"summary": "Delete database",
"operationId": "databasesDelete",
"tags": [
"databases"
],
"description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": true,
"x-appwrite": {
"method": "delete",
"group": "databases",
"weight": 263,
"cookies": false,
"type": "",
"demo": "databases\/delete.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.delete"
},
"methods": [
{
"name": "delete",
"namespace": "databases",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId"
],
"required": [
"databaseId"
],
"responses": [
{
"code": 204
}
],
"description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.",
"demo": "databases\/delete.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.delete"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
}
]
}
},
"\/databases\/{databaseId}\/collections": {
"get": {
"summary": "List collections",
"operationId": "databasesListCollections",
"tags": [
"databases"
],
"description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.",
"responses": {
"200": {
"description": "Collections List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/collectionList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "listCollections",
"group": "collections",
"weight": 272,
"cookies": false,
"type": "",
"demo": "databases\/list-collections.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.listTables"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"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, documentSecurity",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create collections",
"operationId": "databasesCreateCollection",
"tags": [
"databases"
],
"description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"201": {
"description": "Collection",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/collection"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createCollection",
"group": "collections",
"weight": 268,
"cookies": false,
"type": "",
"demo": "databases\/create-collection.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createTable"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"collectionId": {
"type": "string",
"description": "Unique 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.",
"x-example": "<COLLECTION_ID>"
},
"name": {
"type": "string",
"description": "Collection name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"documentSecurity": {
"type": "boolean",
"description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": false
},
"enabled": {
"type": "boolean",
"description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.",
"x-example": false
},
"attributes": {
"type": "array",
"description": "Array of attribute definitions to create. Each attribute should contain: key (string), type (string: string, integer, float, boolean, datetime), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.",
"x-example": null,
"items": {
"type": "object"
}
},
"indexes": {
"type": "array",
"description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of attribute keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).",
"x-example": null,
"items": {
"type": "object"
}
}
},
"required": [
"collectionId",
"name"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}": {
"get": {
"summary": "Get collection",
"operationId": "databasesGetCollection",
"tags": [
"databases"
],
"description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.",
"responses": {
"200": {
"description": "Collection",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/collection"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "getCollection",
"group": "collections",
"weight": 269,
"cookies": false,
"type": "",
"demo": "databases\/get-collection.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.getTable"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update collection",
"operationId": "databasesUpdateCollection",
"tags": [
"databases"
],
"description": "Update a collection by its unique ID.",
"responses": {
"200": {
"description": "Collection",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/collection"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateCollection",
"group": "collections",
"weight": 270,
"cookies": false,
"type": "",
"demo": "databases\/update-collection.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateTable"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Collection name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"permissions": {
"type": "array",
"description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"documentSecurity": {
"type": "boolean",
"description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": false
},
"enabled": {
"type": "boolean",
"description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.",
"x-example": false
}
}
}
}
}
}
},
"delete": {
"summary": "Delete collection",
"operationId": "databasesDeleteCollection",
"tags": [
"databases"
],
"description": "Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": true,
"x-appwrite": {
"method": "deleteCollection",
"group": "collections",
"weight": 271,
"cookies": false,
"type": "",
"demo": "databases\/delete-collection.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.deleteTable"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
]
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes": {
"get": {
"summary": "List attributes",
"operationId": "databasesListAttributes",
"tags": [
"databases"
],
"description": "List attributes in the collection.",
"responses": {
"200": {
"description": "Attributes List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "listAttributes",
"group": "attributes",
"weight": 289,
"cookies": false,
"type": "",
"demo": "databases\/list-attributes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.listColumns"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"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: key, type, size, required, array, status, error",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean": {
"post": {
"summary": "Create boolean attribute",
"operationId": "databasesCreateBooleanAttribute",
"tags": [
"databases"
],
"description": "Create a boolean attribute.\n",
"responses": {
"202": {
"description": "AttributeBoolean",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeBoolean"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createBooleanAttribute",
"group": "attributes",
"weight": 290,
"cookies": false,
"type": "",
"demo": "databases\/create-boolean-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createBooleanColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "boolean",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": false,
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/boolean\/{key}": {
"patch": {
"summary": "Update boolean attribute",
"operationId": "databasesUpdateBooleanAttribute",
"tags": [
"databases"
],
"description": "Update a boolean attribute. Changing the `default` value will not update already existing documents.",
"responses": {
"200": {
"description": "AttributeBoolean",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeBoolean"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateBooleanAttribute",
"group": "attributes",
"weight": 291,
"cookies": false,
"type": "",
"demo": "databases\/update-boolean-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateBooleanColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "boolean",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": false,
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New attribute key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime": {
"post": {
"summary": "Create datetime attribute",
"operationId": "databasesCreateDatetimeAttribute",
"tags": [
"databases"
],
"description": "Create a date time attribute according to the ISO 8601 standard.",
"responses": {
"202": {
"description": "AttributeDatetime",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeDatetime"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createDatetimeAttribute",
"group": "attributes",
"weight": 292,
"cookies": false,
"type": "",
"demo": "databases\/create-datetime-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createDatetimeColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for the attribute in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when attribute is required.",
"x-example": null,
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": {
"patch": {
"summary": "Update datetime attribute",
"operationId": "databasesUpdateDatetimeAttribute",
"tags": [
"databases"
],
"description": "Update a date time attribute. Changing the `default` value will not update already existing documents.",
"responses": {
"200": {
"description": "AttributeDatetime",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeDatetime"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateDatetimeAttribute",
"group": "attributes",
"weight": 293,
"cookies": false,
"type": "",
"demo": "databases\/update-datetime-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateDatetimeColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": null,
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New attribute key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email": {
"post": {
"summary": "Create email attribute",
"operationId": "databasesCreateEmailAttribute",
"tags": [
"databases"
],
"description": "Create an email attribute.\n",
"responses": {
"202": {
"description": "AttributeEmail",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeEmail"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createEmailAttribute",
"group": "attributes",
"weight": 294,
"cookies": false,
"type": "",
"demo": "databases\/create-email-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createEmailColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "email@example.com",
"format": "email",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/email\/{key}": {
"patch": {
"summary": "Update email attribute",
"operationId": "databasesUpdateEmailAttribute",
"tags": [
"databases"
],
"description": "Update an email attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeEmail",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeEmail"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateEmailAttribute",
"group": "attributes",
"weight": 295,
"cookies": false,
"type": "",
"demo": "databases\/update-email-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateEmailColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "email@example.com",
"format": "email",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum": {
"post": {
"summary": "Create enum attribute",
"operationId": "databasesCreateEnumAttribute",
"tags": [
"databases"
],
"description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n",
"responses": {
"202": {
"description": "AttributeEnum",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeEnum"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createEnumAttribute",
"group": "attributes",
"weight": 296,
"cookies": false,
"type": "",
"demo": "databases\/create-enum-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createEnumColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"elements": {
"type": "array",
"description": "Array of enum values.",
"x-example": null,
"items": {
"type": "string"
}
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"elements",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/enum\/{key}": {
"patch": {
"summary": "Update enum attribute",
"operationId": "databasesUpdateEnumAttribute",
"tags": [
"databases"
],
"description": "Update an enum attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeEnum",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeEnum"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateEnumAttribute",
"group": "attributes",
"weight": 297,
"cookies": false,
"type": "",
"demo": "databases\/update-enum-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateEnumColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"elements": {
"type": "array",
"description": "Updated list of enum values.",
"x-example": null,
"items": {
"type": "string"
}
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"elements",
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float": {
"post": {
"summary": "Create float attribute",
"operationId": "databasesCreateFloatAttribute",
"tags": [
"databases"
],
"description": "Create a float attribute. Optionally, minimum and maximum values can be provided.\n",
"responses": {
"202": {
"description": "AttributeFloat",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeFloat"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createFloatAttribute",
"group": "attributes",
"weight": 298,
"cookies": false,
"type": "",
"demo": "databases\/create-float-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createFloatColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"min": {
"type": "number",
"description": "Minimum value.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"max": {
"type": "number",
"description": "Maximum value.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"default": {
"type": "number",
"description": "Default value. Cannot be set when required.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/float\/{key}": {
"patch": {
"summary": "Update float attribute",
"operationId": "databasesUpdateFloatAttribute",
"tags": [
"databases"
],
"description": "Update a float attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeFloat",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeFloat"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateFloatAttribute",
"group": "attributes",
"weight": 299,
"cookies": false,
"type": "",
"demo": "databases\/update-float-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateFloatColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"min": {
"type": "number",
"description": "Minimum value.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"max": {
"type": "number",
"description": "Maximum value.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"default": {
"type": "number",
"description": "Default value. Cannot be set when required.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer": {
"post": {
"summary": "Create integer attribute",
"operationId": "databasesCreateIntegerAttribute",
"tags": [
"databases"
],
"description": "Create an integer attribute. Optionally, minimum and maximum values can be provided.\n",
"responses": {
"202": {
"description": "AttributeInteger",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeInteger"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createIntegerAttribute",
"group": "attributes",
"weight": 300,
"cookies": false,
"type": "",
"demo": "databases\/create-integer-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createIntegerColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"min": {
"type": "integer",
"description": "Minimum value",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"max": {
"type": "integer",
"description": "Maximum value",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"default": {
"type": "integer",
"description": "Default value. Cannot be set when attribute is required.",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/integer\/{key}": {
"patch": {
"summary": "Update integer attribute",
"operationId": "databasesUpdateIntegerAttribute",
"tags": [
"databases"
],
"description": "Update an integer attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeInteger",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeInteger"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateIntegerAttribute",
"group": "attributes",
"weight": 301,
"cookies": false,
"type": "",
"demo": "databases\/update-integer-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateIntegerColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"min": {
"type": "integer",
"description": "Minimum value",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"max": {
"type": "integer",
"description": "Maximum value",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"default": {
"type": "integer",
"description": "Default value. Cannot be set when attribute is required.",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip": {
"post": {
"summary": "Create IP address attribute",
"operationId": "databasesCreateIpAttribute",
"tags": [
"databases"
],
"description": "Create IP address attribute.\n",
"responses": {
"202": {
"description": "AttributeIP",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeIp"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createIpAttribute",
"group": "attributes",
"weight": 302,
"cookies": false,
"type": "",
"demo": "databases\/create-ip-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createIpColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value. Cannot be set when attribute is required.",
"x-example": null,
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}": {
"patch": {
"summary": "Update IP address attribute",
"operationId": "databasesUpdateIpAttribute",
"tags": [
"databases"
],
"description": "Update an ip attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeIP",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeIp"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateIpAttribute",
"group": "attributes",
"weight": 303,
"cookies": false,
"type": "",
"demo": "databases\/update-ip-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateIpColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value. Cannot be set when attribute is required.",
"x-example": null,
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/line": {
"post": {
"summary": "Create line attribute",
"operationId": "databasesCreateLineAttribute",
"tags": [
"databases"
],
"description": "Create a geometric line attribute.",
"responses": {
"202": {
"description": "AttributeLine",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeLine"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createLineAttribute",
"group": "attributes",
"weight": 304,
"cookies": false,
"type": "",
"demo": "databases\/create-line-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-line-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createLineColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.",
"x-example": "[[1, 2], [3, 4], [5, 6]]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/line\/{key}": {
"patch": {
"summary": "Update line attribute",
"operationId": "databasesUpdateLineAttribute",
"tags": [
"databases"
],
"description": "Update a line attribute. Changing the `default` value will not update already existing documents.",
"responses": {
"200": {
"description": "AttributeLine",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeLine"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateLineAttribute",
"group": "attributes",
"weight": 305,
"cookies": false,
"type": "",
"demo": "databases\/update-line-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-line-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateLineColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.",
"x-example": "[[1, 2], [3, 4], [5, 6]]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New attribute key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext": {
"post": {
"summary": "Create longtext attribute",
"operationId": "databasesCreateLongtextAttribute",
"tags": [
"databases"
],
"description": "Create a longtext attribute.\n",
"responses": {
"202": {
"description": "AttributeLongtext",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeLongtext"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createLongtextAttribute",
"group": "attributes",
"weight": 322,
"cookies": false,
"type": "",
"demo": "databases\/create-longtext-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-longtext-attribute.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext\/{key}": {
"patch": {
"summary": "Update longtext attribute",
"operationId": "databasesUpdateLongtextAttribute",
"tags": [
"databases"
],
"description": "Update a longtext attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeLongtext",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeLongtext"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateLongtextAttribute",
"group": "attributes",
"weight": 323,
"cookies": false,
"type": "",
"demo": "databases\/update-longtext-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-longtext-attribute.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext": {
"post": {
"summary": "Create mediumtext attribute",
"operationId": "databasesCreateMediumtextAttribute",
"tags": [
"databases"
],
"description": "Create a mediumtext attribute.\n",
"responses": {
"202": {
"description": "AttributeMediumtext",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeMediumtext"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createMediumtextAttribute",
"group": "attributes",
"weight": 320,
"cookies": false,
"type": "",
"demo": "databases\/create-mediumtext-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-mediumtext-attribute.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext\/{key}": {
"patch": {
"summary": "Update mediumtext attribute",
"operationId": "databasesUpdateMediumtextAttribute",
"tags": [
"databases"
],
"description": "Update a mediumtext attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeMediumtext",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeMediumtext"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateMediumtextAttribute",
"group": "attributes",
"weight": 321,
"cookies": false,
"type": "",
"demo": "databases\/update-mediumtext-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-mediumtext-attribute.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": {
"post": {
"summary": "Create point attribute",
"operationId": "databasesCreatePointAttribute",
"tags": [
"databases"
],
"description": "Create a geometric point attribute.",
"responses": {
"202": {
"description": "AttributePoint",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributePoint"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createPointAttribute",
"group": "attributes",
"weight": 306,
"cookies": false,
"type": "",
"demo": "databases\/create-point-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createPointColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.",
"x-example": "[1, 2]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": {
"patch": {
"summary": "Update point attribute",
"operationId": "databasesUpdatePointAttribute",
"tags": [
"databases"
],
"description": "Update a point attribute. Changing the `default` value will not update already existing documents.",
"responses": {
"200": {
"description": "AttributePoint",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributePoint"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updatePointAttribute",
"group": "attributes",
"weight": 307,
"cookies": false,
"type": "",
"demo": "databases\/update-point-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updatePointColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.",
"x-example": "[1, 2]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New attribute key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": {
"post": {
"summary": "Create polygon attribute",
"operationId": "databasesCreatePolygonAttribute",
"tags": [
"databases"
],
"description": "Create a geometric polygon attribute.",
"responses": {
"202": {
"description": "AttributePolygon",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributePolygon"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createPolygonAttribute",
"group": "attributes",
"weight": 308,
"cookies": false,
"type": "",
"demo": "databases\/create-polygon-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createPolygonColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.",
"x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": {
"patch": {
"summary": "Update polygon attribute",
"operationId": "databasesUpdatePolygonAttribute",
"tags": [
"databases"
],
"description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.",
"responses": {
"200": {
"description": "AttributePolygon",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributePolygon"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updatePolygonAttribute",
"group": "attributes",
"weight": 309,
"cookies": false,
"type": "",
"demo": "databases\/update-polygon-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updatePolygonColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.",
"x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New attribute key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": {
"post": {
"summary": "Create relationship attribute",
"operationId": "databasesCreateRelationshipAttribute",
"tags": [
"databases"
],
"description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n",
"responses": {
"202": {
"description": "AttributeRelationship",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeRelationship"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createRelationshipAttribute",
"group": "attributes",
"weight": 310,
"cookies": false,
"type": "",
"demo": "databases\/create-relationship-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createRelationshipColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"relatedCollectionId": {
"type": "string",
"description": "Related Collection ID.",
"x-example": "<RELATED_COLLECTION_ID>"
},
"type": {
"type": "string",
"description": "Relation type",
"x-example": "oneToOne",
"enum": [
"oneToOne",
"manyToOne",
"manyToMany",
"oneToMany"
],
"x-enum-name": "RelationshipType",
"x-enum-keys": []
},
"twoWay": {
"type": "boolean",
"description": "Is Two Way?",
"x-example": false
},
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null,
"x-nullable": true
},
"twoWayKey": {
"type": "string",
"description": "Two Way Attribute Key.",
"x-example": null,
"x-nullable": true
},
"onDelete": {
"type": "string",
"description": "Constraints option",
"x-example": "cascade",
"enum": [
"cascade",
"restrict",
"setNull"
],
"x-enum-name": "RelationMutate",
"x-enum-keys": []
}
},
"required": [
"relatedCollectionId",
"type"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": {
"post": {
"summary": "Create string attribute",
"operationId": "databasesCreateStringAttribute",
"tags": [
"databases"
],
"description": "Create a string attribute.\n",
"responses": {
"202": {
"description": "AttributeString",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeString"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createStringAttribute",
"group": "attributes",
"weight": 312,
"cookies": false,
"type": "",
"demo": "databases\/create-string-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createStringColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"size": {
"type": "integer",
"description": "Attribute size for text attributes, in number of characters.",
"x-example": 1,
"format": "int32"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
},
"encrypt": {
"type": "boolean",
"description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.",
"x-example": false
}
},
"required": [
"key",
"size",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": {
"patch": {
"summary": "Update string attribute",
"operationId": "databasesUpdateStringAttribute",
"tags": [
"databases"
],
"description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeString",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeString"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateStringAttribute",
"group": "attributes",
"weight": 313,
"cookies": false,
"type": "",
"demo": "databases\/update-string-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateStringColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"size": {
"type": "integer",
"description": "Maximum size of the string attribute.",
"x-example": 1,
"format": "int32",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": {
"post": {
"summary": "Create text attribute",
"operationId": "databasesCreateTextAttribute",
"tags": [
"databases"
],
"description": "Create a text attribute.\n",
"responses": {
"202": {
"description": "AttributeText",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeText"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTextAttribute",
"group": "attributes",
"weight": 318,
"cookies": false,
"type": "",
"demo": "databases\/create-text-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": {
"patch": {
"summary": "Update text attribute",
"operationId": "databasesUpdateTextAttribute",
"tags": [
"databases"
],
"description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeText",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeText"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTextAttribute",
"group": "attributes",
"weight": 319,
"cookies": false,
"type": "",
"demo": "databases\/update-text-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": {
"post": {
"summary": "Create URL attribute",
"operationId": "databasesCreateUrlAttribute",
"tags": [
"databases"
],
"description": "Create a URL attribute.\n",
"responses": {
"202": {
"description": "AttributeURL",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeUrl"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createUrlAttribute",
"group": "attributes",
"weight": 314,
"cookies": false,
"type": "",
"demo": "databases\/create-url-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createUrlColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "https:\/\/example.com",
"format": "url",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": {
"patch": {
"summary": "Update URL attribute",
"operationId": "databasesUpdateUrlAttribute",
"tags": [
"databases"
],
"description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeURL",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeUrl"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateUrlAttribute",
"group": "attributes",
"weight": 315,
"cookies": false,
"type": "",
"demo": "databases\/update-url-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateUrlColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "https:\/\/example.com",
"format": "url",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": {
"post": {
"summary": "Create varchar attribute",
"operationId": "databasesCreateVarcharAttribute",
"tags": [
"databases"
],
"description": "Create a varchar attribute.\n",
"responses": {
"202": {
"description": "AttributeVarchar",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeVarchar"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createVarcharAttribute",
"group": "attributes",
"weight": 316,
"cookies": false,
"type": "",
"demo": "databases\/create-varchar-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": null
},
"size": {
"type": "integer",
"description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.",
"x-example": 1,
"format": "int32"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false
}
},
"required": [
"key",
"size",
"required"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": {
"patch": {
"summary": "Update varchar attribute",
"operationId": "databasesUpdateVarcharAttribute",
"tags": [
"databases"
],
"description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n",
"responses": {
"200": {
"description": "AttributeVarchar",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeVarchar"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateVarcharAttribute",
"group": "attributes",
"weight": 317,
"cookies": false,
"type": "",
"demo": "databases\/update-varchar-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"size": {
"type": "integer",
"description": "Maximum size of the varchar attribute.",
"x-example": 1,
"format": "int32",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": {
"get": {
"summary": "Get attribute",
"operationId": "databasesGetAttribute",
"tags": [
"databases"
],
"description": "Get attribute by ID.",
"responses": {
"200": {
"description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString",
"content": {
"application\/json": {
"schema": {
"oneOf": [
{
"$ref": "#\/components\/schemas\/attributeBoolean"
},
{
"$ref": "#\/components\/schemas\/attributeInteger"
},
{
"$ref": "#\/components\/schemas\/attributeFloat"
},
{
"$ref": "#\/components\/schemas\/attributeEmail"
},
{
"$ref": "#\/components\/schemas\/attributeEnum"
},
{
"$ref": "#\/components\/schemas\/attributeUrl"
},
{
"$ref": "#\/components\/schemas\/attributeIp"
},
{
"$ref": "#\/components\/schemas\/attributeDatetime"
},
{
"$ref": "#\/components\/schemas\/attributeRelationship"
},
{
"$ref": "#\/components\/schemas\/attributeString"
}
]
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "getAttribute",
"group": "attributes",
"weight": 287,
"cookies": false,
"type": "",
"demo": "databases\/get-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.getColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete attribute",
"operationId": "databasesDeleteAttribute",
"tags": [
"databases"
],
"description": "Deletes an attribute.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": true,
"x-appwrite": {
"method": "deleteAttribute",
"group": "attributes",
"weight": 288,
"cookies": false,
"type": "",
"demo": "databases\/delete-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.deleteColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
]
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship": {
"patch": {
"summary": "Update relationship attribute",
"operationId": "databasesUpdateRelationshipAttribute",
"tags": [
"databases"
],
"description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n",
"responses": {
"200": {
"description": "AttributeRelationship",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/attributeRelationship"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateRelationshipAttribute",
"group": "attributes",
"weight": 311,
"cookies": false,
"type": "",
"demo": "databases\/update-relationship-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateRelationshipColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Attribute Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"onDelete": {
"type": "string",
"description": "Constraints option",
"x-example": "cascade",
"enum": [
"cascade",
"restrict",
"setNull"
],
"x-enum-name": "RelationMutate",
"x-enum-keys": [],
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Attribute Key.",
"x-example": null,
"x-nullable": true
}
}
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/documents": {
"get": {
"summary": "List documents",
"operationId": "databasesListDocuments",
"tags": [
"databases"
],
"description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Documents List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/documentList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "listDocuments",
"group": "documents",
"weight": 283,
"cookies": false,
"type": "",
"demo": "databases\/list-documents.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "documents.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.listRows"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"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.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
},
{
"name": "transactionId",
"description": "Transaction ID to read uncommitted changes within the transaction.",
"required": false,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create document",
"operationId": "databasesCreateDocument",
"tags": [
"databases"
],
"description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"201": {
"description": "Document",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/document"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createDocument",
"group": "documents",
"weight": 275,
"cookies": false,
"type": "",
"demo": "databases\/create-document.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createRow"
},
"methods": [
{
"name": "createDocument",
"namespace": "databases",
"desc": "Create document",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"collectionId",
"documentId",
"data",
"permissions",
"transactionId"
],
"required": [
"databaseId",
"collectionId",
"documentId",
"data"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/document"
}
],
"description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"demo": "databases\/create-document.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createRow"
}
},
{
"name": "createDocuments",
"namespace": "databases",
"desc": "Create documents",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"collectionId",
"documents",
"transactionId"
],
"required": [
"databaseId",
"collectionId",
"documents"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/documentList"
}
],
"description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"demo": "databases\/create-documents.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createRows"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"documentId": {
"type": "string",
"description": "Document 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.",
"x-example": "<DOCUMENT_ID>"
},
"data": {
"type": "object",
"description": "Document data as JSON object.",
"x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}"
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"documents": {
"type": "array",
"description": "Array of documents data as JSON objects.",
"x-example": null,
"items": {
"type": "object"
}
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
},
"put": {
"summary": "Upsert documents",
"operationId": "databasesUpsertDocuments",
"tags": [
"databases"
],
"description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n",
"responses": {
"201": {
"description": "Documents List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/documentList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "upsertDocuments",
"group": "documents",
"weight": 280,
"cookies": false,
"type": "",
"demo": "databases\/upsert-documents.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.upsertRows"
},
"methods": [
{
"name": "upsertDocuments",
"namespace": "databases",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"collectionId",
"documents",
"transactionId"
],
"required": [
"databaseId",
"collectionId",
"documents"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/documentList"
}
],
"description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n",
"demo": "databases\/upsert-documents.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.upsertRows"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"documents": {
"type": "array",
"description": "Array of document data as JSON objects. May contain partial documents.",
"x-example": null,
"items": {
"type": "object"
}
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
},
"required": [
"documents"
]
}
}
}
}
},
"patch": {
"summary": "Update documents",
"operationId": "databasesUpdateDocuments",
"tags": [
"databases"
],
"description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.",
"responses": {
"200": {
"description": "Documents List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/documentList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateDocuments",
"group": "documents",
"weight": 278,
"cookies": false,
"type": "",
"demo": "databases\/update-documents.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateRows"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Document data as JSON object. Include only attribute and value pairs to be updated.",
"x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}"
},
"queries": {
"type": "array",
"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.",
"x-example": null,
"items": {
"type": "string"
}
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
},
"delete": {
"summary": "Delete documents",
"operationId": "databasesDeleteDocuments",
"tags": [
"databases"
],
"description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.",
"responses": {
"200": {
"description": "Documents List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/documentList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "deleteDocuments",
"group": "documents",
"weight": 282,
"cookies": false,
"type": "",
"demo": "databases\/delete-documents.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.deleteRows"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"queries": {
"type": "array",
"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.",
"x-example": null,
"items": {
"type": "string"
}
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": {
"get": {
"summary": "Get document",
"operationId": "databasesGetDocument",
"tags": [
"databases"
],
"description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.",
"responses": {
"200": {
"description": "Document",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/document"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "getDocument",
"group": "documents",
"weight": 276,
"cookies": false,
"type": "",
"demo": "databases\/get-document.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "documents.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.getRow"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "documentId",
"description": "Document ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DOCUMENT_ID>"
},
"in": "path"
},
{
"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.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
},
{
"name": "transactionId",
"description": "Transaction ID to read uncommitted changes within the transaction.",
"required": false,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"in": "query"
}
]
},
"put": {
"summary": "Upsert a document",
"operationId": "databasesUpsertDocument",
"tags": [
"databases"
],
"description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"201": {
"description": "Document",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/document"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "upsertDocument",
"group": "documents",
"weight": 279,
"cookies": false,
"type": "",
"demo": "databases\/upsert-document.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.upsertRow"
},
"methods": [
{
"name": "upsertDocument",
"namespace": "databases",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"collectionId",
"documentId",
"data",
"permissions",
"transactionId"
],
"required": [
"databaseId",
"collectionId",
"documentId"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/document"
}
],
"description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"demo": "databases\/upsert-document.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.upsertRow"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "documentId",
"description": "Document ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DOCUMENT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Document data as JSON object. Include all required attributes of the document to be created or updated.",
"x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}"
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
},
"patch": {
"summary": "Update document",
"operationId": "databasesUpdateDocument",
"tags": [
"databases"
],
"description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.",
"responses": {
"200": {
"description": "Document",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/document"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateDocument",
"group": "documents",
"weight": 277,
"cookies": false,
"type": "",
"demo": "databases\/update-document.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateRow"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "documentId",
"description": "Document ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DOCUMENT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Document data as JSON object. Include only attribute and value pairs to be updated.",
"x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}"
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
},
"delete": {
"summary": "Delete document",
"operationId": "databasesDeleteDocument",
"tags": [
"databases"
],
"description": "Delete a document by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": true,
"x-appwrite": {
"method": "deleteDocument",
"group": "documents",
"weight": 281,
"cookies": false,
"type": "",
"demo": "databases\/delete-document.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.deleteRow"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "documentId",
"description": "Document ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DOCUMENT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs": {
"get": {
"summary": "List document logs",
"operationId": "databasesListDocumentLogs",
"tags": [
"databases"
],
"description": "Get the document activity logs list by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "listDocumentLogs",
"group": "logs",
"weight": 284,
"cookies": false,
"type": "",
"demo": "databases\/list-document-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "documents.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.listRowLogs"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "documentId",
"description": "Document ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DOCUMENT_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": {
"patch": {
"summary": "Decrement document attribute",
"operationId": "databasesDecrementDocumentAttribute",
"tags": [
"databases"
],
"description": "Decrement a specific attribute of a document by a given value.",
"responses": {
"200": {
"description": "Document",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/document"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "decrementDocumentAttribute",
"group": "documents",
"weight": 286,
"cookies": false,
"type": "",
"demo": "databases\/decrement-document-attribute.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"client",
"server",
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.decrementRowColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "documentId",
"description": "Document ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DOCUMENT_ID>"
},
"in": "path"
},
{
"name": "attribute",
"description": "Attribute key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "Value to increment the attribute by. The value must be a number.",
"x-example": null,
"format": "float"
},
"min": {
"type": "number",
"description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": {
"patch": {
"summary": "Increment document attribute",
"operationId": "databasesIncrementDocumentAttribute",
"tags": [
"databases"
],
"description": "Increment a specific attribute of a document by a given value.",
"responses": {
"200": {
"description": "Document",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/document"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "incrementDocumentAttribute",
"group": "documents",
"weight": 285,
"cookies": false,
"type": "",
"demo": "databases\/increment-document-attribute.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
"client",
"server",
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.incrementRowColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "documentId",
"description": "Document ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DOCUMENT_ID>"
},
"in": "path"
},
{
"name": "attribute",
"description": "Attribute key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "Value to increment the attribute by. The value must be a number.",
"x-example": null,
"format": "float"
},
"max": {
"type": "number",
"description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": {
"get": {
"summary": "List indexes",
"operationId": "databasesListIndexes",
"tags": [
"databases"
],
"description": "List indexes in the collection.",
"responses": {
"200": {
"description": "Indexes List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/indexList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "listIndexes",
"group": "indexes",
"weight": 327,
"cookies": false,
"type": "",
"demo": "databases\/list-indexes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.listIndexes"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"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: key, type, status, attributes, error",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create index",
"operationId": "databasesCreateIndex",
"tags": [
"databases"
],
"description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.",
"responses": {
"202": {
"description": "Index",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/index"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createIndex",
"group": "indexes",
"weight": 324,
"cookies": false,
"type": "",
"demo": "databases\/create-index.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.createIndex"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Index Key.",
"x-example": null
},
"type": {
"type": "string",
"description": "Index type.",
"x-example": "key",
"enum": [
"key",
"fulltext",
"unique",
"spatial"
],
"x-enum-name": "IndexType",
"x-enum-keys": []
},
"attributes": {
"type": "array",
"description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.",
"x-example": null,
"items": {
"type": "string"
}
},
"orders": {
"type": "array",
"description": "Array of index orders. Maximum of 100 orders are allowed.",
"x-example": null,
"items": {
"type": "string",
"enum": [
"asc",
"desc"
],
"x-enum-name": "OrderBy",
"x-enum-keys": []
}
},
"lengths": {
"type": "array",
"description": "Length of index. Maximum of 100",
"x-example": null,
"items": {
"type": "integer"
}
}
},
"required": [
"key",
"type",
"attributes"
]
}
}
}
}
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": {
"get": {
"summary": "Get index",
"operationId": "databasesGetIndex",
"tags": [
"databases"
],
"description": "Get an index by its unique ID.",
"responses": {
"200": {
"description": "Index",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/index"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "getIndex",
"group": "indexes",
"weight": 325,
"cookies": false,
"type": "",
"demo": "databases\/get-index.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.getIndex"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Index Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete index",
"operationId": "databasesDeleteIndex",
"tags": [
"databases"
],
"description": "Delete an index.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": true,
"x-appwrite": {
"method": "deleteIndex",
"group": "indexes",
"weight": 326,
"cookies": false,
"type": "",
"demo": "databases\/delete-index.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.deleteIndex"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Index Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
]
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/logs": {
"get": {
"summary": "List collection logs",
"operationId": "databasesListCollectionLogs",
"tags": [
"databases"
],
"description": "Get the collection activity logs list by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "listCollectionLogs",
"group": "collections",
"weight": 273,
"cookies": false,
"type": "",
"demo": "databases\/list-collection-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.listTableLogs"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
}
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/usage": {
"get": {
"summary": "Get collection usage stats",
"operationId": "databasesGetCollectionUsage",
"tags": [
"databases"
],
"description": "Get usage metrics and statistics for a collection. Returning the total number of documents. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"responses": {
"200": {
"description": "UsageCollection",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageCollection"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "getCollectionUsage",
"group": null,
"weight": 274,
"cookies": false,
"type": "",
"demo": "databases\/get-collection-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-usage.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.getTableUsage"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
},
{
"name": "collectionId",
"description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<COLLECTION_ID>"
},
"in": "path"
}
]
}
},
"\/databases\/{databaseId}\/logs": {
"get": {
"summary": "List database logs",
"operationId": "databasesListLogs",
"tags": [
"databases"
],
"description": "Get the database activity logs list by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
"weight": 265,
"cookies": false,
"type": "",
"demo": "databases\/list-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.listDatabaseLogs"
},
"methods": [
{
"name": "listLogs",
"namespace": "databases",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"queries"
],
"required": [
"databaseId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/logList"
}
],
"description": "Get the database activity logs list by its unique ID.",
"demo": "databases\/list-logs.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.listDatabaseLogs"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
}
},
"\/databases\/{databaseId}\/usage": {
"get": {
"summary": "Get database usage stats",
"operationId": "databasesGetUsage",
"tags": [
"databases"
],
"description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"responses": {
"200": {
"description": "UsageDatabase",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageDatabase"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "getUsage",
"group": null,
"weight": 266,
"cookies": false,
"type": "",
"demo": "databases\/get-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "collections.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.getUsage"
},
"methods": [
{
"name": "getUsage",
"namespace": "databases",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"range"
],
"required": [
"databaseId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/usageDatabase"
}
],
"description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"demo": "databases\/get-usage.md",
"public": true,
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.getUsage"
}
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/functions": {
"get": {
"summary": "List functions",
"operationId": "functionsList",
"tags": [
"functions"
],
"description": "Get a list of all the project's functions. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Functions List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/functionList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "list",
"group": "functions",
"weight": 420,
"cookies": false,
"type": "",
"demo": "functions\/list.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"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, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, 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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create function",
"operationId": "functionsCreate",
"tags": [
"functions"
],
"description": "Create a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.",
"responses": {
"201": {
"description": "Function",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/function"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "create",
"group": "functions",
"weight": 417,
"cookies": false,
"type": "",
"demo": "functions\/create.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"functionId": {
"type": "string",
"description": "Function 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.",
"x-example": "<FUNCTION_ID>"
},
"name": {
"type": "string",
"description": "Function name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"runtime": {
"type": "string",
"description": "Execution runtime.",
"x-example": "node-14.5",
"enum": [
"node-14.5",
"node-16.0",
"node-18.0",
"node-19.0",
"node-20.0",
"node-21.0",
"node-22",
"php-8.0",
"php-8.1",
"php-8.2",
"php-8.3",
"ruby-3.0",
"ruby-3.1",
"ruby-3.2",
"ruby-3.3",
"python-3.8",
"python-3.9",
"python-3.10",
"python-3.11",
"python-3.12",
"python-ml-3.11",
"python-ml-3.12",
"deno-1.21",
"deno-1.24",
"deno-1.35",
"deno-1.40",
"deno-1.46",
"deno-2.0",
"dart-2.15",
"dart-2.16",
"dart-2.17",
"dart-2.18",
"dart-2.19",
"dart-3.0",
"dart-3.1",
"dart-3.3",
"dart-3.5",
"dart-3.8",
"dart-3.9",
"dart-3.10",
"dotnet-6.0",
"dotnet-7.0",
"dotnet-8.0",
"java-8.0",
"java-11.0",
"java-17.0",
"java-18.0",
"java-21.0",
"java-22",
"swift-5.5",
"swift-5.8",
"swift-5.9",
"swift-5.10",
"kotlin-1.6",
"kotlin-1.8",
"kotlin-1.9",
"kotlin-2.0",
"cpp-17",
"cpp-20",
"bun-1.0",
"bun-1.1",
"go-1.23",
"static-1",
"flutter-3.24",
"flutter-3.27",
"flutter-3.29",
"flutter-3.32",
"flutter-3.35",
"flutter-3.38"
],
"x-enum-name": null,
"x-enum-keys": []
},
"execute": {
"type": "array",
"description": "An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.",
"x-example": "[\"any\"]",
"items": {
"type": "string"
}
},
"events": {
"type": "array",
"description": "Events list. Maximum of 100 events are allowed.",
"x-example": null,
"items": {
"type": "string"
}
},
"schedule": {
"type": "string",
"description": "Schedule CRON syntax.",
"x-example": null
},
"timeout": {
"type": "integer",
"description": "Function maximum execution time in seconds.",
"x-example": 1,
"format": "int32"
},
"enabled": {
"type": "boolean",
"description": "Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.",
"x-example": false
},
"logging": {
"type": "boolean",
"description": "When disabled, executions will exclude logs and errors, and will be slightly faster.",
"x-example": false
},
"entrypoint": {
"type": "string",
"description": "Entrypoint File. This path is relative to the \"providerRootDirectory\".",
"x-example": "<ENTRYPOINT>"
},
"commands": {
"type": "string",
"description": "Build Commands.",
"x-example": "<COMMANDS>"
},
"scopes": {
"type": "array",
"description": "List of scopes allowed for API key auto-generated for every execution. Maximum of 100 scopes are allowed.",
"x-example": null,
"items": {
"type": "string",
"enum": [
"sessions.write",
"users.read",
"users.write",
"teams.read",
"teams.write",
"databases.read",
"databases.write",
"collections.read",
"collections.write",
"tables.read",
"tables.write",
"attributes.read",
"attributes.write",
"columns.read",
"columns.write",
"indexes.read",
"indexes.write",
"documents.read",
"documents.write",
"rows.read",
"rows.write",
"files.read",
"files.write",
"buckets.read",
"buckets.write",
"functions.read",
"functions.write",
"sites.read",
"sites.write",
"log.read",
"log.write",
"execution.read",
"execution.write",
"locale.read",
"avatars.read",
"health.read",
"providers.read",
"providers.write",
"messages.read",
"messages.write",
"topics.read",
"topics.write",
"subscribers.read",
"subscribers.write",
"targets.read",
"targets.write",
"rules.read",
"rules.write",
"migrations.read",
"migrations.write",
"vcs.read",
"vcs.write",
"assistant.read",
"tokens.read",
"tokens.write"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"installationId": {
"type": "string",
"description": "Appwrite Installation ID for VCS (Version Control System) deployment.",
"x-example": "<INSTALLATION_ID>"
},
"providerRepositoryId": {
"type": "string",
"description": "Repository ID of the repo linked to the function.",
"x-example": "<PROVIDER_REPOSITORY_ID>"
},
"providerBranch": {
"type": "string",
"description": "Production branch for the repo linked to the function.",
"x-example": "<PROVIDER_BRANCH>"
},
"providerSilentMode": {
"type": "boolean",
"description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.",
"x-example": false
},
"providerRootDirectory": {
"type": "string",
"description": "Path to function code in the linked repo.",
"x-example": "<PROVIDER_ROOT_DIRECTORY>"
},
"specification": {
"type": "string",
"description": "Runtime specification for the function and builds.",
"x-example": null
}
},
"required": [
"functionId",
"name",
"runtime"
]
}
}
}
}
}
},
"\/functions\/runtimes": {
"get": {
"summary": "List runtimes",
"operationId": "functionsListRuntimes",
"tags": [
"functions"
],
"description": "Get a list of all runtimes that are currently active on your instance.",
"responses": {
"200": {
"description": "Runtimes List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/runtimeList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listRuntimes",
"group": "runtimes",
"weight": 422,
"cookies": false,
"type": "",
"demo": "functions\/list-runtimes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/functions\/specifications": {
"get": {
"summary": "List specifications",
"operationId": "functionsListSpecifications",
"tags": [
"functions"
],
"description": "List allowed function specifications for this instance.",
"responses": {
"200": {
"description": "Specifications List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/specificationList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listSpecifications",
"group": "runtimes",
"weight": 423,
"cookies": false,
"type": "",
"demo": "functions\/list-specifications.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"server",
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/functions\/templates": {
"get": {
"summary": "List templates",
"operationId": "functionsListTemplates",
"tags": [
"functions"
],
"description": "List available function templates. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.",
"responses": {
"200": {
"description": "Function Templates List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/templateFunctionList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listTemplates",
"group": "templates",
"weight": 446,
"cookies": false,
"type": "",
"demo": "functions\/list-templates.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "runtimes",
"description": "List of runtimes allowed for filtering function templates. Maximum of 100 runtimes are allowed.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"node-14.5",
"node-16.0",
"node-18.0",
"node-19.0",
"node-20.0",
"node-21.0",
"node-22",
"php-8.0",
"php-8.1",
"php-8.2",
"php-8.3",
"ruby-3.0",
"ruby-3.1",
"ruby-3.2",
"ruby-3.3",
"python-3.8",
"python-3.9",
"python-3.10",
"python-3.11",
"python-3.12",
"python-ml-3.11",
"python-ml-3.12",
"deno-1.21",
"deno-1.24",
"deno-1.35",
"deno-1.40",
"deno-1.46",
"deno-2.0",
"dart-2.15",
"dart-2.16",
"dart-2.17",
"dart-2.18",
"dart-2.19",
"dart-3.0",
"dart-3.1",
"dart-3.3",
"dart-3.5",
"dart-3.8",
"dart-3.9",
"dart-3.10",
"dotnet-6.0",
"dotnet-7.0",
"dotnet-8.0",
"java-8.0",
"java-11.0",
"java-17.0",
"java-18.0",
"java-21.0",
"java-22",
"swift-5.5",
"swift-5.8",
"swift-5.9",
"swift-5.10",
"kotlin-1.6",
"kotlin-1.8",
"kotlin-1.9",
"kotlin-2.0",
"cpp-17",
"cpp-20",
"bun-1.0",
"bun-1.1",
"go-1.23",
"static-1",
"flutter-3.24",
"flutter-3.27",
"flutter-3.29",
"flutter-3.32",
"flutter-3.35",
"flutter-3.38"
],
"x-enum-name": null,
"x-enum-keys": []
},
"default": []
},
"in": "query"
},
{
"name": "useCases",
"description": "List of use cases allowed for filtering function templates. Maximum of 100 use cases are allowed.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"starter",
"databases",
"ai",
"messaging",
"utilities",
"dev-tools",
"auth"
],
"x-enum-name": null,
"x-enum-keys": []
},
"default": []
},
"in": "query"
},
{
"name": "limit",
"description": "Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 1,
"default": 25
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned templates. Maximum offset is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 0
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/functions\/templates\/{templateId}": {
"get": {
"summary": "Get function template",
"operationId": "functionsGetTemplate",
"tags": [
"functions"
],
"description": "Get a function template using ID. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.",
"responses": {
"200": {
"description": "Template Function",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/templateFunction"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getTemplate",
"group": "templates",
"weight": 445,
"cookies": false,
"type": "",
"demo": "functions\/get-template.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "templateId",
"description": "Template ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEMPLATE_ID>"
},
"in": "path"
}
]
}
},
"\/functions\/usage": {
"get": {
"summary": "Get functions usage",
"operationId": "functionsListUsage",
"tags": [
"functions"
],
"description": "Get usage metrics and statistics for all functions in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.",
"responses": {
"200": {
"description": "UsageFunctions",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageFunctions"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listUsage",
"group": null,
"weight": 439,
"cookies": false,
"type": "",
"demo": "functions\/list-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/functions\/{functionId}": {
"get": {
"summary": "Get function",
"operationId": "functionsGet",
"tags": [
"functions"
],
"description": "Get a function by its unique ID.",
"responses": {
"200": {
"description": "Function",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/function"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": "functions",
"weight": 418,
"cookies": false,
"type": "",
"demo": "functions\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update function",
"operationId": "functionsUpdate",
"tags": [
"functions"
],
"description": "Update function by its unique ID.",
"responses": {
"200": {
"description": "Function",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/function"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "update",
"group": "functions",
"weight": 419,
"cookies": false,
"type": "",
"demo": "functions\/update.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Function name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"runtime": {
"type": "string",
"description": "Execution runtime.",
"x-example": "node-14.5",
"enum": [
"node-14.5",
"node-16.0",
"node-18.0",
"node-19.0",
"node-20.0",
"node-21.0",
"node-22",
"php-8.0",
"php-8.1",
"php-8.2",
"php-8.3",
"ruby-3.0",
"ruby-3.1",
"ruby-3.2",
"ruby-3.3",
"python-3.8",
"python-3.9",
"python-3.10",
"python-3.11",
"python-3.12",
"python-ml-3.11",
"python-ml-3.12",
"deno-1.21",
"deno-1.24",
"deno-1.35",
"deno-1.40",
"deno-1.46",
"deno-2.0",
"dart-2.15",
"dart-2.16",
"dart-2.17",
"dart-2.18",
"dart-2.19",
"dart-3.0",
"dart-3.1",
"dart-3.3",
"dart-3.5",
"dart-3.8",
"dart-3.9",
"dart-3.10",
"dotnet-6.0",
"dotnet-7.0",
"dotnet-8.0",
"java-8.0",
"java-11.0",
"java-17.0",
"java-18.0",
"java-21.0",
"java-22",
"swift-5.5",
"swift-5.8",
"swift-5.9",
"swift-5.10",
"kotlin-1.6",
"kotlin-1.8",
"kotlin-1.9",
"kotlin-2.0",
"cpp-17",
"cpp-20",
"bun-1.0",
"bun-1.1",
"go-1.23",
"static-1",
"flutter-3.24",
"flutter-3.27",
"flutter-3.29",
"flutter-3.32",
"flutter-3.35",
"flutter-3.38"
],
"x-enum-name": null,
"x-enum-keys": []
},
"execute": {
"type": "array",
"description": "An array of role strings with execution permissions. By default no user is granted with any execute permissions. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.",
"x-example": "[\"any\"]",
"items": {
"type": "string"
}
},
"events": {
"type": "array",
"description": "Events list. Maximum of 100 events are allowed.",
"x-example": null,
"items": {
"type": "string"
}
},
"schedule": {
"type": "string",
"description": "Schedule CRON syntax.",
"x-example": null
},
"timeout": {
"type": "integer",
"description": "Maximum execution time in seconds.",
"x-example": 1,
"format": "int32"
},
"enabled": {
"type": "boolean",
"description": "Is function enabled? When set to 'disabled', users cannot access the function but Server SDKs with and API key can still access the function. No data is lost when this is toggled.",
"x-example": false
},
"logging": {
"type": "boolean",
"description": "When disabled, executions will exclude logs and errors, and will be slightly faster.",
"x-example": false
},
"entrypoint": {
"type": "string",
"description": "Entrypoint File. This path is relative to the \"providerRootDirectory\".",
"x-example": "<ENTRYPOINT>"
},
"commands": {
"type": "string",
"description": "Build Commands.",
"x-example": "<COMMANDS>"
},
"scopes": {
"type": "array",
"description": "List of scopes allowed for API Key auto-generated for every execution. Maximum of 100 scopes are allowed.",
"x-example": null,
"items": {
"type": "string",
"enum": [
"sessions.write",
"users.read",
"users.write",
"teams.read",
"teams.write",
"databases.read",
"databases.write",
"collections.read",
"collections.write",
"tables.read",
"tables.write",
"attributes.read",
"attributes.write",
"columns.read",
"columns.write",
"indexes.read",
"indexes.write",
"documents.read",
"documents.write",
"rows.read",
"rows.write",
"files.read",
"files.write",
"buckets.read",
"buckets.write",
"functions.read",
"functions.write",
"sites.read",
"sites.write",
"log.read",
"log.write",
"execution.read",
"execution.write",
"locale.read",
"avatars.read",
"health.read",
"providers.read",
"providers.write",
"messages.read",
"messages.write",
"topics.read",
"topics.write",
"subscribers.read",
"subscribers.write",
"targets.read",
"targets.write",
"rules.read",
"rules.write",
"migrations.read",
"migrations.write",
"vcs.read",
"vcs.write",
"assistant.read",
"tokens.read",
"tokens.write"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"installationId": {
"type": "string",
"description": "Appwrite Installation ID for VCS (Version Controle System) deployment.",
"x-example": "<INSTALLATION_ID>"
},
"providerRepositoryId": {
"type": "string",
"description": "Repository ID of the repo linked to the function",
"x-example": "<PROVIDER_REPOSITORY_ID>",
"x-nullable": true
},
"providerBranch": {
"type": "string",
"description": "Production branch for the repo linked to the function",
"x-example": "<PROVIDER_BRANCH>"
},
"providerSilentMode": {
"type": "boolean",
"description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the function? In silent mode, comments will not be made on commits and pull requests.",
"x-example": false
},
"providerRootDirectory": {
"type": "string",
"description": "Path to function code in the linked repo.",
"x-example": "<PROVIDER_ROOT_DIRECTORY>"
},
"specification": {
"type": "string",
"description": "Runtime specification for the function and builds.",
"x-example": null
}
},
"required": [
"name"
]
}
}
}
}
},
"delete": {
"summary": "Delete function",
"operationId": "functionsDelete",
"tags": [
"functions"
],
"description": "Delete a function by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "functions",
"weight": 421,
"cookies": false,
"type": "",
"demo": "functions\/delete.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
]
}
},
"\/functions\/{functionId}\/deployment": {
"patch": {
"summary": "Update function's deployment",
"operationId": "functionsUpdateFunctionDeployment",
"tags": [
"functions"
],
"description": "Update the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.",
"responses": {
"200": {
"description": "Function",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/function"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateFunctionDeployment",
"group": "functions",
"weight": 426,
"cookies": false,
"type": "",
"demo": "functions\/update-function-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"deploymentId": {
"type": "string",
"description": "Deployment ID.",
"x-example": "<DEPLOYMENT_ID>"
}
},
"required": [
"deploymentId"
]
}
}
}
}
}
},
"\/functions\/{functionId}\/deployments": {
"get": {
"summary": "List deployments",
"operationId": "functionsListDeployments",
"tags": [
"functions"
],
"description": "Get a list of all the function's code deployments. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Deployments List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deploymentList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listDeployments",
"group": "deployments",
"weight": 427,
"cookies": false,
"type": "",
"demo": "functions\/list-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"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: buildSize, sourceSize, totalSize, buildDuration, status, activate, type",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create deployment",
"operationId": "functionsCreateDeployment",
"tags": [
"functions"
],
"description": "Create a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.",
"responses": {
"202": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createDeployment",
"group": "deployments",
"weight": 424,
"cookies": false,
"type": "upload",
"demo": "functions\/create-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": true,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"multipart\/form-data": {
"schema": {
"type": "object",
"properties": {
"entrypoint": {
"type": "string",
"description": "Entrypoint File.",
"x-example": "<ENTRYPOINT>",
"x-nullable": true
},
"commands": {
"type": "string",
"description": "Build Commands.",
"x-example": "<COMMANDS>",
"x-nullable": true
},
"code": {
"type": "string",
"description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.",
"x-example": null,
"format": "binary"
},
"activate": {
"type": "boolean",
"description": "Automatically activate the deployment when it is finished building.",
"x-example": false
}
},
"required": [
"code",
"activate"
]
}
}
}
}
}
},
"\/functions\/{functionId}\/deployments\/duplicate": {
"post": {
"summary": "Create duplicate deployment",
"operationId": "functionsCreateDuplicateDeployment",
"tags": [
"functions"
],
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"responses": {
"202": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createDuplicateDeployment",
"group": "deployments",
"weight": 432,
"cookies": false,
"type": "",
"demo": "functions\/create-duplicate-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"deploymentId": {
"type": "string",
"description": "Deployment ID.",
"x-example": "<DEPLOYMENT_ID>"
},
"buildId": {
"type": "string",
"description": "Build unique ID.",
"x-example": "<BUILD_ID>"
}
},
"required": [
"deploymentId"
]
}
}
}
}
}
},
"\/functions\/{functionId}\/deployments\/template": {
"post": {
"summary": "Create template deployment",
"operationId": "functionsCreateTemplateDeployment",
"tags": [
"functions"
],
"description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/functions\/templates) to find the template details.",
"responses": {
"202": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTemplateDeployment",
"group": "deployments",
"weight": 429,
"cookies": false,
"type": "",
"demo": "functions\/create-template-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"repository": {
"type": "string",
"description": "Repository name of the template.",
"x-example": "<REPOSITORY>"
},
"owner": {
"type": "string",
"description": "The name of the owner of the template.",
"x-example": "<OWNER>"
},
"rootDirectory": {
"type": "string",
"description": "Path to function code in the template repo.",
"x-example": "<ROOT_DIRECTORY>"
},
"type": {
"type": "string",
"description": "Type for the reference provided. Can be commit, branch, or tag",
"x-example": "commit",
"enum": [
"commit",
"branch",
"tag"
],
"x-enum-name": "TemplateReferenceType",
"x-enum-keys": []
},
"reference": {
"type": "string",
"description": "Reference value, can be a commit hash, branch name, or release tag",
"x-example": "<REFERENCE>"
},
"activate": {
"type": "boolean",
"description": "Automatically activate the deployment when it is finished building.",
"x-example": false
}
},
"required": [
"repository",
"owner",
"rootDirectory",
"type",
"reference"
]
}
}
}
}
}
},
"\/functions\/{functionId}\/deployments\/vcs": {
"post": {
"summary": "Create VCS deployment",
"operationId": "functionsCreateVcsDeployment",
"tags": [
"functions"
],
"description": "Create a deployment when a function is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.",
"responses": {
"202": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createVcsDeployment",
"group": "deployments",
"weight": 430,
"cookies": false,
"type": "",
"demo": "functions\/create-vcs-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of reference passed. Allowed values are: branch, commit",
"x-example": "branch",
"enum": [
"branch",
"commit"
],
"x-enum-name": "VCSReferenceType",
"x-enum-keys": []
},
"reference": {
"type": "string",
"description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash",
"x-example": "<REFERENCE>"
},
"activate": {
"type": "boolean",
"description": "Automatically activate the deployment when it is finished building.",
"x-example": false
}
},
"required": [
"type",
"reference"
]
}
}
}
}
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}": {
"get": {
"summary": "Get deployment",
"operationId": "functionsGetDeployment",
"tags": [
"functions"
],
"description": "Get a function deployment by its unique ID.",
"responses": {
"200": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getDeployment",
"group": "deployments",
"weight": 425,
"cookies": false,
"type": "",
"demo": "functions\/get-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete deployment",
"operationId": "functionsDeleteDeployment",
"tags": [
"functions"
],
"description": "Delete a code deployment by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteDeployment",
"group": "deployments",
"weight": 428,
"cookies": false,
"type": "",
"demo": "functions\/delete-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
]
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}\/download": {
"get": {
"summary": "Get deployment download",
"operationId": "functionsGetDeploymentDownload",
"tags": [
"functions"
],
"description": "Get a function deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.",
"responses": {
"200": {
"description": "File"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getDeploymentDownload",
"group": "deployments",
"weight": 431,
"cookies": false,
"type": "location",
"demo": "functions\/get-deployment-download.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"console",
"server",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
},
{
"name": "type",
"description": "Deployment file to download. Can be: \"source\", \"output\".",
"required": false,
"schema": {
"type": "string",
"x-example": "source",
"enum": [
"source",
"output"
],
"x-enum-name": "DeploymentDownloadType",
"x-enum-keys": [],
"default": "source"
},
"in": "query"
}
]
}
},
"\/functions\/{functionId}\/deployments\/{deploymentId}\/status": {
"patch": {
"summary": "Update deployment status",
"operationId": "functionsUpdateDeploymentStatus",
"tags": [
"functions"
],
"description": "Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.",
"responses": {
"200": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateDeploymentStatus",
"group": "deployments",
"weight": 433,
"cookies": false,
"type": "",
"demo": "functions\/update-deployment-status.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
]
}
},
"\/functions\/{functionId}\/executions": {
"get": {
"summary": "List executions",
"operationId": "functionsListExecutions",
"tags": [
"functions"
],
"description": "Get a list of all the current user function execution logs. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Executions List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/executionList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listExecutions",
"group": "executions",
"weight": 436,
"cookies": false,
"type": "",
"demo": "functions\/list-executions.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "execution.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create execution",
"operationId": "functionsCreateExecution",
"tags": [
"functions"
],
"description": "Trigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.",
"responses": {
"201": {
"description": "Execution",
"content": {
"multipart\/form-data": {
"schema": {
"$ref": "#\/components\/schemas\/execution"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createExecution",
"group": "executions",
"weight": 434,
"cookies": false,
"type": "",
"demo": "functions\/create-execution.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "execution.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"body": {
"type": "string",
"description": "HTTP body of execution. Default value is empty string.",
"x-example": "<BODY>"
},
"async": {
"type": "boolean",
"description": "Execute code in the background. Default value is false.",
"x-example": false
},
"path": {
"type": "string",
"description": "HTTP path of execution. Path can include query params. Default value is \/",
"x-example": "<PATH>"
},
"method": {
"type": "string",
"description": "HTTP method of execution. Default value is POST.",
"x-example": "GET",
"enum": [
"GET",
"POST",
"PUT",
"PATCH",
"DELETE",
"OPTIONS",
"HEAD"
],
"x-enum-name": "ExecutionMethod",
"x-enum-keys": []
},
"headers": {
"type": "object",
"description": "HTTP headers of execution. Defaults to empty.",
"x-example": "{}"
},
"scheduledAt": {
"type": "string",
"description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.",
"x-example": "<SCHEDULED_AT>",
"x-nullable": true
}
}
}
}
}
}
}
},
"\/functions\/{functionId}\/executions\/{executionId}": {
"get": {
"summary": "Get execution",
"operationId": "functionsGetExecution",
"tags": [
"functions"
],
"description": "Get a function execution log by its unique ID.",
"responses": {
"200": {
"description": "Execution",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/execution"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getExecution",
"group": "executions",
"weight": 435,
"cookies": false,
"type": "",
"demo": "functions\/get-execution.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "execution.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "executionId",
"description": "Execution ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<EXECUTION_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete execution",
"operationId": "functionsDeleteExecution",
"tags": [
"functions"
],
"description": "Delete a function execution by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteExecution",
"group": "executions",
"weight": 437,
"cookies": false,
"type": "",
"demo": "functions\/delete-execution.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "execution.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "executionId",
"description": "Execution ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<EXECUTION_ID>"
},
"in": "path"
}
]
}
},
"\/functions\/{functionId}\/usage": {
"get": {
"summary": "Get function usage",
"operationId": "functionsGetUsage",
"tags": [
"functions"
],
"description": "Get usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.",
"responses": {
"200": {
"description": "UsageFunction",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageFunction"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
"weight": 438,
"cookies": false,
"type": "",
"demo": "functions\/get-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/functions\/{functionId}\/variables": {
"get": {
"summary": "List variables",
"operationId": "functionsListVariables",
"tags": [
"functions"
],
"description": "Get a list of all variables of a specific function.",
"responses": {
"200": {
"description": "Variables List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variableList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listVariables",
"group": "variables",
"weight": 442,
"cookies": false,
"type": "",
"demo": "functions\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
]
},
"post": {
"summary": "Create variable",
"operationId": "functionsCreateVariable",
"tags": [
"functions"
],
"description": "Create a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"responses": {
"201": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createVariable",
"group": "variables",
"weight": 440,
"cookies": false,
"type": "",
"demo": "functions\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Variable key. Max length: 255 chars.",
"x-example": "<KEY>"
},
"value": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"x-example": "<VALUE>"
},
"secret": {
"type": "boolean",
"description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.",
"x-example": false
}
},
"required": [
"key",
"value"
]
}
}
}
}
}
},
"\/functions\/{functionId}\/variables\/{variableId}": {
"get": {
"summary": "Get variable",
"operationId": "functionsGetVariable",
"tags": [
"functions"
],
"description": "Get a variable by its unique ID.",
"responses": {
"200": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getVariable",
"group": "variables",
"weight": 441,
"cookies": false,
"type": "",
"demo": "functions\/get-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "variableId",
"description": "Variable unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<VARIABLE_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update variable",
"operationId": "functionsUpdateVariable",
"tags": [
"functions"
],
"description": "Update variable by its unique ID.",
"responses": {
"200": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
"weight": 443,
"cookies": false,
"type": "",
"demo": "functions\/update-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "variableId",
"description": "Variable unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<VARIABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Variable key. Max length: 255 chars.",
"x-example": "<KEY>"
},
"value": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"x-example": "<VALUE>",
"x-nullable": true
},
"secret": {
"type": "boolean",
"description": "Secret variables can be updated or deleted, but only functions can read them during build and runtime.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"key"
]
}
}
}
}
},
"delete": {
"summary": "Delete variable",
"operationId": "functionsDeleteVariable",
"tags": [
"functions"
],
"description": "Delete a variable by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
"weight": 444,
"cookies": false,
"type": "",
"demo": "functions\/delete-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "functions.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "functionId",
"description": "Function unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FUNCTION_ID>"
},
"in": "path"
},
{
"name": "variableId",
"description": "Variable unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<VARIABLE_ID>"
},
"in": "path"
}
]
}
},
"\/graphql": {
"post": {
"summary": "GraphQL endpoint",
"operationId": "graphqlQuery",
"tags": [
"graphql"
],
"description": "Execute a GraphQL mutation.",
"responses": {
"200": {
"description": "Any",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/any"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "query",
"group": "graphql",
"weight": 176,
"cookies": false,
"type": "graphql",
"demo": "graphql\/query.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "url:{url},ip:{ip}",
"scope": "graphql",
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
]
}
},
"\/graphql\/mutation": {
"post": {
"summary": "GraphQL endpoint",
"operationId": "graphqlMutation",
"tags": [
"graphql"
],
"description": "Execute a GraphQL mutation.",
"responses": {
"200": {
"description": "Any",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/any"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "mutation",
"group": "graphql",
"weight": 175,
"cookies": false,
"type": "graphql",
"demo": "graphql\/mutation.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "url:{url},ip:{ip}",
"scope": "graphql",
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
]
}
},
"\/health": {
"get": {
"summary": "Get HTTP",
"operationId": "healthGet",
"tags": [
"health"
],
"description": "Check the Appwrite HTTP server is up and responsive.",
"responses": {
"200": {
"description": "Health Status",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthStatus"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": "health",
"weight": 447,
"cookies": false,
"type": "",
"demo": "health\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/health\/anti-virus": {
"get": {
"summary": "Get antivirus",
"operationId": "healthGetAntivirus",
"tags": [
"health"
],
"description": "Check the Appwrite Antivirus server is up and connection is successful.",
"responses": {
"200": {
"description": "Health Antivirus",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthAntivirus"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getAntivirus",
"group": "health",
"weight": 456,
"cookies": false,
"type": "",
"demo": "health\/get-antivirus.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/health\/cache": {
"get": {
"summary": "Get cache",
"operationId": "healthGetCache",
"tags": [
"health"
],
"description": "Check the Appwrite in-memory cache servers are up and connection is successful.",
"responses": {
"200": {
"description": "Status List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthStatusList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getCache",
"group": "health",
"weight": 450,
"cookies": false,
"type": "",
"demo": "health\/get-cache.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/health\/certificate": {
"get": {
"summary": "Get the SSL certificate for a domain",
"operationId": "healthGetCertificate",
"tags": [
"health"
],
"description": "Get the SSL certificate for a domain",
"responses": {
"200": {
"description": "Health Certificate",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthCertificate"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getCertificate",
"group": "health",
"weight": 453,
"cookies": false,
"type": "",
"demo": "health\/get-certificate.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "domain",
"description": "string",
"required": false,
"schema": {
"type": "string"
},
"in": "query"
}
]
}
},
"\/health\/db": {
"get": {
"summary": "Get DB",
"operationId": "healthGetDB",
"tags": [
"health"
],
"description": "Check the Appwrite database servers are up and connection is successful.",
"responses": {
"200": {
"description": "Status List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthStatusList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getDB",
"group": "health",
"weight": 449,
"cookies": false,
"type": "",
"demo": "health\/get-db.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/health\/pubsub": {
"get": {
"summary": "Get pubsub",
"operationId": "healthGetPubSub",
"tags": [
"health"
],
"description": "Check the Appwrite pub-sub servers are up and connection is successful.",
"responses": {
"200": {
"description": "Status List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthStatusList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getPubSub",
"group": "health",
"weight": 451,
"cookies": false,
"type": "",
"demo": "health\/get-pub-sub.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/health\/queue\/audits": {
"get": {
"summary": "Get audits queue",
"operationId": "healthGetQueueAudits",
"tags": [
"health"
],
"description": "Get the number of audit logs that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueAudits",
"group": "queue",
"weight": 457,
"cookies": false,
"type": "",
"demo": "health\/get-queue-audits.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-audits.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/builds": {
"get": {
"summary": "Get builds queue",
"operationId": "healthGetQueueBuilds",
"tags": [
"health"
],
"description": "Get the number of builds that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueBuilds",
"group": "queue",
"weight": 461,
"cookies": false,
"type": "",
"demo": "health\/get-queue-builds.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/certificates": {
"get": {
"summary": "Get certificates queue",
"operationId": "healthGetQueueCertificates",
"tags": [
"health"
],
"description": "Get the number of certificates that are waiting to be issued against [Letsencrypt](https:\/\/letsencrypt.org\/) in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueCertificates",
"group": "queue",
"weight": 460,
"cookies": false,
"type": "",
"demo": "health\/get-queue-certificates.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/databases": {
"get": {
"summary": "Get databases queue",
"operationId": "healthGetQueueDatabases",
"tags": [
"health"
],
"description": "Get the number of database changes that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueDatabases",
"group": "queue",
"weight": 462,
"cookies": false,
"type": "",
"demo": "health\/get-queue-databases.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "name",
"description": "Queue name for which to check the queue size",
"required": false,
"schema": {
"type": "string",
"x-example": "<NAME>",
"default": "database_db_main"
},
"in": "query"
},
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/deletes": {
"get": {
"summary": "Get deletes queue",
"operationId": "healthGetQueueDeletes",
"tags": [
"health"
],
"description": "Get the number of background destructive changes that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueDeletes",
"group": "queue",
"weight": 463,
"cookies": false,
"type": "",
"demo": "health\/get-queue-deletes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/failed\/{name}": {
"get": {
"summary": "Get number of failed queue jobs",
"operationId": "healthGetFailedJobs",
"tags": [
"health"
],
"description": "Returns the amount of failed jobs in a given queue.\n",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getFailedJobs",
"group": "queue",
"weight": 470,
"cookies": false,
"type": "",
"demo": "health\/get-failed-jobs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "name",
"description": "The name of the queue",
"required": true,
"schema": {
"type": "string",
"x-example": "v1-database",
"enum": [
"v1-database",
"v1-deletes",
"v1-audits",
"v1-mails",
"v1-functions",
"v1-stats-resources",
"v1-stats-usage",
"v1-webhooks",
"v1-certificates",
"v1-builds",
"v1-screenshots",
"v1-messaging",
"v1-migrations"
],
"x-enum-name": null,
"x-enum-keys": []
},
"in": "path"
},
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/functions": {
"get": {
"summary": "Get functions queue",
"operationId": "healthGetQueueFunctions",
"tags": [
"health"
],
"description": "Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueFunctions",
"group": "queue",
"weight": 467,
"cookies": false,
"type": "",
"demo": "health\/get-queue-functions.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/logs": {
"get": {
"summary": "Get logs queue",
"operationId": "healthGetQueueLogs",
"tags": [
"health"
],
"description": "Get the number of logs that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueLogs",
"group": "queue",
"weight": 459,
"cookies": false,
"type": "",
"demo": "health\/get-queue-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/mails": {
"get": {
"summary": "Get mails queue",
"operationId": "healthGetQueueMails",
"tags": [
"health"
],
"description": "Get the number of mails that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueMails",
"group": "queue",
"weight": 464,
"cookies": false,
"type": "",
"demo": "health\/get-queue-mails.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/messaging": {
"get": {
"summary": "Get messaging queue",
"operationId": "healthGetQueueMessaging",
"tags": [
"health"
],
"description": "Get the number of messages that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueMessaging",
"group": "queue",
"weight": 465,
"cookies": false,
"type": "",
"demo": "health\/get-queue-messaging.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/migrations": {
"get": {
"summary": "Get migrations queue",
"operationId": "healthGetQueueMigrations",
"tags": [
"health"
],
"description": "Get the number of migrations that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueMigrations",
"group": "queue",
"weight": 466,
"cookies": false,
"type": "",
"demo": "health\/get-queue-migrations.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/stats-resources": {
"get": {
"summary": "Get stats resources queue",
"operationId": "healthGetQueueStatsResources",
"tags": [
"health"
],
"description": "Get the number of metrics that are waiting to be processed in the Appwrite stats resources queue.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueStatsResources",
"group": "queue",
"weight": 468,
"cookies": false,
"type": "",
"demo": "health\/get-queue-stats-resources.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-stats-resources.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/stats-usage": {
"get": {
"summary": "Get stats usage queue",
"operationId": "healthGetQueueUsage",
"tags": [
"health"
],
"description": "Get the number of metrics that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueUsage",
"group": "queue",
"weight": 469,
"cookies": false,
"type": "",
"demo": "health\/get-queue-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-stats-usage.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/queue\/webhooks": {
"get": {
"summary": "Get webhooks queue",
"operationId": "healthGetQueueWebhooks",
"tags": [
"health"
],
"description": "Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.",
"responses": {
"200": {
"description": "Health Queue",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthQueue"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getQueueWebhooks",
"group": "queue",
"weight": 458,
"cookies": false,
"type": "",
"demo": "health\/get-queue-webhooks.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "threshold",
"description": "Queue size threshold. When hit (equal or higher), endpoint returns server error. Default value is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5000
},
"in": "query"
}
]
}
},
"\/health\/storage": {
"get": {
"summary": "Get storage",
"operationId": "healthGetStorage",
"tags": [
"health"
],
"description": "Check the Appwrite storage device is up and connection is successful.",
"responses": {
"200": {
"description": "Health Status",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthStatus"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getStorage",
"group": "storage",
"weight": 455,
"cookies": false,
"type": "",
"demo": "health\/get-storage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/health\/storage\/local": {
"get": {
"summary": "Get local storage",
"operationId": "healthGetStorageLocal",
"tags": [
"health"
],
"description": "Check the Appwrite local storage device is up and connection is successful.",
"responses": {
"200": {
"description": "Health Status",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthStatus"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getStorageLocal",
"group": "storage",
"weight": 454,
"cookies": false,
"type": "",
"demo": "health\/get-storage-local.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/health\/time": {
"get": {
"summary": "Get time",
"operationId": "healthGetTime",
"tags": [
"health"
],
"description": "Check the Appwrite server time is synced with Google remote NTP server. We use this technology to smoothly handle leap seconds with no disruptive events. The [Network Time Protocol](https:\/\/en.wikipedia.org\/wiki\/Network_Time_Protocol) (NTP) is used by hundreds of millions of computers and devices to synchronize their clocks over the Internet. If your computer sets its own clock, it likely uses NTP.",
"responses": {
"200": {
"description": "Health Time",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/healthTime"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getTime",
"group": "health",
"weight": 452,
"cookies": false,
"type": "",
"demo": "health\/get-time.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "health.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/locale": {
"get": {
"summary": "Get user locale",
"operationId": "localeGet",
"tags": [
"locale"
],
"description": "Get the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested currency. You can use the locale header to get the data in a supported language.\n\n([IP Geolocation by DB-IP](https:\/\/db-ip.com))",
"responses": {
"200": {
"description": "Locale",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/locale"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": null,
"weight": 49,
"cookies": false,
"type": "",
"demo": "locale\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "locale.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
]
}
},
"\/locale\/codes": {
"get": {
"summary": "List locale codes",
"operationId": "localeListCodes",
"tags": [
"locale"
],
"description": "List of all locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes).",
"responses": {
"200": {
"description": "Locale codes list",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/localeCodeList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listCodes",
"group": null,
"weight": 50,
"cookies": false,
"type": "",
"demo": "locale\/list-codes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "locale.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
]
}
},
"\/locale\/continents": {
"get": {
"summary": "List continents",
"operationId": "localeListContinents",
"tags": [
"locale"
],
"description": "List of all continents. You can use the locale header to get the data in a supported language.",
"responses": {
"200": {
"description": "Continents List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/continentList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listContinents",
"group": null,
"weight": 54,
"cookies": false,
"type": "",
"demo": "locale\/list-continents.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "locale.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
]
}
},
"\/locale\/countries": {
"get": {
"summary": "List countries",
"operationId": "localeListCountries",
"tags": [
"locale"
],
"description": "List of all countries. You can use the locale header to get the data in a supported language.",
"responses": {
"200": {
"description": "Countries List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/countryList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listCountries",
"group": null,
"weight": 51,
"cookies": false,
"type": "",
"demo": "locale\/list-countries.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "locale.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
]
}
},
"\/locale\/countries\/eu": {
"get": {
"summary": "List EU countries",
"operationId": "localeListCountriesEU",
"tags": [
"locale"
],
"description": "List of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.",
"responses": {
"200": {
"description": "Countries List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/countryList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listCountriesEU",
"group": null,
"weight": 52,
"cookies": false,
"type": "",
"demo": "locale\/list-countries-eu.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "locale.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
]
}
},
"\/locale\/countries\/phones": {
"get": {
"summary": "List countries phone codes",
"operationId": "localeListCountriesPhones",
"tags": [
"locale"
],
"description": "List of all countries phone codes. You can use the locale header to get the data in a supported language.",
"responses": {
"200": {
"description": "Phones List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/phoneList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listCountriesPhones",
"group": null,
"weight": 53,
"cookies": false,
"type": "",
"demo": "locale\/list-countries-phones.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "locale.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
]
}
},
"\/locale\/currencies": {
"get": {
"summary": "List currencies",
"operationId": "localeListCurrencies",
"tags": [
"locale"
],
"description": "List of all currencies, including currency symbol, name, plural, and decimal digits for all major and minor currencies. You can use the locale header to get the data in a supported language.",
"responses": {
"200": {
"description": "Currencies List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/currencyList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listCurrencies",
"group": null,
"weight": 55,
"cookies": false,
"type": "",
"demo": "locale\/list-currencies.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "locale.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
]
}
},
"\/locale\/languages": {
"get": {
"summary": "List languages",
"operationId": "localeListLanguages",
"tags": [
"locale"
],
"description": "List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.",
"responses": {
"200": {
"description": "Languages List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/languageList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listLanguages",
"group": null,
"weight": 56,
"cookies": false,
"type": "",
"demo": "locale\/list-languages.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "locale.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
]
}
},
"\/messaging\/messages": {
"get": {
"summary": "List messages",
"operationId": "messagingListMessages",
"tags": [
"messaging"
],
"description": "Get a list of all messages from the current Appwrite project.",
"responses": {
"200": {
"description": "Message list",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/messageList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listMessages",
"group": "messages",
"weight": 231,
"cookies": false,
"type": "",
"demo": "messaging\/list-messages.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md",
"auth": {
"Project": []
}
},
"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: scheduledAt, deliveredAt, deliveredTotal, status, description, providerType",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/messaging\/messages\/email": {
"post": {
"summary": "Create email",
"operationId": "messagingCreateEmail",
"tags": [
"messaging"
],
"description": "Create a new email message.",
"responses": {
"201": {
"description": "Message",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/message"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createEmail",
"group": "messages",
"weight": 228,
"cookies": false,
"type": "",
"demo": "messaging\/create-email.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"messageId": {
"type": "string",
"description": "Message 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.",
"x-example": "<MESSAGE_ID>"
},
"subject": {
"type": "string",
"description": "Email Subject.",
"x-example": "<SUBJECT>"
},
"content": {
"type": "string",
"description": "Email Content.",
"x-example": "<CONTENT>"
},
"topics": {
"type": "array",
"description": "List of Topic IDs.",
"x-example": null,
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"description": "List of User IDs.",
"x-example": null,
"items": {
"type": "string"
}
},
"targets": {
"type": "array",
"description": "List of Targets IDs.",
"x-example": null,
"items": {
"type": "string"
}
},
"cc": {
"type": "array",
"description": "Array of target IDs to be added as CC.",
"x-example": null,
"items": {
"type": "string"
}
},
"bcc": {
"type": "array",
"description": "Array of target IDs to be added as BCC.",
"x-example": null,
"items": {
"type": "string"
}
},
"attachments": {
"type": "array",
"description": "Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.",
"x-example": null,
"items": {
"type": "string"
}
},
"draft": {
"type": "boolean",
"description": "Is message a draft",
"x-example": false
},
"html": {
"type": "boolean",
"description": "Is content of type HTML",
"x-example": false
},
"scheduledAt": {
"type": "string",
"description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"messageId",
"subject",
"content"
]
}
}
}
}
}
},
"\/messaging\/messages\/email\/{messageId}": {
"patch": {
"summary": "Update email",
"operationId": "messagingUpdateEmail",
"tags": [
"messaging"
],
"description": "Update an email message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.\n",
"responses": {
"200": {
"description": "Message",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/message"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateEmail",
"group": "messages",
"weight": 235,
"cookies": false,
"type": "",
"demo": "messaging\/update-email.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "messageId",
"description": "Message ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MESSAGE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"topics": {
"type": "array",
"description": "List of Topic IDs.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"users": {
"type": "array",
"description": "List of User IDs.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"targets": {
"type": "array",
"description": "List of Targets IDs.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"subject": {
"type": "string",
"description": "Email Subject.",
"x-example": "<SUBJECT>",
"x-nullable": true
},
"content": {
"type": "string",
"description": "Email Content.",
"x-example": "<CONTENT>",
"x-nullable": true
},
"draft": {
"type": "boolean",
"description": "Is message a draft",
"x-example": false,
"x-nullable": true
},
"html": {
"type": "boolean",
"description": "Is content of type HTML",
"x-example": false,
"x-nullable": true
},
"cc": {
"type": "array",
"description": "Array of target IDs to be added as CC.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"bcc": {
"type": "array",
"description": "Array of target IDs to be added as BCC.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"scheduledAt": {
"type": "string",
"description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.",
"x-example": null,
"x-nullable": true
},
"attachments": {
"type": "array",
"description": "Array of compound ID strings of bucket IDs and file IDs to be attached to the email. They should be formatted as <BUCKET_ID>:<FILE_ID>.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
}
}
}
}
}
}
}
},
"\/messaging\/messages\/push": {
"post": {
"summary": "Create push notification",
"operationId": "messagingCreatePush",
"tags": [
"messaging"
],
"description": "Create a new push notification.",
"responses": {
"201": {
"description": "Message",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/message"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createPush",
"group": "messages",
"weight": 230,
"cookies": false,
"type": "",
"demo": "messaging\/create-push.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"messageId": {
"type": "string",
"description": "Message 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.",
"x-example": "<MESSAGE_ID>"
},
"title": {
"type": "string",
"description": "Title for push notification.",
"x-example": "<TITLE>"
},
"body": {
"type": "string",
"description": "Body for push notification.",
"x-example": "<BODY>"
},
"topics": {
"type": "array",
"description": "List of Topic IDs.",
"x-example": null,
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"description": "List of User IDs.",
"x-example": null,
"items": {
"type": "string"
}
},
"targets": {
"type": "array",
"description": "List of Targets IDs.",
"x-example": null,
"items": {
"type": "string"
}
},
"data": {
"type": "object",
"description": "Additional key-value pair data for push notification.",
"x-example": "{}",
"x-nullable": true
},
"action": {
"type": "string",
"description": "Action for push notification.",
"x-example": "<ACTION>"
},
"image": {
"type": "string",
"description": "Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.",
"x-example": "<ID1:ID2>"
},
"icon": {
"type": "string",
"description": "Icon for push notification. Available only for Android and Web Platform.",
"x-example": "<ICON>"
},
"sound": {
"type": "string",
"description": "Sound for push notification. Available only for Android and iOS Platform.",
"x-example": "<SOUND>"
},
"color": {
"type": "string",
"description": "Color for push notification. Available only for Android Platform.",
"x-example": "<COLOR>"
},
"tag": {
"type": "string",
"description": "Tag for push notification. Available only for Android Platform.",
"x-example": "<TAG>"
},
"badge": {
"type": "integer",
"description": "Badge for push notification. Available only for iOS Platform.",
"x-example": null,
"format": "int32"
},
"draft": {
"type": "boolean",
"description": "Is message a draft",
"x-example": false
},
"scheduledAt": {
"type": "string",
"description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.",
"x-example": null,
"x-nullable": true
},
"contentAvailable": {
"type": "boolean",
"description": "If set to true, the notification will be delivered in the background. Available only for iOS Platform.",
"x-example": false
},
"critical": {
"type": "boolean",
"description": "If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.",
"x-example": false
},
"priority": {
"type": "string",
"description": "Set the notification priority. \"normal\" will consider device state and may not deliver notifications immediately. \"high\" will always attempt to immediately deliver the notification.",
"x-example": "normal",
"enum": [
"normal",
"high"
],
"x-enum-name": "MessagePriority",
"x-enum-keys": []
}
},
"required": [
"messageId"
]
}
}
}
}
}
},
"\/messaging\/messages\/push\/{messageId}": {
"patch": {
"summary": "Update push notification",
"operationId": "messagingUpdatePush",
"tags": [
"messaging"
],
"description": "Update a push notification by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.\n",
"responses": {
"200": {
"description": "Message",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/message"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePush",
"group": "messages",
"weight": 237,
"cookies": false,
"type": "",
"demo": "messaging\/update-push.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "messageId",
"description": "Message ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MESSAGE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"topics": {
"type": "array",
"description": "List of Topic IDs.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"users": {
"type": "array",
"description": "List of User IDs.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"targets": {
"type": "array",
"description": "List of Targets IDs.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"title": {
"type": "string",
"description": "Title for push notification.",
"x-example": "<TITLE>",
"x-nullable": true
},
"body": {
"type": "string",
"description": "Body for push notification.",
"x-example": "<BODY>",
"x-nullable": true
},
"data": {
"type": "object",
"description": "Additional Data for push notification.",
"x-example": "{}",
"x-nullable": true
},
"action": {
"type": "string",
"description": "Action for push notification.",
"x-example": "<ACTION>",
"x-nullable": true
},
"image": {
"type": "string",
"description": "Image for push notification. Must be a compound bucket ID to file ID of a jpeg, png, or bmp image in Appwrite Storage. It should be formatted as <BUCKET_ID>:<FILE_ID>.",
"x-example": "<ID1:ID2>",
"x-nullable": true
},
"icon": {
"type": "string",
"description": "Icon for push notification. Available only for Android and Web platforms.",
"x-example": "<ICON>",
"x-nullable": true
},
"sound": {
"type": "string",
"description": "Sound for push notification. Available only for Android and iOS platforms.",
"x-example": "<SOUND>",
"x-nullable": true
},
"color": {
"type": "string",
"description": "Color for push notification. Available only for Android platforms.",
"x-example": "<COLOR>",
"x-nullable": true
},
"tag": {
"type": "string",
"description": "Tag for push notification. Available only for Android platforms.",
"x-example": "<TAG>",
"x-nullable": true
},
"badge": {
"type": "integer",
"description": "Badge for push notification. Available only for iOS platforms.",
"x-example": null,
"format": "int32",
"x-nullable": true
},
"draft": {
"type": "boolean",
"description": "Is message a draft",
"x-example": false,
"x-nullable": true
},
"scheduledAt": {
"type": "string",
"description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.",
"x-example": null,
"x-nullable": true
},
"contentAvailable": {
"type": "boolean",
"description": "If set to true, the notification will be delivered in the background. Available only for iOS Platform.",
"x-example": false,
"x-nullable": true
},
"critical": {
"type": "boolean",
"description": "If set to true, the notification will be marked as critical. This requires the app to have the critical notification entitlement. Available only for iOS Platform.",
"x-example": false,
"x-nullable": true
},
"priority": {
"type": "string",
"description": "Set the notification priority. \"normal\" will consider device battery state and may send notifications later. \"high\" will always attempt to immediately deliver the notification.",
"x-example": "normal",
"enum": [
"normal",
"high"
],
"x-enum-name": "MessagePriority",
"x-enum-keys": [],
"x-nullable": true
}
}
}
}
}
}
}
},
"\/messaging\/messages\/sms": {
"post": {
"summary": "Create SMS",
"operationId": "messagingCreateSms",
"tags": [
"messaging"
],
"description": "Create a new SMS message.",
"responses": {
"201": {
"description": "Message",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/message"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createSms",
"group": "messages",
"weight": 229,
"cookies": false,
"type": "",
"demo": "messaging\/create-sms.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.createSMS"
},
"methods": [
{
"name": "createSms",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"messageId",
"content",
"topics",
"users",
"targets",
"draft",
"scheduledAt"
],
"required": [
"messageId",
"content"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/message"
}
],
"description": "Create a new SMS message.",
"demo": "messaging\/create-sms.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.createSMS"
}
},
{
"name": "createSMS",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"messageId",
"content",
"topics",
"users",
"targets",
"draft",
"scheduledAt"
],
"required": [
"messageId",
"content"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/message"
}
],
"description": "Create a new SMS message.",
"demo": "messaging\/create-sms.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"messageId": {
"type": "string",
"description": "Message 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.",
"x-example": "<MESSAGE_ID>"
},
"content": {
"type": "string",
"description": "SMS Content.",
"x-example": "<CONTENT>"
},
"topics": {
"type": "array",
"description": "List of Topic IDs.",
"x-example": null,
"items": {
"type": "string"
}
},
"users": {
"type": "array",
"description": "List of User IDs.",
"x-example": null,
"items": {
"type": "string"
}
},
"targets": {
"type": "array",
"description": "List of Targets IDs.",
"x-example": null,
"items": {
"type": "string"
}
},
"draft": {
"type": "boolean",
"description": "Is message a draft",
"x-example": false
},
"scheduledAt": {
"type": "string",
"description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"messageId",
"content"
]
}
}
}
}
}
},
"\/messaging\/messages\/sms\/{messageId}": {
"patch": {
"summary": "Update SMS",
"operationId": "messagingUpdateSms",
"tags": [
"messaging"
],
"description": "Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.\n",
"responses": {
"200": {
"description": "Message",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/message"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateSms",
"group": "messages",
"weight": 236,
"cookies": false,
"type": "",
"demo": "messaging\/update-sms.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sms.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.updateSMS"
},
"methods": [
{
"name": "updateSms",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"messageId",
"topics",
"users",
"targets",
"content",
"draft",
"scheduledAt"
],
"required": [
"messageId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/message"
}
],
"description": "Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.\n",
"demo": "messaging\/update-sms.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.updateSMS"
}
},
{
"name": "updateSMS",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"messageId",
"topics",
"users",
"targets",
"content",
"draft",
"scheduledAt"
],
"required": [
"messageId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/message"
}
],
"description": "Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.\n",
"demo": "messaging\/update-sms.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "messageId",
"description": "Message ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MESSAGE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"topics": {
"type": "array",
"description": "List of Topic IDs.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"users": {
"type": "array",
"description": "List of User IDs.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"targets": {
"type": "array",
"description": "List of Targets IDs.",
"x-example": null,
"items": {
"type": "string"
},
"x-nullable": true
},
"content": {
"type": "string",
"description": "Email Content.",
"x-example": "<CONTENT>",
"x-nullable": true
},
"draft": {
"type": "boolean",
"description": "Is message a draft",
"x-example": false,
"x-nullable": true
},
"scheduledAt": {
"type": "string",
"description": "Scheduled delivery time for message in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future.",
"x-example": null,
"x-nullable": true
}
}
}
}
}
}
}
},
"\/messaging\/messages\/{messageId}": {
"get": {
"summary": "Get message",
"operationId": "messagingGetMessage",
"tags": [
"messaging"
],
"description": "Get a message by its unique ID.\n",
"responses": {
"200": {
"description": "Message",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/message"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getMessage",
"group": "messages",
"weight": 234,
"cookies": false,
"type": "",
"demo": "messaging\/get-message.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "messageId",
"description": "Message ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MESSAGE_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete message",
"operationId": "messagingDelete",
"tags": [
"messaging"
],
"description": "Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "messages",
"weight": 238,
"cookies": false,
"type": "",
"demo": "messaging\/delete.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "messageId",
"description": "Message ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MESSAGE_ID>"
},
"in": "path"
}
]
}
},
"\/messaging\/messages\/{messageId}\/logs": {
"get": {
"summary": "List message logs",
"operationId": "messagingListMessageLogs",
"tags": [
"messaging"
],
"description": "Get the message activity logs listed by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listMessageLogs",
"group": "logs",
"weight": 232,
"cookies": false,
"type": "",
"demo": "messaging\/list-message-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "messageId",
"description": "Message ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MESSAGE_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/messaging\/messages\/{messageId}\/targets": {
"get": {
"summary": "List message targets",
"operationId": "messagingListTargets",
"tags": [
"messaging"
],
"description": "Get a list of the targets associated with a message.",
"responses": {
"200": {
"description": "Target list",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/targetList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listTargets",
"group": "messages",
"weight": 233,
"cookies": false,
"type": "",
"demo": "messaging\/list-targets.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "messages.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "messageId",
"description": "Message ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MESSAGE_ID>"
},
"in": "path"
},
{
"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: userId, providerId, identifier, providerType",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/messaging\/providers": {
"get": {
"summary": "List providers",
"operationId": "messagingListProviders",
"tags": [
"messaging"
],
"description": "Get a list of all providers from the current Appwrite project.",
"responses": {
"200": {
"description": "Provider list",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/providerList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listProviders",
"group": "providers",
"weight": 202,
"cookies": false,
"type": "",
"demo": "messaging\/list-providers.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md",
"auth": {
"Project": []
}
},
"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, provider, type, enabled",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/messaging\/providers\/apns": {
"post": {
"summary": "Create APNS provider",
"operationId": "messagingCreateApnsProvider",
"tags": [
"messaging"
],
"description": "Create a new Apple Push Notification service provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createApnsProvider",
"group": "providers",
"weight": 201,
"cookies": false,
"type": "",
"demo": "messaging\/create-apns-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.createAPNSProvider"
},
"methods": [
{
"name": "createApnsProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"authKey",
"authKeyId",
"teamId",
"bundleId",
"sandbox",
"enabled"
],
"required": [
"providerId",
"name"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Create a new Apple Push Notification service provider.",
"demo": "messaging\/create-apns-provider.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.createAPNSProvider"
}
},
{
"name": "createAPNSProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"authKey",
"authKeyId",
"teamId",
"bundleId",
"sandbox",
"enabled"
],
"required": [
"providerId",
"name"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Create a new Apple Push Notification service provider.",
"demo": "messaging\/create-apns-provider.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"authKey": {
"type": "string",
"description": "APNS authentication key.",
"x-example": "<AUTH_KEY>"
},
"authKeyId": {
"type": "string",
"description": "APNS authentication key ID.",
"x-example": "<AUTH_KEY_ID>"
},
"teamId": {
"type": "string",
"description": "APNS team ID.",
"x-example": "<TEAM_ID>"
},
"bundleId": {
"type": "string",
"description": "APNS bundle ID.",
"x-example": "<BUNDLE_ID>"
},
"sandbox": {
"type": "boolean",
"description": "Use APNS sandbox environment.",
"x-example": false
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name"
]
}
}
}
}
}
},
"\/messaging\/providers\/apns\/{providerId}": {
"patch": {
"summary": "Update APNS provider",
"operationId": "messagingUpdateApnsProvider",
"tags": [
"messaging"
],
"description": "Update a Apple Push Notification service provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateApnsProvider",
"group": "providers",
"weight": 215,
"cookies": false,
"type": "",
"demo": "messaging\/update-apns-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.updateAPNSProvider"
},
"methods": [
{
"name": "updateApnsProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"enabled",
"authKey",
"authKeyId",
"teamId",
"bundleId",
"sandbox"
],
"required": [
"providerId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Update a Apple Push Notification service provider by its unique ID.",
"demo": "messaging\/update-apns-provider.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.updateAPNSProvider"
}
},
{
"name": "updateAPNSProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"enabled",
"authKey",
"authKeyId",
"teamId",
"bundleId",
"sandbox"
],
"required": [
"providerId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Update a Apple Push Notification service provider by its unique ID.",
"demo": "messaging\/update-apns-provider.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
},
"authKey": {
"type": "string",
"description": "APNS authentication key.",
"x-example": "<AUTH_KEY>"
},
"authKeyId": {
"type": "string",
"description": "APNS authentication key ID.",
"x-example": "<AUTH_KEY_ID>"
},
"teamId": {
"type": "string",
"description": "APNS team ID.",
"x-example": "<TEAM_ID>"
},
"bundleId": {
"type": "string",
"description": "APNS bundle ID.",
"x-example": "<BUNDLE_ID>"
},
"sandbox": {
"type": "boolean",
"description": "Use APNS sandbox environment.",
"x-example": false,
"x-nullable": true
}
}
}
}
}
}
}
},
"\/messaging\/providers\/fcm": {
"post": {
"summary": "Create FCM provider",
"operationId": "messagingCreateFcmProvider",
"tags": [
"messaging"
],
"description": "Create a new Firebase Cloud Messaging provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createFcmProvider",
"group": "providers",
"weight": 200,
"cookies": false,
"type": "",
"demo": "messaging\/create-fcm-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.createFCMProvider"
},
"methods": [
{
"name": "createFcmProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"serviceAccountJSON",
"enabled"
],
"required": [
"providerId",
"name"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Create a new Firebase Cloud Messaging provider.",
"demo": "messaging\/create-fcm-provider.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.createFCMProvider"
}
},
{
"name": "createFCMProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"serviceAccountJSON",
"enabled"
],
"required": [
"providerId",
"name"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Create a new Firebase Cloud Messaging provider.",
"demo": "messaging\/create-fcm-provider.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"serviceAccountJSON": {
"type": "object",
"description": "FCM service account JSON.",
"x-example": "{}",
"x-nullable": true
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name"
]
}
}
}
}
}
},
"\/messaging\/providers\/fcm\/{providerId}": {
"patch": {
"summary": "Update FCM provider",
"operationId": "messagingUpdateFcmProvider",
"tags": [
"messaging"
],
"description": "Update a Firebase Cloud Messaging provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateFcmProvider",
"group": "providers",
"weight": 214,
"cookies": false,
"type": "",
"demo": "messaging\/update-fcm-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.updateFCMProvider"
},
"methods": [
{
"name": "updateFcmProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"enabled",
"serviceAccountJSON"
],
"required": [
"providerId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Update a Firebase Cloud Messaging provider by its unique ID.",
"demo": "messaging\/update-fcm-provider.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.updateFCMProvider"
}
},
{
"name": "updateFCMProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"enabled",
"serviceAccountJSON"
],
"required": [
"providerId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Update a Firebase Cloud Messaging provider by its unique ID.",
"demo": "messaging\/update-fcm-provider.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
},
"serviceAccountJSON": {
"type": "object",
"description": "FCM service account JSON.",
"x-example": "{}",
"x-nullable": true
}
}
}
}
}
}
}
},
"\/messaging\/providers\/mailgun": {
"post": {
"summary": "Create Mailgun provider",
"operationId": "messagingCreateMailgunProvider",
"tags": [
"messaging"
],
"description": "Create a new Mailgun provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createMailgunProvider",
"group": "providers",
"weight": 191,
"cookies": false,
"type": "",
"demo": "messaging\/create-mailgun-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"apiKey": {
"type": "string",
"description": "Mailgun API Key.",
"x-example": "<API_KEY>"
},
"domain": {
"type": "string",
"description": "Mailgun Domain.",
"x-example": "<DOMAIN>"
},
"isEuRegion": {
"type": "boolean",
"description": "Set as EU region.",
"x-example": false,
"x-nullable": true
},
"fromName": {
"type": "string",
"description": "Sender Name.",
"x-example": "<FROM_NAME>"
},
"fromEmail": {
"type": "string",
"description": "Sender email address.",
"x-example": "email@example.com",
"format": "email"
},
"replyToName": {
"type": "string",
"description": "Name set in the reply to field for the mail. Default value is sender name. Reply to name must have reply to email as well.",
"x-example": "<REPLY_TO_NAME>"
},
"replyToEmail": {
"type": "string",
"description": "Email set in the reply to field for the mail. Default value is sender email. Reply to email must have reply to name as well.",
"x-example": "email@example.com",
"format": "email"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name"
]
}
}
}
}
}
},
"\/messaging\/providers\/mailgun\/{providerId}": {
"patch": {
"summary": "Update Mailgun provider",
"operationId": "messagingUpdateMailgunProvider",
"tags": [
"messaging"
],
"description": "Update a Mailgun provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateMailgunProvider",
"group": "providers",
"weight": 205,
"cookies": false,
"type": "",
"demo": "messaging\/update-mailgun-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"apiKey": {
"type": "string",
"description": "Mailgun API Key.",
"x-example": "<API_KEY>"
},
"domain": {
"type": "string",
"description": "Mailgun Domain.",
"x-example": "<DOMAIN>"
},
"isEuRegion": {
"type": "boolean",
"description": "Set as EU region.",
"x-example": false,
"x-nullable": true
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
},
"fromName": {
"type": "string",
"description": "Sender Name.",
"x-example": "<FROM_NAME>"
},
"fromEmail": {
"type": "string",
"description": "Sender email address.",
"x-example": "email@example.com",
"format": "email"
},
"replyToName": {
"type": "string",
"description": "Name set in the reply to field for the mail. Default value is sender name.",
"x-example": "<REPLY_TO_NAME>"
},
"replyToEmail": {
"type": "string",
"description": "Email set in the reply to field for the mail. Default value is sender email.",
"x-example": "<REPLY_TO_EMAIL>"
}
}
}
}
}
}
}
},
"\/messaging\/providers\/msg91": {
"post": {
"summary": "Create Msg91 provider",
"operationId": "messagingCreateMsg91Provider",
"tags": [
"messaging"
],
"description": "Create a new MSG91 provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createMsg91Provider",
"group": "providers",
"weight": 195,
"cookies": false,
"type": "",
"demo": "messaging\/create-msg-91-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"templateId": {
"type": "string",
"description": "Msg91 template ID",
"x-example": "<TEMPLATE_ID>"
},
"senderId": {
"type": "string",
"description": "Msg91 sender ID.",
"x-example": "<SENDER_ID>"
},
"authKey": {
"type": "string",
"description": "Msg91 auth key.",
"x-example": "<AUTH_KEY>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name"
]
}
}
}
}
}
},
"\/messaging\/providers\/msg91\/{providerId}": {
"patch": {
"summary": "Update Msg91 provider",
"operationId": "messagingUpdateMsg91Provider",
"tags": [
"messaging"
],
"description": "Update a MSG91 provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateMsg91Provider",
"group": "providers",
"weight": 209,
"cookies": false,
"type": "",
"demo": "messaging\/update-msg-91-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
},
"templateId": {
"type": "string",
"description": "Msg91 template ID.",
"x-example": "<TEMPLATE_ID>"
},
"senderId": {
"type": "string",
"description": "Msg91 sender ID.",
"x-example": "<SENDER_ID>"
},
"authKey": {
"type": "string",
"description": "Msg91 auth key.",
"x-example": "<AUTH_KEY>"
}
}
}
}
}
}
}
},
"\/messaging\/providers\/resend": {
"post": {
"summary": "Create Resend provider",
"operationId": "messagingCreateResendProvider",
"tags": [
"messaging"
],
"description": "Create a new Resend provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createResendProvider",
"group": "providers",
"weight": 193,
"cookies": false,
"type": "",
"demo": "messaging\/create-resend-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-resend-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"apiKey": {
"type": "string",
"description": "Resend API key.",
"x-example": "<API_KEY>"
},
"fromName": {
"type": "string",
"description": "Sender Name.",
"x-example": "<FROM_NAME>"
},
"fromEmail": {
"type": "string",
"description": "Sender email address.",
"x-example": "email@example.com",
"format": "email"
},
"replyToName": {
"type": "string",
"description": "Name set in the reply to field for the mail. Default value is sender name.",
"x-example": "<REPLY_TO_NAME>"
},
"replyToEmail": {
"type": "string",
"description": "Email set in the reply to field for the mail. Default value is sender email.",
"x-example": "email@example.com",
"format": "email"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name"
]
}
}
}
}
}
},
"\/messaging\/providers\/resend\/{providerId}": {
"patch": {
"summary": "Update Resend provider",
"operationId": "messagingUpdateResendProvider",
"tags": [
"messaging"
],
"description": "Update a Resend provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateResendProvider",
"group": "providers",
"weight": 207,
"cookies": false,
"type": "",
"demo": "messaging\/update-resend-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-resend-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
},
"apiKey": {
"type": "string",
"description": "Resend API key.",
"x-example": "<API_KEY>"
},
"fromName": {
"type": "string",
"description": "Sender Name.",
"x-example": "<FROM_NAME>"
},
"fromEmail": {
"type": "string",
"description": "Sender email address.",
"x-example": "email@example.com",
"format": "email"
},
"replyToName": {
"type": "string",
"description": "Name set in the Reply To field for the mail. Default value is Sender Name.",
"x-example": "<REPLY_TO_NAME>"
},
"replyToEmail": {
"type": "string",
"description": "Email set in the Reply To field for the mail. Default value is Sender Email.",
"x-example": "<REPLY_TO_EMAIL>"
}
}
}
}
}
}
}
},
"\/messaging\/providers\/sendgrid": {
"post": {
"summary": "Create Sendgrid provider",
"operationId": "messagingCreateSendgridProvider",
"tags": [
"messaging"
],
"description": "Create a new Sendgrid provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createSendgridProvider",
"group": "providers",
"weight": 192,
"cookies": false,
"type": "",
"demo": "messaging\/create-sendgrid-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"apiKey": {
"type": "string",
"description": "Sendgrid API key.",
"x-example": "<API_KEY>"
},
"fromName": {
"type": "string",
"description": "Sender Name.",
"x-example": "<FROM_NAME>"
},
"fromEmail": {
"type": "string",
"description": "Sender email address.",
"x-example": "email@example.com",
"format": "email"
},
"replyToName": {
"type": "string",
"description": "Name set in the reply to field for the mail. Default value is sender name.",
"x-example": "<REPLY_TO_NAME>"
},
"replyToEmail": {
"type": "string",
"description": "Email set in the reply to field for the mail. Default value is sender email.",
"x-example": "email@example.com",
"format": "email"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name"
]
}
}
}
}
}
},
"\/messaging\/providers\/sendgrid\/{providerId}": {
"patch": {
"summary": "Update Sendgrid provider",
"operationId": "messagingUpdateSendgridProvider",
"tags": [
"messaging"
],
"description": "Update a Sendgrid provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateSendgridProvider",
"group": "providers",
"weight": 206,
"cookies": false,
"type": "",
"demo": "messaging\/update-sendgrid-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
},
"apiKey": {
"type": "string",
"description": "Sendgrid API key.",
"x-example": "<API_KEY>"
},
"fromName": {
"type": "string",
"description": "Sender Name.",
"x-example": "<FROM_NAME>"
},
"fromEmail": {
"type": "string",
"description": "Sender email address.",
"x-example": "email@example.com",
"format": "email"
},
"replyToName": {
"type": "string",
"description": "Name set in the Reply To field for the mail. Default value is Sender Name.",
"x-example": "<REPLY_TO_NAME>"
},
"replyToEmail": {
"type": "string",
"description": "Email set in the Reply To field for the mail. Default value is Sender Email.",
"x-example": "<REPLY_TO_EMAIL>"
}
}
}
}
}
}
}
},
"\/messaging\/providers\/smtp": {
"post": {
"summary": "Create SMTP provider",
"operationId": "messagingCreateSmtpProvider",
"tags": [
"messaging"
],
"description": "Create a new SMTP provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createSmtpProvider",
"group": "providers",
"weight": 194,
"cookies": false,
"type": "",
"demo": "messaging\/create-smtp-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.createSMTPProvider"
},
"methods": [
{
"name": "createSmtpProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"host",
"port",
"username",
"password",
"encryption",
"autoTLS",
"mailer",
"fromName",
"fromEmail",
"replyToName",
"replyToEmail",
"enabled"
],
"required": [
"providerId",
"name",
"host"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Create a new SMTP provider.",
"demo": "messaging\/create-smtp-provider.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.createSMTPProvider"
}
},
{
"name": "createSMTPProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"host",
"port",
"username",
"password",
"encryption",
"autoTLS",
"mailer",
"fromName",
"fromEmail",
"replyToName",
"replyToEmail",
"enabled"
],
"required": [
"providerId",
"name",
"host"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Create a new SMTP provider.",
"demo": "messaging\/create-smtp-provider.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"host": {
"type": "string",
"description": "SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.",
"x-example": "<HOST>"
},
"port": {
"type": "integer",
"description": "The default SMTP server port.",
"x-example": 1,
"format": "int32"
},
"username": {
"type": "string",
"description": "Authentication username.",
"x-example": "<USERNAME>"
},
"password": {
"type": "string",
"description": "Authentication password.",
"x-example": "<PASSWORD>"
},
"encryption": {
"type": "string",
"description": "Encryption type. Can be omitted, 'ssl', or 'tls'",
"x-example": "none",
"enum": [
"none",
"ssl",
"tls"
],
"x-enum-name": "SmtpEncryption",
"x-enum-keys": []
},
"autoTLS": {
"type": "boolean",
"description": "Enable SMTP AutoTLS feature.",
"x-example": false
},
"mailer": {
"type": "string",
"description": "The value to use for the X-Mailer header.",
"x-example": "<MAILER>"
},
"fromName": {
"type": "string",
"description": "Sender Name.",
"x-example": "<FROM_NAME>"
},
"fromEmail": {
"type": "string",
"description": "Sender email address.",
"x-example": "email@example.com",
"format": "email"
},
"replyToName": {
"type": "string",
"description": "Name set in the reply to field for the mail. Default value is sender name.",
"x-example": "<REPLY_TO_NAME>"
},
"replyToEmail": {
"type": "string",
"description": "Email set in the reply to field for the mail. Default value is sender email.",
"x-example": "email@example.com",
"format": "email"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name",
"host"
]
}
}
}
}
}
},
"\/messaging\/providers\/smtp\/{providerId}": {
"patch": {
"summary": "Update SMTP provider",
"operationId": "messagingUpdateSmtpProvider",
"tags": [
"messaging"
],
"description": "Update a SMTP provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateSmtpProvider",
"group": "providers",
"weight": 208,
"cookies": false,
"type": "",
"demo": "messaging\/update-smtp-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.updateSMTPProvider"
},
"methods": [
{
"name": "updateSmtpProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"host",
"port",
"username",
"password",
"encryption",
"autoTLS",
"mailer",
"fromName",
"fromEmail",
"replyToName",
"replyToEmail",
"enabled"
],
"required": [
"providerId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Update a SMTP provider by its unique ID.",
"demo": "messaging\/update-smtp-provider.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "messaging.updateSMTPProvider"
}
},
{
"name": "updateSMTPProvider",
"namespace": "messaging",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"providerId",
"name",
"host",
"port",
"username",
"password",
"encryption",
"autoTLS",
"mailer",
"fromName",
"fromEmail",
"replyToName",
"replyToEmail",
"enabled"
],
"required": [
"providerId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/provider"
}
],
"description": "Update a SMTP provider by its unique ID.",
"demo": "messaging\/update-smtp-provider.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"host": {
"type": "string",
"description": "SMTP hosts. Either a single hostname or multiple semicolon-delimited hostnames. You can also specify a different port for each host such as `smtp1.example.com:25;smtp2.example.com`. You can also specify encryption type, for example: `tls:\/\/smtp1.example.com:587;ssl:\/\/smtp2.example.com:465\"`. Hosts will be tried in order.",
"x-example": "<HOST>"
},
"port": {
"type": "integer",
"description": "SMTP port.",
"x-example": 1,
"format": "int32",
"x-nullable": true
},
"username": {
"type": "string",
"description": "Authentication username.",
"x-example": "<USERNAME>"
},
"password": {
"type": "string",
"description": "Authentication password.",
"x-example": "<PASSWORD>"
},
"encryption": {
"type": "string",
"description": "Encryption type. Can be 'ssl' or 'tls'",
"x-example": "none",
"enum": [
"none",
"ssl",
"tls"
],
"x-enum-name": "SmtpEncryption",
"x-enum-keys": []
},
"autoTLS": {
"type": "boolean",
"description": "Enable SMTP AutoTLS feature.",
"x-example": false,
"x-nullable": true
},
"mailer": {
"type": "string",
"description": "The value to use for the X-Mailer header.",
"x-example": "<MAILER>"
},
"fromName": {
"type": "string",
"description": "Sender Name.",
"x-example": "<FROM_NAME>"
},
"fromEmail": {
"type": "string",
"description": "Sender email address.",
"x-example": "email@example.com",
"format": "email"
},
"replyToName": {
"type": "string",
"description": "Name set in the Reply To field for the mail. Default value is Sender Name.",
"x-example": "<REPLY_TO_NAME>"
},
"replyToEmail": {
"type": "string",
"description": "Email set in the Reply To field for the mail. Default value is Sender Email.",
"x-example": "<REPLY_TO_EMAIL>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
}
}
}
}
}
}
},
"\/messaging\/providers\/telesign": {
"post": {
"summary": "Create Telesign provider",
"operationId": "messagingCreateTelesignProvider",
"tags": [
"messaging"
],
"description": "Create a new Telesign provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTelesignProvider",
"group": "providers",
"weight": 196,
"cookies": false,
"type": "",
"demo": "messaging\/create-telesign-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"from": {
"type": "string",
"description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.",
"x-example": "+12065550100",
"format": "phone"
},
"customerId": {
"type": "string",
"description": "Telesign customer ID.",
"x-example": "<CUSTOMER_ID>"
},
"apiKey": {
"type": "string",
"description": "Telesign API key.",
"x-example": "<API_KEY>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name"
]
}
}
}
}
}
},
"\/messaging\/providers\/telesign\/{providerId}": {
"patch": {
"summary": "Update Telesign provider",
"operationId": "messagingUpdateTelesignProvider",
"tags": [
"messaging"
],
"description": "Update a Telesign provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTelesignProvider",
"group": "providers",
"weight": 210,
"cookies": false,
"type": "",
"demo": "messaging\/update-telesign-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
},
"customerId": {
"type": "string",
"description": "Telesign customer ID.",
"x-example": "<CUSTOMER_ID>"
},
"apiKey": {
"type": "string",
"description": "Telesign API key.",
"x-example": "<API_KEY>"
},
"from": {
"type": "string",
"description": "Sender number.",
"x-example": "<FROM>"
}
}
}
}
}
}
}
},
"\/messaging\/providers\/textmagic": {
"post": {
"summary": "Create Textmagic provider",
"operationId": "messagingCreateTextmagicProvider",
"tags": [
"messaging"
],
"description": "Create a new Textmagic provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTextmagicProvider",
"group": "providers",
"weight": 197,
"cookies": false,
"type": "",
"demo": "messaging\/create-textmagic-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"from": {
"type": "string",
"description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.",
"x-example": "+12065550100",
"format": "phone"
},
"username": {
"type": "string",
"description": "Textmagic username.",
"x-example": "<USERNAME>"
},
"apiKey": {
"type": "string",
"description": "Textmagic apiKey.",
"x-example": "<API_KEY>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name"
]
}
}
}
}
}
},
"\/messaging\/providers\/textmagic\/{providerId}": {
"patch": {
"summary": "Update Textmagic provider",
"operationId": "messagingUpdateTextmagicProvider",
"tags": [
"messaging"
],
"description": "Update a Textmagic provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTextmagicProvider",
"group": "providers",
"weight": 211,
"cookies": false,
"type": "",
"demo": "messaging\/update-textmagic-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
},
"username": {
"type": "string",
"description": "Textmagic username.",
"x-example": "<USERNAME>"
},
"apiKey": {
"type": "string",
"description": "Textmagic apiKey.",
"x-example": "<API_KEY>"
},
"from": {
"type": "string",
"description": "Sender number.",
"x-example": "<FROM>"
}
}
}
}
}
}
}
},
"\/messaging\/providers\/twilio": {
"post": {
"summary": "Create Twilio provider",
"operationId": "messagingCreateTwilioProvider",
"tags": [
"messaging"
],
"description": "Create a new Twilio provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTwilioProvider",
"group": "providers",
"weight": 198,
"cookies": false,
"type": "",
"demo": "messaging\/create-twilio-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"from": {
"type": "string",
"description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.",
"x-example": "+12065550100",
"format": "phone"
},
"accountSid": {
"type": "string",
"description": "Twilio account secret ID.",
"x-example": "<ACCOUNT_SID>"
},
"authToken": {
"type": "string",
"description": "Twilio authentication token.",
"x-example": "<AUTH_TOKEN>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name"
]
}
}
}
}
}
},
"\/messaging\/providers\/twilio\/{providerId}": {
"patch": {
"summary": "Update Twilio provider",
"operationId": "messagingUpdateTwilioProvider",
"tags": [
"messaging"
],
"description": "Update a Twilio provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTwilioProvider",
"group": "providers",
"weight": 212,
"cookies": false,
"type": "",
"demo": "messaging\/update-twilio-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
},
"accountSid": {
"type": "string",
"description": "Twilio account secret ID.",
"x-example": "<ACCOUNT_SID>"
},
"authToken": {
"type": "string",
"description": "Twilio authentication token.",
"x-example": "<AUTH_TOKEN>"
},
"from": {
"type": "string",
"description": "Sender number.",
"x-example": "<FROM>"
}
}
}
}
}
}
}
},
"\/messaging\/providers\/vonage": {
"post": {
"summary": "Create Vonage provider",
"operationId": "messagingCreateVonageProvider",
"tags": [
"messaging"
],
"description": "Create a new Vonage provider.",
"responses": {
"201": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createVonageProvider",
"group": "providers",
"weight": 199,
"cookies": false,
"type": "",
"demo": "messaging\/create-vonage-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerId": {
"type": "string",
"description": "Provider 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.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"from": {
"type": "string",
"description": "Sender Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.",
"x-example": "+12065550100",
"format": "phone"
},
"apiKey": {
"type": "string",
"description": "Vonage API key.",
"x-example": "<API_KEY>"
},
"apiSecret": {
"type": "string",
"description": "Vonage API secret.",
"x-example": "<API_SECRET>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"providerId",
"name"
]
}
}
}
}
}
},
"\/messaging\/providers\/vonage\/{providerId}": {
"patch": {
"summary": "Update Vonage provider",
"operationId": "messagingUpdateVonageProvider",
"tags": [
"messaging"
],
"description": "Update a Vonage provider by its unique ID.",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateVonageProvider",
"group": "providers",
"weight": 213,
"cookies": false,
"type": "",
"demo": "messaging\/update-vonage-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Provider name.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Set as enabled.",
"x-example": false,
"x-nullable": true
},
"apiKey": {
"type": "string",
"description": "Vonage API key.",
"x-example": "<API_KEY>"
},
"apiSecret": {
"type": "string",
"description": "Vonage API secret.",
"x-example": "<API_SECRET>"
},
"from": {
"type": "string",
"description": "Sender number.",
"x-example": "<FROM>"
}
}
}
}
}
}
}
},
"\/messaging\/providers\/{providerId}": {
"get": {
"summary": "Get provider",
"operationId": "messagingGetProvider",
"tags": [
"messaging"
],
"description": "Get a provider by its unique ID.\n",
"responses": {
"200": {
"description": "Provider",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/provider"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getProvider",
"group": "providers",
"weight": 204,
"cookies": false,
"type": "",
"demo": "messaging\/get-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete provider",
"operationId": "messagingDeleteProvider",
"tags": [
"messaging"
],
"description": "Delete a provider by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteProvider",
"group": "providers",
"weight": 216,
"cookies": false,
"type": "",
"demo": "messaging\/delete-provider.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
}
]
}
},
"\/messaging\/providers\/{providerId}\/logs": {
"get": {
"summary": "List provider logs",
"operationId": "messagingListProviderLogs",
"tags": [
"messaging"
],
"description": "Get the provider activity logs listed by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listProviderLogs",
"group": "providers",
"weight": 203,
"cookies": false,
"type": "",
"demo": "messaging\/list-provider-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "providers.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "providerId",
"description": "Provider ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/messaging\/subscribers\/{subscriberId}\/logs": {
"get": {
"summary": "List subscriber logs",
"operationId": "messagingListSubscriberLogs",
"tags": [
"messaging"
],
"description": "Get the subscriber activity logs listed by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listSubscriberLogs",
"group": "subscribers",
"weight": 225,
"cookies": false,
"type": "",
"demo": "messaging\/list-subscriber-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "subscribers.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "subscriberId",
"description": "Subscriber ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SUBSCRIBER_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/messaging\/topics": {
"get": {
"summary": "List topics",
"operationId": "messagingListTopics",
"tags": [
"messaging"
],
"description": "Get a list of all topics from the current Appwrite project.",
"responses": {
"200": {
"description": "Topic list",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/topicList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listTopics",
"group": "topics",
"weight": 218,
"cookies": false,
"type": "",
"demo": "messaging\/list-topics.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "topics.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md",
"auth": {
"Project": []
}
},
"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, description, emailTotal, smsTotal, pushTotal",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create topic",
"operationId": "messagingCreateTopic",
"tags": [
"messaging"
],
"description": "Create a new topic.",
"responses": {
"201": {
"description": "Topic",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/topic"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTopic",
"group": "topics",
"weight": 217,
"cookies": false,
"type": "",
"demo": "messaging\/create-topic.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "topics.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"topicId": {
"type": "string",
"description": "Topic ID. Choose a custom Topic ID or a new Topic ID.",
"x-example": "<TOPIC_ID>"
},
"name": {
"type": "string",
"description": "Topic Name.",
"x-example": "<NAME>"
},
"subscribe": {
"type": "array",
"description": "An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.",
"x-example": "[\"any\"]",
"items": {
"type": "string"
}
}
},
"required": [
"topicId",
"name"
]
}
}
}
}
}
},
"\/messaging\/topics\/{topicId}": {
"get": {
"summary": "Get topic",
"operationId": "messagingGetTopic",
"tags": [
"messaging"
],
"description": "Get a topic by its unique ID.\n",
"responses": {
"200": {
"description": "Topic",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/topic"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getTopic",
"group": "topics",
"weight": 220,
"cookies": false,
"type": "",
"demo": "messaging\/get-topic.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "topics.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "topicId",
"description": "Topic ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOPIC_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Update topic",
"operationId": "messagingUpdateTopic",
"tags": [
"messaging"
],
"description": "Update a topic by its unique ID.\n",
"responses": {
"200": {
"description": "Topic",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/topic"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTopic",
"group": "topics",
"weight": 221,
"cookies": false,
"type": "",
"demo": "messaging\/update-topic.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "topics.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "topicId",
"description": "Topic ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOPIC_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Topic Name.",
"x-example": "<NAME>",
"x-nullable": true
},
"subscribe": {
"type": "array",
"description": "An array of role strings with subscribe permission. By default all users are granted with any subscribe permission. [learn more about roles](https:\/\/appwrite.io\/docs\/permissions#permission-roles). Maximum of 100 roles are allowed, each 64 characters long.",
"x-example": "[\"any\"]",
"items": {
"type": "string"
},
"x-nullable": true
}
}
}
}
}
}
},
"delete": {
"summary": "Delete topic",
"operationId": "messagingDeleteTopic",
"tags": [
"messaging"
],
"description": "Delete a topic by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteTopic",
"group": "topics",
"weight": 222,
"cookies": false,
"type": "",
"demo": "messaging\/delete-topic.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "topics.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "topicId",
"description": "Topic ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOPIC_ID>"
},
"in": "path"
}
]
}
},
"\/messaging\/topics\/{topicId}\/logs": {
"get": {
"summary": "List topic logs",
"operationId": "messagingListTopicLogs",
"tags": [
"messaging"
],
"description": "Get the topic activity logs listed by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listTopicLogs",
"group": "topics",
"weight": 219,
"cookies": false,
"type": "",
"demo": "messaging\/list-topic-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "topics.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "topicId",
"description": "Topic ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOPIC_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/messaging\/topics\/{topicId}\/subscribers": {
"get": {
"summary": "List subscribers",
"operationId": "messagingListSubscribers",
"tags": [
"messaging"
],
"description": "Get a list of all subscribers from the current Appwrite project.",
"responses": {
"200": {
"description": "Subscriber list",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/subscriberList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listSubscribers",
"group": "subscribers",
"weight": 224,
"cookies": false,
"type": "",
"demo": "messaging\/list-subscribers.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "subscribers.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "topicId",
"description": "Topic ID. The topic ID subscribed to.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOPIC_ID>"
},
"in": "path"
},
{
"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, provider, type, enabled",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create subscriber",
"operationId": "messagingCreateSubscriber",
"tags": [
"messaging"
],
"description": "Create a new subscriber.",
"responses": {
"201": {
"description": "Subscriber",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/subscriber"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createSubscriber",
"group": "subscribers",
"weight": 223,
"cookies": false,
"type": "",
"demo": "messaging\/create-subscriber.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "subscribers.write",
"platforms": [
"server",
"client",
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": [],
"Key": []
}
],
"parameters": [
{
"name": "topicId",
"description": "Topic ID. The topic ID to subscribe to.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOPIC_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"subscriberId": {
"type": "string",
"description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.",
"x-example": "<SUBSCRIBER_ID>"
},
"targetId": {
"type": "string",
"description": "Target ID. The target ID to link to the specified Topic ID.",
"x-example": "<TARGET_ID>"
}
},
"required": [
"subscriberId",
"targetId"
]
}
}
}
}
}
},
"\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}": {
"get": {
"summary": "Get subscriber",
"operationId": "messagingGetSubscriber",
"tags": [
"messaging"
],
"description": "Get a subscriber by its unique ID.\n",
"responses": {
"200": {
"description": "Subscriber",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/subscriber"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getSubscriber",
"group": "subscribers",
"weight": 226,
"cookies": false,
"type": "",
"demo": "messaging\/get-subscriber.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "subscribers.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "topicId",
"description": "Topic ID. The topic ID subscribed to.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOPIC_ID>"
},
"in": "path"
},
{
"name": "subscriberId",
"description": "Subscriber ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SUBSCRIBER_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete subscriber",
"operationId": "messagingDeleteSubscriber",
"tags": [
"messaging"
],
"description": "Delete a subscriber by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteSubscriber",
"group": "subscribers",
"weight": 227,
"cookies": false,
"type": "",
"demo": "messaging\/delete-subscriber.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "subscribers.write",
"platforms": [
"server",
"client",
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": [],
"Key": []
}
],
"parameters": [
{
"name": "topicId",
"description": "Topic ID. The topic ID subscribed to.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOPIC_ID>"
},
"in": "path"
},
{
"name": "subscriberId",
"description": "Subscriber ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SUBSCRIBER_ID>"
},
"in": "path"
}
]
}
},
"\/migrations": {
"get": {
"summary": "List migrations",
"operationId": "migrationsList",
"tags": [
"migrations"
],
"description": "List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.",
"responses": {
"200": {
"description": "Migrations List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migrationList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "list",
"group": null,
"weight": 183,
"cookies": false,
"type": "",
"demo": "migrations\/list.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/list-migrations.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"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\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: status, stage, source, destination, resources, statusCounters, resourceData, errors",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/migrations\/appwrite": {
"post": {
"summary": "Create Appwrite migration",
"operationId": "migrationsCreateAppwriteMigration",
"tags": [
"migrations"
],
"description": "Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project. ",
"responses": {
"202": {
"description": "Migration",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migration"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createAppwriteMigration",
"group": null,
"weight": 177,
"cookies": false,
"type": "",
"demo": "migrations\/create-appwrite-migration.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"resources": {
"type": "array",
"description": "List of resources to migrate",
"x-example": null,
"items": {
"type": "string",
"enum": [
"user",
"team",
"membership",
"database",
"table",
"column",
"index",
"row",
"document",
"attribute",
"collection",
"bucket",
"file",
"function",
"deployment",
"environment-variable"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"endpoint": {
"type": "string",
"description": "Source Appwrite endpoint",
"x-example": "https:\/\/example.com",
"format": "url"
},
"projectId": {
"type": "string",
"description": "Source Project ID",
"x-example": "<PROJECT_ID>"
},
"apiKey": {
"type": "string",
"description": "Source API Key",
"x-example": "<API_KEY>"
}
},
"required": [
"resources",
"endpoint",
"projectId",
"apiKey"
]
}
}
}
}
}
},
"\/migrations\/appwrite\/report": {
"get": {
"summary": "Get Appwrite migration report",
"operationId": "migrationsGetAppwriteReport",
"tags": [
"migrations"
],
"description": "Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.",
"responses": {
"200": {
"description": "Migration Report",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migrationReport"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getAppwriteReport",
"group": null,
"weight": 185,
"cookies": false,
"type": "",
"demo": "migrations\/get-appwrite-report.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite-report.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "resources",
"description": "List of resources to migrate",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"team",
"membership",
"database",
"table",
"column",
"index",
"row",
"document",
"attribute",
"collection",
"bucket",
"file",
"function",
"deployment",
"environment-variable"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"in": "query"
},
{
"name": "endpoint",
"description": "Source's Appwrite Endpoint",
"required": true,
"schema": {
"type": "string",
"format": "url",
"x-example": "https:\/\/example.com"
},
"in": "query"
},
{
"name": "projectID",
"description": "Source's Project ID",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "query"
},
{
"name": "key",
"description": "Source's API Key",
"required": true,
"schema": {
"type": "string",
"x-example": "<KEY>"
},
"in": "query"
}
]
}
},
"\/migrations\/csv\/exports": {
"post": {
"summary": "Export documents to CSV",
"operationId": "migrationsCreateCSVExport",
"tags": [
"migrations"
],
"description": "Export documents to a CSV file from your Appwrite database. This endpoint allows you to export documents to a CSV file stored in a secure internal bucket. You'll receive an email with a download link when the export is complete.",
"responses": {
"202": {
"description": "Migration",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migration"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createCSVExport",
"group": null,
"weight": 182,
"cookies": false,
"type": "",
"demo": "migrations\/create-csv-export.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-csv-export.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"description": "Composite ID in the format {databaseId:collectionId}, identifying a collection within a database to export.",
"x-example": "<ID1:ID2>"
},
"filename": {
"type": "string",
"description": "The name of the file to be created for the export, excluding the .csv extension.",
"x-example": "<FILENAME>"
},
"columns": {
"type": "array",
"description": "List of attributes to export. If empty, all attributes will be exported. You can use the `*` wildcard to export all attributes from the collection.",
"x-example": null,
"items": {
"type": "string"
}
},
"queries": {
"type": "array",
"description": "Array of query strings generated using the Query class provided by the SDK to filter documents to export. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long.",
"x-example": null,
"items": {
"type": "string"
}
},
"delimiter": {
"type": "string",
"description": "The character that separates each column value. Default is comma.",
"x-example": "<DELIMITER>"
},
"enclosure": {
"type": "string",
"description": "The character that encloses each column value. Default is double quotes.",
"x-example": "<ENCLOSURE>"
},
"escape": {
"type": "string",
"description": "The escape character for the enclosure character. Default is double quotes.",
"x-example": "<ESCAPE>"
},
"header": {
"type": "boolean",
"description": "Whether to include the header row with column names. Default is true.",
"x-example": false
},
"notify": {
"type": "boolean",
"description": "Set to true to receive an email when the export is complete. Default is true.",
"x-example": false
}
},
"required": [
"resourceId",
"filename"
]
}
}
}
}
}
},
"\/migrations\/csv\/imports": {
"post": {
"summary": "Import documents from a CSV",
"operationId": "migrationsCreateCSVImport",
"tags": [
"migrations"
],
"description": "Import documents from a CSV file into your Appwrite database. This endpoint allows you to import documents from a CSV file uploaded to Appwrite Storage bucket.",
"responses": {
"202": {
"description": "Migration",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migration"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createCSVImport",
"group": null,
"weight": 181,
"cookies": false,
"type": "",
"demo": "migrations\/create-csv-import.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-csv-import.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"bucketId": {
"type": "string",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"x-example": "<BUCKET_ID>"
},
"fileId": {
"type": "string",
"description": "File ID.",
"x-example": "<FILE_ID>"
},
"resourceId": {
"type": "string",
"description": "Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.",
"x-example": "<ID1:ID2>"
},
"internalFile": {
"type": "boolean",
"description": "Is the file stored in an internal bucket?",
"x-example": false
}
},
"required": [
"bucketId",
"fileId",
"resourceId"
]
}
}
}
}
}
},
"\/migrations\/firebase": {
"post": {
"summary": "Create Firebase migration",
"operationId": "migrationsCreateFirebaseMigration",
"tags": [
"migrations"
],
"description": "Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project. ",
"responses": {
"202": {
"description": "Migration",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migration"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createFirebaseMigration",
"group": null,
"weight": 178,
"cookies": false,
"type": "",
"demo": "migrations\/create-firebase-migration.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"resources": {
"type": "array",
"description": "List of resources to migrate",
"x-example": null,
"items": {
"type": "string",
"enum": [
"user",
"database",
"table",
"column",
"row",
"document",
"attribute",
"collection",
"bucket",
"file"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"serviceAccount": {
"type": "string",
"description": "JSON of the Firebase service account credentials",
"x-example": "<SERVICE_ACCOUNT>"
}
},
"required": [
"resources",
"serviceAccount"
]
}
}
}
}
}
},
"\/migrations\/firebase\/report": {
"get": {
"summary": "Get Firebase migration report",
"operationId": "migrationsGetFirebaseReport",
"tags": [
"migrations"
],
"description": "Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.",
"responses": {
"200": {
"description": "Migration Report",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migrationReport"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getFirebaseReport",
"group": null,
"weight": 186,
"cookies": false,
"type": "",
"demo": "migrations\/get-firebase-report.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "resources",
"description": "List of resources to migrate",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"database",
"table",
"column",
"row",
"document",
"attribute",
"collection",
"bucket",
"file"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"in": "query"
},
{
"name": "serviceAccount",
"description": "JSON of the Firebase service account credentials",
"required": true,
"schema": {
"type": "string",
"x-example": "<SERVICE_ACCOUNT>"
},
"in": "query"
}
]
}
},
"\/migrations\/nhost": {
"post": {
"summary": "Create NHost migration",
"operationId": "migrationsCreateNHostMigration",
"tags": [
"migrations"
],
"description": "Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project. ",
"responses": {
"202": {
"description": "Migration",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migration"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createNHostMigration",
"group": null,
"weight": 180,
"cookies": false,
"type": "",
"demo": "migrations\/create-n-host-migration.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"resources": {
"type": "array",
"description": "List of resources to migrate",
"x-example": null,
"items": {
"type": "string",
"enum": [
"user",
"database",
"table",
"column",
"index",
"row",
"document",
"attribute",
"collection",
"bucket",
"file"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"subdomain": {
"type": "string",
"description": "Source's Subdomain",
"x-example": "<SUBDOMAIN>"
},
"region": {
"type": "string",
"description": "Source's Region",
"x-example": "<REGION>"
},
"adminSecret": {
"type": "string",
"description": "Source's Admin Secret",
"x-example": "<ADMIN_SECRET>"
},
"database": {
"type": "string",
"description": "Source's Database Name",
"x-example": "<DATABASE>"
},
"username": {
"type": "string",
"description": "Source's Database Username",
"x-example": "<USERNAME>"
},
"password": {
"type": "string",
"description": "Source's Database Password",
"x-example": "<PASSWORD>"
},
"port": {
"type": "integer",
"description": "Source's Database Port",
"x-example": null,
"format": "int32"
}
},
"required": [
"resources",
"subdomain",
"region",
"adminSecret",
"database",
"username",
"password"
]
}
}
}
}
}
},
"\/migrations\/nhost\/report": {
"get": {
"summary": "Get NHost migration report",
"operationId": "migrationsGetNHostReport",
"tags": [
"migrations"
],
"description": "Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated. ",
"responses": {
"200": {
"description": "Migration Report",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migrationReport"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getNHostReport",
"group": null,
"weight": 188,
"cookies": false,
"type": "",
"demo": "migrations\/get-n-host-report.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost-report.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "resources",
"description": "List of resources to migrate.",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"database",
"table",
"column",
"index",
"row",
"document",
"attribute",
"collection",
"bucket",
"file"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"in": "query"
},
{
"name": "subdomain",
"description": "Source's Subdomain.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SUBDOMAIN>"
},
"in": "query"
},
{
"name": "region",
"description": "Source's Region.",
"required": true,
"schema": {
"type": "string",
"x-example": "<REGION>"
},
"in": "query"
},
{
"name": "adminSecret",
"description": "Source's Admin Secret.",
"required": true,
"schema": {
"type": "string",
"x-example": "<ADMIN_SECRET>"
},
"in": "query"
},
{
"name": "database",
"description": "Source's Database Name.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE>"
},
"in": "query"
},
{
"name": "username",
"description": "Source's Database Username.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USERNAME>"
},
"in": "query"
},
{
"name": "password",
"description": "Source's Database Password.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PASSWORD>"
},
"in": "query"
},
{
"name": "port",
"description": "Source's Database Port.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5432
},
"in": "query"
}
]
}
},
"\/migrations\/supabase": {
"post": {
"summary": "Create Supabase migration",
"operationId": "migrationsCreateSupabaseMigration",
"tags": [
"migrations"
],
"description": "Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project. ",
"responses": {
"202": {
"description": "Migration",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migration"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createSupabaseMigration",
"group": null,
"weight": 179,
"cookies": false,
"type": "",
"demo": "migrations\/create-supabase-migration.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"resources": {
"type": "array",
"description": "List of resources to migrate",
"x-example": null,
"items": {
"type": "string",
"enum": [
"user",
"database",
"table",
"column",
"index",
"row",
"document",
"attribute",
"collection",
"bucket",
"file"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"endpoint": {
"type": "string",
"description": "Source's Supabase Endpoint",
"x-example": "https:\/\/example.com",
"format": "url"
},
"apiKey": {
"type": "string",
"description": "Source's API Key",
"x-example": "<API_KEY>"
},
"databaseHost": {
"type": "string",
"description": "Source's Database Host",
"x-example": "<DATABASE_HOST>"
},
"username": {
"type": "string",
"description": "Source's Database Username",
"x-example": "<USERNAME>"
},
"password": {
"type": "string",
"description": "Source's Database Password",
"x-example": "<PASSWORD>"
},
"port": {
"type": "integer",
"description": "Source's Database Port",
"x-example": null,
"format": "int32"
}
},
"required": [
"resources",
"endpoint",
"apiKey",
"databaseHost",
"username",
"password"
]
}
}
}
}
}
},
"\/migrations\/supabase\/report": {
"get": {
"summary": "Get Supabase migration report",
"operationId": "migrationsGetSupabaseReport",
"tags": [
"migrations"
],
"description": "Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated. ",
"responses": {
"200": {
"description": "Migration Report",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migrationReport"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getSupabaseReport",
"group": null,
"weight": 187,
"cookies": false,
"type": "",
"demo": "migrations\/get-supabase-report.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase-report.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "resources",
"description": "List of resources to migrate",
"required": true,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"user",
"database",
"table",
"column",
"index",
"row",
"document",
"attribute",
"collection",
"bucket",
"file"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"in": "query"
},
{
"name": "endpoint",
"description": "Source's Supabase Endpoint.",
"required": true,
"schema": {
"type": "string",
"format": "url",
"x-example": "https:\/\/example.com"
},
"in": "query"
},
{
"name": "apiKey",
"description": "Source's API Key.",
"required": true,
"schema": {
"type": "string",
"x-example": "<API_KEY>"
},
"in": "query"
},
{
"name": "databaseHost",
"description": "Source's Database Host.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_HOST>"
},
"in": "query"
},
{
"name": "username",
"description": "Source's Database Username.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USERNAME>"
},
"in": "query"
},
{
"name": "password",
"description": "Source's Database Password.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PASSWORD>"
},
"in": "query"
},
{
"name": "port",
"description": "Source's Database Port.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"default": 5432
},
"in": "query"
}
]
}
},
"\/migrations\/{migrationId}": {
"get": {
"summary": "Get migration",
"operationId": "migrationsGet",
"tags": [
"migrations"
],
"description": "Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process. ",
"responses": {
"200": {
"description": "Migration",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migration"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": null,
"weight": 184,
"cookies": false,
"type": "",
"demo": "migrations\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/get-migration.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "migrationId",
"description": "Migration unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MIGRATION_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Update retry migration",
"operationId": "migrationsRetry",
"tags": [
"migrations"
],
"description": "Retry a failed migration. This endpoint allows you to retry a migration that has previously failed.",
"responses": {
"202": {
"description": "Migration",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/migration"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "retry",
"group": null,
"weight": 189,
"cookies": false,
"type": "",
"demo": "migrations\/retry.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/retry-migration.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "migrationId",
"description": "Migration unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MIGRATION_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete migration",
"operationId": "migrationsDelete",
"tags": [
"migrations"
],
"description": "Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project's migration history. ",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "delete",
"group": null,
"weight": 190,
"cookies": false,
"type": "",
"demo": "migrations\/delete.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "migrations.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/delete-migration.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "migrationId",
"description": "Migration ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MIGRATION_ID>"
},
"in": "path"
}
]
}
},
"\/project\/usage": {
"get": {
"summary": "Get project usage stats",
"operationId": "projectGetUsage",
"tags": [
"project"
],
"description": "Get comprehensive usage statistics for your project. View metrics including network requests, bandwidth, storage, function executions, database usage, and user activity. Specify a time range with startDate and endDate, and optionally set the data granularity with period (1h or 1d). The response includes both total counts and detailed breakdowns by resource, along with historical data over the specified period.",
"responses": {
"200": {
"description": "UsageProject",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageProject"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
"weight": 100,
"cookies": false,
"type": "",
"demo": "project\/get-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-usage.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "startDate",
"description": "Starting date for the usage",
"required": true,
"schema": {
"type": "string"
},
"in": "query"
},
{
"name": "endDate",
"description": "End date for the usage",
"required": true,
"schema": {
"type": "string"
},
"in": "query"
},
{
"name": "period",
"description": "Period used",
"required": false,
"schema": {
"type": "string",
"x-example": "1h",
"enum": [
"1h",
"1d"
],
"x-enum-name": "ProjectUsageRange",
"x-enum-keys": [
"One Hour",
"One Day"
],
"default": "1d"
},
"in": "query"
}
]
}
},
"\/project\/variables": {
"get": {
"summary": "List variables",
"operationId": "projectListVariables",
"tags": [
"project"
],
"description": "Get a list of all project variables. These variables will be accessible in all Appwrite Functions at runtime.",
"responses": {
"200": {
"description": "Variables List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variableList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listVariables",
"group": null,
"weight": 102,
"cookies": false,
"type": "",
"demo": "project\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/list-variables.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
]
},
"post": {
"summary": "Create variable",
"operationId": "projectCreateVariable",
"tags": [
"project"
],
"description": "Create a new project variable. This variable will be accessible in all Appwrite Functions at runtime.",
"responses": {
"201": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createVariable",
"group": null,
"weight": 101,
"cookies": false,
"type": "",
"demo": "project\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/create-variable.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Variable key. Max length: 255 chars.",
"x-example": "<KEY>"
},
"value": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"x-example": "<VALUE>"
},
"secret": {
"type": "boolean",
"description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.",
"x-example": false
}
},
"required": [
"key",
"value"
]
}
}
}
}
}
},
"\/project\/variables\/{variableId}": {
"get": {
"summary": "Get variable",
"operationId": "projectGetVariable",
"tags": [
"project"
],
"description": "Get a project variable by its unique ID.",
"responses": {
"200": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getVariable",
"group": null,
"weight": 103,
"cookies": false,
"type": "",
"demo": "project\/get-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-variable.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "variableId",
"description": "Variable unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<VARIABLE_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update variable",
"operationId": "projectUpdateVariable",
"tags": [
"project"
],
"description": "Update project variable by its unique ID. This variable will be accessible in all Appwrite Functions at runtime.",
"responses": {
"200": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateVariable",
"group": null,
"weight": 104,
"cookies": false,
"type": "",
"demo": "project\/update-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/update-variable.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "variableId",
"description": "Variable unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<VARIABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Variable key. Max length: 255 chars.",
"x-example": "<KEY>"
},
"value": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"x-example": "<VALUE>",
"x-nullable": true
},
"secret": {
"type": "boolean",
"description": "Secret variables can be updated or deleted, but only projects can read them during build and runtime.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"key"
]
}
}
}
}
},
"delete": {
"summary": "Delete variable",
"operationId": "projectDeleteVariable",
"tags": [
"project"
],
"description": "Delete a project variable by its unique ID. ",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteVariable",
"group": null,
"weight": 105,
"cookies": false,
"type": "",
"demo": "project\/delete-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/delete-variable.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "variableId",
"description": "Variable unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<VARIABLE_ID>"
},
"in": "path"
}
]
}
},
"\/projects": {
"get": {
"summary": "List projects",
"operationId": "projectsList",
"tags": [
"projects"
],
"description": "Get a list of all projects. You can use the query params to filter your results. ",
"responses": {
"200": {
"description": "Projects List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/projectList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "list",
"group": "projects",
"weight": 414,
"cookies": false,
"type": "",
"demo": "projects\/list.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"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, teamId, labels, search",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create project",
"operationId": "projectsCreate",
"tags": [
"projects"
],
"description": "Create a new project. You can create a maximum of 100 projects per account. ",
"responses": {
"201": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "create",
"group": "projects",
"weight": 412,
"cookies": false,
"type": "",
"demo": "projects\/create.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"projectId": {
"type": "string",
"description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, and hyphen. Can't start with a special char. Max length is 36 chars.",
"x-example": null
},
"name": {
"type": "string",
"description": "Project name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"teamId": {
"type": "string",
"description": "Team unique ID.",
"x-example": "<TEAM_ID>"
},
"region": {
"type": "string",
"description": "Project Region.",
"x-example": "default",
"enum": [
"default"
],
"x-enum-name": null,
"x-enum-keys": []
},
"description": {
"type": "string",
"description": "Project description. Max length: 256 chars.",
"x-example": "<DESCRIPTION>"
},
"logo": {
"type": "string",
"description": "Project logo.",
"x-example": "<LOGO>"
},
"url": {
"type": "string",
"description": "Project URL.",
"x-example": "https:\/\/example.com",
"format": "url"
},
"legalName": {
"type": "string",
"description": "Project legal Name. Max length: 256 chars.",
"x-example": "<LEGAL_NAME>"
},
"legalCountry": {
"type": "string",
"description": "Project legal Country. Max length: 256 chars.",
"x-example": "<LEGAL_COUNTRY>"
},
"legalState": {
"type": "string",
"description": "Project legal State. Max length: 256 chars.",
"x-example": "<LEGAL_STATE>"
},
"legalCity": {
"type": "string",
"description": "Project legal City. Max length: 256 chars.",
"x-example": "<LEGAL_CITY>"
},
"legalAddress": {
"type": "string",
"description": "Project legal Address. Max length: 256 chars.",
"x-example": "<LEGAL_ADDRESS>"
},
"legalTaxId": {
"type": "string",
"description": "Project legal Tax ID. Max length: 256 chars.",
"x-example": "<LEGAL_TAX_ID>"
}
},
"required": [
"projectId",
"name",
"teamId"
]
}
}
}
}
}
},
"\/projects\/{projectId}": {
"get": {
"summary": "Get project",
"operationId": "projectsGet",
"tags": [
"projects"
],
"description": "Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": "projects",
"weight": 57,
"cookies": false,
"type": "",
"demo": "projects\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Update project",
"operationId": "projectsUpdate",
"tags": [
"projects"
],
"description": "Update a project by its unique ID.",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "update",
"group": "projects",
"weight": 413,
"cookies": false,
"type": "",
"demo": "projects\/update.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Project name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"description": {
"type": "string",
"description": "Project description. Max length: 256 chars.",
"x-example": "<DESCRIPTION>"
},
"logo": {
"type": "string",
"description": "Project logo.",
"x-example": "<LOGO>"
},
"url": {
"type": "string",
"description": "Project URL.",
"x-example": "https:\/\/example.com",
"format": "url"
},
"legalName": {
"type": "string",
"description": "Project legal name. Max length: 256 chars.",
"x-example": "<LEGAL_NAME>"
},
"legalCountry": {
"type": "string",
"description": "Project legal country. Max length: 256 chars.",
"x-example": "<LEGAL_COUNTRY>"
},
"legalState": {
"type": "string",
"description": "Project legal state. Max length: 256 chars.",
"x-example": "<LEGAL_STATE>"
},
"legalCity": {
"type": "string",
"description": "Project legal city. Max length: 256 chars.",
"x-example": "<LEGAL_CITY>"
},
"legalAddress": {
"type": "string",
"description": "Project legal address. Max length: 256 chars.",
"x-example": "<LEGAL_ADDRESS>"
},
"legalTaxId": {
"type": "string",
"description": "Project legal tax ID. Max length: 256 chars.",
"x-example": "<LEGAL_TAX_ID>"
}
},
"required": [
"name"
]
}
}
}
}
},
"delete": {
"summary": "Delete project",
"operationId": "projectsDelete",
"tags": [
"projects"
],
"description": "Delete a project by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "projects",
"weight": 73,
"cookies": false,
"type": "",
"demo": "projects\/delete.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
]
}
},
"\/projects\/{projectId}\/api": {
"patch": {
"summary": "Update API status",
"operationId": "projectsUpdateApiStatus",
"tags": [
"projects"
],
"description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateApiStatus",
"group": "projects",
"weight": 60,
"cookies": false,
"type": "",
"demo": "projects\/update-api-status.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.updateAPIStatus"
},
"methods": [
{
"name": "updateApiStatus",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"api",
"status"
],
"required": [
"projectId",
"api",
"status"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/project"
}
],
"description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.",
"demo": "projects\/update-api-status.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.updateAPIStatus"
}
},
{
"name": "updateAPIStatus",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"api",
"status"
],
"required": [
"projectId",
"api",
"status"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/project"
}
],
"description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.",
"demo": "projects\/update-api-status.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"api": {
"type": "string",
"description": "API name.",
"x-example": "rest",
"enum": [
"rest",
"graphql",
"realtime"
],
"x-enum-name": null,
"x-enum-keys": []
},
"status": {
"type": "boolean",
"description": "API status.",
"x-example": false
}
},
"required": [
"api",
"status"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/api\/all": {
"patch": {
"summary": "Update all API status",
"operationId": "projectsUpdateApiStatusAll",
"tags": [
"projects"
],
"description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateApiStatusAll",
"group": "projects",
"weight": 61,
"cookies": false,
"type": "",
"demo": "projects\/update-api-status-all.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status-all.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.updateAPIStatusAll"
},
"methods": [
{
"name": "updateApiStatusAll",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"status"
],
"required": [
"projectId",
"status"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/project"
}
],
"description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.",
"demo": "projects\/update-api-status-all.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.updateAPIStatusAll"
}
},
{
"name": "updateAPIStatusAll",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"status"
],
"required": [
"projectId",
"status"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/project"
}
],
"description": "Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.",
"demo": "projects\/update-api-status-all.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "boolean",
"description": "API status.",
"x-example": false
}
},
"required": [
"status"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/duration": {
"patch": {
"summary": "Update project authentication duration",
"operationId": "projectsUpdateAuthDuration",
"tags": [
"projects"
],
"description": "Update how long sessions created within a project should stay active for.",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateAuthDuration",
"group": "auth",
"weight": 66,
"cookies": false,
"type": "",
"demo": "projects\/update-auth-duration.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-duration.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"duration": {
"type": "integer",
"description": "Project session length in seconds. Max length: 31536000 seconds.",
"x-example": 0,
"format": "int32"
}
},
"required": [
"duration"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/limit": {
"patch": {
"summary": "Update project users limit",
"operationId": "projectsUpdateAuthLimit",
"tags": [
"projects"
],
"description": "Update the maximum number of users allowed in this project. Set to 0 for unlimited users. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateAuthLimit",
"group": "auth",
"weight": 65,
"cookies": false,
"type": "",
"demo": "projects\/update-auth-limit.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-limit.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Set the max number of users allowed in this project. Use 0 for unlimited.",
"x-example": 0,
"format": "int32"
}
},
"required": [
"limit"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/max-sessions": {
"patch": {
"summary": "Update project user sessions limit",
"operationId": "projectsUpdateAuthSessionsLimit",
"tags": [
"projects"
],
"description": "Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateAuthSessionsLimit",
"group": "auth",
"weight": 71,
"cookies": false,
"type": "",
"demo": "projects\/update-auth-sessions-limit.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-sessions-limit.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Set the max number of users allowed in this project. Value allowed is between 1-100. Default is 10",
"x-example": 1,
"format": "int32"
}
},
"required": [
"limit"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/memberships-privacy": {
"patch": {
"summary": "Update project memberships privacy attributes",
"operationId": "projectsUpdateMembershipsPrivacy",
"tags": [
"projects"
],
"description": "Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateMembershipsPrivacy",
"group": "auth",
"weight": 64,
"cookies": false,
"type": "",
"demo": "projects\/update-memberships-privacy.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-memberships-privacy.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userName": {
"type": "boolean",
"description": "Set to true to show userName to members of a team.",
"x-example": false
},
"userEmail": {
"type": "boolean",
"description": "Set to true to show email to members of a team.",
"x-example": false
},
"mfa": {
"type": "boolean",
"description": "Set to true to show mfa to members of a team.",
"x-example": false
}
},
"required": [
"userName",
"userEmail",
"mfa"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/mock-numbers": {
"patch": {
"summary": "Update the mock numbers for the project",
"operationId": "projectsUpdateMockNumbers",
"tags": [
"projects"
],
"description": "Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateMockNumbers",
"group": "auth",
"weight": 72,
"cookies": false,
"type": "",
"demo": "projects\/update-mock-numbers.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-mock-numbers.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"numbers": {
"type": "array",
"description": "An array of mock numbers and their corresponding verification codes (OTPs). Each number should be a valid E.164 formatted phone number. Maximum of 10 numbers are allowed.",
"x-example": null,
"items": {
"type": "object"
}
}
},
"required": [
"numbers"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/password-dictionary": {
"patch": {
"summary": "Update authentication password dictionary status. Use this endpoint to enable or disable the dicitonary check for user password",
"operationId": "projectsUpdateAuthPasswordDictionary",
"tags": [
"projects"
],
"description": "Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateAuthPasswordDictionary",
"group": "auth",
"weight": 69,
"cookies": false,
"type": "",
"demo": "projects\/update-auth-password-dictionary.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-dictionary.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Set whether or not to enable checking user's password against most commonly used passwords. Default is false.",
"x-example": false
}
},
"required": [
"enabled"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/password-history": {
"patch": {
"summary": "Update authentication password history. Use this endpoint to set the number of password history to save and 0 to disable password history.",
"operationId": "projectsUpdateAuthPasswordHistory",
"tags": [
"projects"
],
"description": "Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateAuthPasswordHistory",
"group": "auth",
"weight": 68,
"cookies": false,
"type": "",
"demo": "projects\/update-auth-password-history.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-history.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"limit": {
"type": "integer",
"description": "Set the max number of passwords to store in user history. User can't choose a new password that is already stored in the password history list. Max number of passwords allowed in history is20. Default value is 0",
"x-example": 0,
"format": "int32"
}
},
"required": [
"limit"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/personal-data": {
"patch": {
"summary": "Update personal data check",
"operationId": "projectsUpdatePersonalDataCheck",
"tags": [
"projects"
],
"description": "Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePersonalDataCheck",
"group": "auth",
"weight": 70,
"cookies": false,
"type": "",
"demo": "projects\/update-personal-data-check.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-personal-data-check.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Set whether or not to check a password for similarity with personal data. Default is false.",
"x-example": false
}
},
"required": [
"enabled"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/session-alerts": {
"patch": {
"summary": "Update project sessions emails",
"operationId": "projectsUpdateSessionAlerts",
"tags": [
"projects"
],
"description": "Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateSessionAlerts",
"group": "auth",
"weight": 63,
"cookies": false,
"type": "",
"demo": "projects\/update-session-alerts.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-alerts.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"alerts": {
"type": "boolean",
"description": "Set to true to enable session emails.",
"x-example": false
}
},
"required": [
"alerts"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/session-invalidation": {
"patch": {
"summary": "Update invalidate session option of the project",
"operationId": "projectsUpdateSessionInvalidation",
"tags": [
"projects"
],
"description": "Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateSessionInvalidation",
"group": "auth",
"weight": 99,
"cookies": false,
"type": "",
"demo": "projects\/update-session-invalidation.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-invalidation.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change",
"x-example": false
}
},
"required": [
"enabled"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/auth\/{method}": {
"patch": {
"summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.",
"operationId": "projectsUpdateAuthStatus",
"tags": [
"projects"
],
"description": "Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateAuthStatus",
"group": "auth",
"weight": 67,
"cookies": false,
"type": "",
"demo": "projects\/update-auth-status.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-status.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "method",
"description": "Auth Method. Possible values: email-password,magic-url,email-otp,anonymous,invites,jwt,phone",
"required": true,
"schema": {
"type": "string",
"x-example": "email-password",
"enum": [
"email-password",
"magic-url",
"email-otp",
"anonymous",
"invites",
"jwt",
"phone"
],
"x-enum-name": "AuthMethod",
"x-enum-keys": []
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "boolean",
"description": "Set the status of this auth method.",
"x-example": false
}
},
"required": [
"status"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/dev-keys": {
"get": {
"summary": "List dev keys",
"operationId": "projectsListDevKeys",
"tags": [
"projects"
],
"description": "List all the project\\'s dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.'",
"responses": {
"200": {
"description": "Dev Keys List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/devKeyList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listDevKeys",
"group": "devKeys",
"weight": 410,
"cookies": false,
"type": "",
"demo": "projects\/list-dev-keys.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "devKeys.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"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: accessedAt, expire",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
},
"post": {
"summary": "Create dev key",
"operationId": "projectsCreateDevKey",
"tags": [
"projects"
],
"description": "Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only.",
"responses": {
"201": {
"description": "DevKey",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/devKey"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createDevKey",
"group": "devKeys",
"weight": 407,
"cookies": false,
"type": "",
"demo": "projects\/create-dev-key.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "devKeys.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Key name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"expire": {
"type": "string",
"description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.",
"x-example": null
}
},
"required": [
"name",
"expire"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/dev-keys\/{keyId}": {
"get": {
"summary": "Get dev key",
"operationId": "projectsGetDevKey",
"tags": [
"projects"
],
"description": "Get a project\\'s dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development.",
"responses": {
"200": {
"description": "DevKey",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/devKey"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getDevKey",
"group": "devKeys",
"weight": 409,
"cookies": false,
"type": "",
"demo": "projects\/get-dev-key.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "devKeys.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "keyId",
"description": "Key unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<KEY_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update dev key",
"operationId": "projectsUpdateDevKey",
"tags": [
"projects"
],
"description": "Update a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'",
"responses": {
"200": {
"description": "DevKey",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/devKey"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateDevKey",
"group": "devKeys",
"weight": 408,
"cookies": false,
"type": "",
"demo": "projects\/update-dev-key.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "devKeys.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "keyId",
"description": "Key unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<KEY_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Key name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"expire": {
"type": "string",
"description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format.",
"x-example": null
}
},
"required": [
"name",
"expire"
]
}
}
}
}
},
"delete": {
"summary": "Delete dev key",
"operationId": "projectsDeleteDevKey",
"tags": [
"projects"
],
"description": "Delete a project\\'s dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteDevKey",
"group": "devKeys",
"weight": 411,
"cookies": false,
"type": "",
"demo": "projects\/delete-dev-key.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "devKeys.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "keyId",
"description": "Key unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<KEY_ID>"
},
"in": "path"
}
]
}
},
"\/projects\/{projectId}\/jwts": {
"post": {
"summary": "Create JWT",
"operationId": "projectsCreateJWT",
"tags": [
"projects"
],
"description": "Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time. ",
"responses": {
"201": {
"description": "JWT",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/jwt"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createJWT",
"group": "auth",
"weight": 85,
"cookies": false,
"type": "",
"demo": "projects\/create-jwt.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-jwt.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"scopes": {
"type": "array",
"description": "List of scopes allowed for JWT key. Maximum of 100 scopes are allowed.",
"x-example": null,
"items": {
"type": "string",
"enum": [
"sessions.write",
"users.read",
"users.write",
"teams.read",
"teams.write",
"databases.read",
"databases.write",
"collections.read",
"collections.write",
"tables.read",
"tables.write",
"attributes.read",
"attributes.write",
"columns.read",
"columns.write",
"indexes.read",
"indexes.write",
"documents.read",
"documents.write",
"rows.read",
"rows.write",
"files.read",
"files.write",
"buckets.read",
"buckets.write",
"functions.read",
"functions.write",
"sites.read",
"sites.write",
"log.read",
"log.write",
"execution.read",
"execution.write",
"locale.read",
"avatars.read",
"health.read",
"providers.read",
"providers.write",
"messages.read",
"messages.write",
"topics.read",
"topics.write",
"subscribers.read",
"subscribers.write",
"targets.read",
"targets.write",
"rules.read",
"rules.write",
"migrations.read",
"migrations.write",
"vcs.read",
"vcs.write",
"assistant.read",
"tokens.read",
"tokens.write"
],
"x-enum-name": null,
"x-enum-keys": []
}
},
"duration": {
"type": "integer",
"description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.",
"x-example": 0,
"format": "int32"
}
},
"required": [
"scopes"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/keys": {
"get": {
"summary": "List keys",
"operationId": "projectsListKeys",
"tags": [
"projects"
],
"description": "Get a list of all API keys from the current project. ",
"responses": {
"200": {
"description": "API Keys List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/keyList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listKeys",
"group": "keys",
"weight": 81,
"cookies": false,
"type": "",
"demo": "projects\/list-keys.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "keys.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-keys.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"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: expire, accessedAt, name, scopes",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create key",
"operationId": "projectsCreateKey",
"tags": [
"projects"
],
"description": "Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.",
"responses": {
"201": {
"description": "Key",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/key"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createKey",
"group": "keys",
"weight": 80,
"cookies": false,
"type": "",
"demo": "projects\/create-key.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "keys.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-key.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"keyId": {
"type": "string",
"description": "Key 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.",
"x-example": "<KEY_ID>"
},
"name": {
"type": "string",
"description": "Key name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"scopes": {
"type": "array",
"description": "Key scopes list. Maximum of 100 scopes are allowed.",
"x-example": null,
"items": {
"type": "string",
"enum": [
"sessions.write",
"users.read",
"users.write",
"teams.read",
"teams.write",
"databases.read",
"databases.write",
"collections.read",
"collections.write",
"tables.read",
"tables.write",
"attributes.read",
"attributes.write",
"columns.read",
"columns.write",
"indexes.read",
"indexes.write",
"documents.read",
"documents.write",
"rows.read",
"rows.write",
"files.read",
"files.write",
"buckets.read",
"buckets.write",
"functions.read",
"functions.write",
"sites.read",
"sites.write",
"log.read",
"log.write",
"execution.read",
"execution.write",
"locale.read",
"avatars.read",
"health.read",
"providers.read",
"providers.write",
"messages.read",
"messages.write",
"topics.read",
"topics.write",
"subscribers.read",
"subscribers.write",
"targets.read",
"targets.write",
"rules.read",
"rules.write",
"migrations.read",
"migrations.write",
"vcs.read",
"vcs.write",
"assistant.read",
"tokens.read",
"tokens.write"
],
"x-enum-name": null,
"x-enum-keys": []
},
"x-nullable": true
},
"expire": {
"type": "string",
"description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"name",
"scopes"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/keys\/{keyId}": {
"get": {
"summary": "Get key",
"operationId": "projectsGetKey",
"tags": [
"projects"
],
"description": "Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.",
"responses": {
"200": {
"description": "Key",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/key"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getKey",
"group": "keys",
"weight": 82,
"cookies": false,
"type": "",
"demo": "projects\/get-key.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "keys.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-key.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "keyId",
"description": "Key unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<KEY_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update key",
"operationId": "projectsUpdateKey",
"tags": [
"projects"
],
"description": "Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key. ",
"responses": {
"200": {
"description": "Key",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/key"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateKey",
"group": "keys",
"weight": 83,
"cookies": false,
"type": "",
"demo": "projects\/update-key.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "keys.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-key.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "keyId",
"description": "Key unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<KEY_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Key name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"scopes": {
"type": "array",
"description": "Key scopes list. Maximum of 100 events are allowed.",
"x-example": null,
"items": {
"type": "string",
"enum": [
"sessions.write",
"users.read",
"users.write",
"teams.read",
"teams.write",
"databases.read",
"databases.write",
"collections.read",
"collections.write",
"tables.read",
"tables.write",
"attributes.read",
"attributes.write",
"columns.read",
"columns.write",
"indexes.read",
"indexes.write",
"documents.read",
"documents.write",
"rows.read",
"rows.write",
"files.read",
"files.write",
"buckets.read",
"buckets.write",
"functions.read",
"functions.write",
"sites.read",
"sites.write",
"log.read",
"log.write",
"execution.read",
"execution.write",
"locale.read",
"avatars.read",
"health.read",
"providers.read",
"providers.write",
"messages.read",
"messages.write",
"topics.read",
"topics.write",
"subscribers.read",
"subscribers.write",
"targets.read",
"targets.write",
"rules.read",
"rules.write",
"migrations.read",
"migrations.write",
"vcs.read",
"vcs.write",
"assistant.read",
"tokens.read",
"tokens.write"
],
"x-enum-name": null,
"x-enum-keys": []
},
"x-nullable": true
},
"expire": {
"type": "string",
"description": "Expiration time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Use null for unlimited expiration.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"name",
"scopes"
]
}
}
}
}
},
"delete": {
"summary": "Delete key",
"operationId": "projectsDeleteKey",
"tags": [
"projects"
],
"description": "Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls. ",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteKey",
"group": "keys",
"weight": 84,
"cookies": false,
"type": "",
"demo": "projects\/delete-key.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "keys.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-key.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "keyId",
"description": "Key unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<KEY_ID>"
},
"in": "path"
}
]
}
},
"\/projects\/{projectId}\/labels": {
"put": {
"summary": "Update project labels",
"operationId": "projectsUpdateLabels",
"tags": [
"projects"
],
"description": "Update the project labels by its unique ID. Labels can be used to easily filter projects in an organization.",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateLabels",
"group": "projects",
"weight": 415,
"cookies": false,
"type": "",
"demo": "projects\/update-labels.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"description": "Array of project labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.",
"x-example": null,
"items": {
"type": "string"
}
}
},
"required": [
"labels"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/oauth2": {
"patch": {
"summary": "Update project OAuth2",
"operationId": "projectsUpdateOAuth2",
"tags": [
"projects"
],
"description": "Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable\/disable providers. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateOAuth2",
"group": "auth",
"weight": 62,
"cookies": false,
"type": "",
"demo": "projects\/update-o-auth-2.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-oauth2.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"description": "Provider Name",
"x-example": "amazon",
"enum": [
"amazon",
"apple",
"auth0",
"authentik",
"autodesk",
"bitbucket",
"bitly",
"box",
"dailymotion",
"discord",
"disqus",
"dropbox",
"etsy",
"facebook",
"figma",
"github",
"gitlab",
"google",
"linkedin",
"microsoft",
"notion",
"oidc",
"okta",
"paypal",
"paypalSandbox",
"podio",
"salesforce",
"slack",
"spotify",
"stripe",
"tradeshift",
"tradeshiftBox",
"twitch",
"wordpress",
"yahoo",
"yammer",
"yandex",
"zoho",
"zoom"
],
"x-enum-name": "OAuthProvider",
"x-enum-keys": []
},
"appId": {
"type": "string",
"description": "Provider app ID. Max length: 256 chars.",
"x-example": "<APP_ID>",
"x-nullable": true
},
"secret": {
"type": "string",
"description": "Provider secret key. Max length: 512 chars.",
"x-example": "<SECRET>",
"x-nullable": true
},
"enabled": {
"type": "boolean",
"description": "Provider status. Set to 'false' to disable new session creation.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"provider"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/platforms": {
"get": {
"summary": "List platforms",
"operationId": "projectsListPlatforms",
"tags": [
"projects"
],
"description": "Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations. ",
"responses": {
"200": {
"description": "Platforms List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/platformList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listPlatforms",
"group": "platforms",
"weight": 87,
"cookies": false,
"type": "",
"demo": "projects\/list-platforms.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "platforms.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-platforms.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "total",
"description": "When set to false, the total count returned will be 0 and will not be calculated.",
"required": false,
"schema": {
"type": "boolean",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create platform",
"operationId": "projectsCreatePlatform",
"tags": [
"projects"
],
"description": "Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.",
"responses": {
"201": {
"description": "Platform",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/platform"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createPlatform",
"group": "platforms",
"weight": 86,
"cookies": false,
"type": "",
"demo": "projects\/create-platform.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "platforms.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-platform.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.",
"x-example": "web",
"enum": [
"web",
"flutter-web",
"flutter-ios",
"flutter-android",
"flutter-linux",
"flutter-macos",
"flutter-windows",
"apple-ios",
"apple-macos",
"apple-watchos",
"apple-tvos",
"android",
"unity",
"react-native-ios",
"react-native-android"
],
"x-enum-name": "PlatformType",
"x-enum-keys": []
},
"name": {
"type": "string",
"description": "Platform name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"key": {
"type": "string",
"description": "Package name for Android or bundle ID for iOS or macOS. Max length: 256 chars.",
"x-example": "<KEY>"
},
"store": {
"type": "string",
"description": "App store or Google Play store ID. Max length: 256 chars.",
"x-example": "<STORE>"
},
"hostname": {
"type": "string",
"description": "Platform client hostname. Max length: 256 chars.",
"x-example": null
}
},
"required": [
"type",
"name"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/platforms\/{platformId}": {
"get": {
"summary": "Get platform",
"operationId": "projectsGetPlatform",
"tags": [
"projects"
],
"description": "Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations. ",
"responses": {
"200": {
"description": "Platform",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/platform"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getPlatform",
"group": "platforms",
"weight": 88,
"cookies": false,
"type": "",
"demo": "projects\/get-platform.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "platforms.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-platform.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "platformId",
"description": "Platform unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PLATFORM_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update platform",
"operationId": "projectsUpdatePlatform",
"tags": [
"projects"
],
"description": "Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname. ",
"responses": {
"200": {
"description": "Platform",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/platform"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePlatform",
"group": "platforms",
"weight": 89,
"cookies": false,
"type": "",
"demo": "projects\/update-platform.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "platforms.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-platform.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "platformId",
"description": "Platform unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PLATFORM_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Platform name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"key": {
"type": "string",
"description": "Package name for android or bundle ID for iOS. Max length: 256 chars.",
"x-example": "<KEY>"
},
"store": {
"type": "string",
"description": "App store or Google Play store ID. Max length: 256 chars.",
"x-example": "<STORE>"
},
"hostname": {
"type": "string",
"description": "Platform client URL. Max length: 256 chars.",
"x-example": null
}
},
"required": [
"name"
]
}
}
}
}
},
"delete": {
"summary": "Delete platform",
"operationId": "projectsDeletePlatform",
"tags": [
"projects"
],
"description": "Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project. ",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deletePlatform",
"group": "platforms",
"weight": 90,
"cookies": false,
"type": "",
"demo": "projects\/delete-platform.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "platforms.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-platform.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "platformId",
"description": "Platform unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PLATFORM_ID>"
},
"in": "path"
}
]
}
},
"\/projects\/{projectId}\/service": {
"patch": {
"summary": "Update service status",
"operationId": "projectsUpdateServiceStatus",
"tags": [
"projects"
],
"description": "Update the status of a specific service. Use this endpoint to enable or disable a service in your project. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateServiceStatus",
"group": "projects",
"weight": 58,
"cookies": false,
"type": "",
"demo": "projects\/update-service-status.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-service-status.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"service": {
"type": "string",
"description": "Service name.",
"x-example": "account",
"enum": [
"account",
"avatars",
"databases",
"tablesdb",
"locale",
"health",
"storage",
"teams",
"users",
"sites",
"functions",
"graphql",
"messaging"
],
"x-enum-name": "ApiService",
"x-enum-keys": []
},
"status": {
"type": "boolean",
"description": "Service status.",
"x-example": false
}
},
"required": [
"service",
"status"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/service\/all": {
"patch": {
"summary": "Update all service status",
"operationId": "projectsUpdateServiceStatusAll",
"tags": [
"projects"
],
"description": "Update the status of all services. Use this endpoint to enable or disable all optional services at once. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateServiceStatusAll",
"group": "projects",
"weight": 59,
"cookies": false,
"type": "",
"demo": "projects\/update-service-status-all.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-service-status-all.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "boolean",
"description": "Service status.",
"x-example": false
}
},
"required": [
"status"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/smtp": {
"patch": {
"summary": "Update SMTP",
"operationId": "projectsUpdateSmtp",
"tags": [
"projects"
],
"description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails. ",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateSmtp",
"group": "templates",
"weight": 91,
"cookies": false,
"type": "",
"demo": "projects\/update-smtp.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-smtp.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.updateSMTP"
},
"methods": [
{
"name": "updateSmtp",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"enabled",
"senderName",
"senderEmail",
"replyTo",
"host",
"port",
"username",
"password",
"secure"
],
"required": [
"projectId",
"enabled"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/project"
}
],
"description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails. ",
"demo": "projects\/update-smtp.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.updateSMTP"
}
},
{
"name": "updateSMTP",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"enabled",
"senderName",
"senderEmail",
"replyTo",
"host",
"port",
"username",
"password",
"secure"
],
"required": [
"projectId",
"enabled"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/project"
}
],
"description": "Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails. ",
"demo": "projects\/update-smtp.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"enabled": {
"type": "boolean",
"description": "Enable custom SMTP service",
"x-example": false
},
"senderName": {
"type": "string",
"description": "Name of the email sender",
"x-example": "<SENDER_NAME>"
},
"senderEmail": {
"type": "string",
"description": "Email of the sender",
"x-example": "email@example.com",
"format": "email"
},
"replyTo": {
"type": "string",
"description": "Reply to email",
"x-example": "email@example.com",
"format": "email"
},
"host": {
"type": "string",
"description": "SMTP server host name",
"x-example": null
},
"port": {
"type": "integer",
"description": "SMTP server port",
"x-example": null,
"format": "int32"
},
"username": {
"type": "string",
"description": "SMTP server username",
"x-example": "<USERNAME>"
},
"password": {
"type": "string",
"description": "SMTP server password",
"x-example": "<PASSWORD>"
},
"secure": {
"type": "string",
"description": "Does SMTP server use secure connection",
"x-example": "tls",
"enum": [
"tls",
"ssl"
],
"x-enum-name": "SMTPSecure",
"x-enum-keys": []
}
},
"required": [
"enabled"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/smtp\/tests": {
"post": {
"summary": "Create SMTP test",
"operationId": "projectsCreateSmtpTest",
"tags": [
"projects"
],
"description": "Send a test email to verify SMTP configuration. ",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": true,
"x-appwrite": {
"method": "createSmtpTest",
"group": "templates",
"weight": 92,
"cookies": false,
"type": "",
"demo": "projects\/create-smtp-test.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-smtp-test.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.createSMTPTest"
},
"methods": [
{
"name": "createSmtpTest",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"emails",
"senderName",
"senderEmail",
"replyTo",
"host",
"port",
"username",
"password",
"secure"
],
"required": [
"projectId",
"emails",
"senderName",
"senderEmail",
"host"
],
"responses": [
{
"code": 204
}
],
"description": "Send a test email to verify SMTP configuration. ",
"demo": "projects\/create-smtp-test.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.createSMTPTest"
}
},
{
"name": "createSMTPTest",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"emails",
"senderName",
"senderEmail",
"replyTo",
"host",
"port",
"username",
"password",
"secure"
],
"required": [
"projectId",
"emails",
"senderName",
"senderEmail",
"host"
],
"responses": [
{
"code": 204
}
],
"description": "Send a test email to verify SMTP configuration. ",
"demo": "projects\/create-smtp-test.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"emails": {
"type": "array",
"description": "Array of emails to send test email to. Maximum of 10 emails are allowed.",
"x-example": null,
"items": {
"type": "string"
}
},
"senderName": {
"type": "string",
"description": "Name of the email sender",
"x-example": "<SENDER_NAME>"
},
"senderEmail": {
"type": "string",
"description": "Email of the sender",
"x-example": "email@example.com",
"format": "email"
},
"replyTo": {
"type": "string",
"description": "Reply to email",
"x-example": "email@example.com",
"format": "email"
},
"host": {
"type": "string",
"description": "SMTP server host name",
"x-example": null
},
"port": {
"type": "integer",
"description": "SMTP server port",
"x-example": null,
"format": "int32"
},
"username": {
"type": "string",
"description": "SMTP server username",
"x-example": "<USERNAME>"
},
"password": {
"type": "string",
"description": "SMTP server password",
"x-example": "<PASSWORD>"
},
"secure": {
"type": "string",
"description": "Does SMTP server use secure connection",
"x-example": "tls",
"enum": [
"tls",
"ssl"
],
"x-enum-name": "SMTPSecure",
"x-enum-keys": []
}
},
"required": [
"emails",
"senderName",
"senderEmail",
"host"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/team": {
"patch": {
"summary": "Update project team",
"operationId": "projectsUpdateTeam",
"tags": [
"projects"
],
"description": "Update the team ID of a project allowing for it to be transferred to another team.",
"responses": {
"200": {
"description": "Project",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/project"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTeam",
"group": "projects",
"weight": 416,
"cookies": false,
"type": "",
"demo": "projects\/update-team.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-team.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"teamId": {
"type": "string",
"description": "Team ID of the team to transfer project to.",
"x-example": "<TEAM_ID>"
}
},
"required": [
"teamId"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/templates\/email\/{type}\/{locale}": {
"get": {
"summary": "Get custom email template",
"operationId": "projectsGetEmailTemplate",
"tags": [
"projects"
],
"description": "Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details. ",
"responses": {
"200": {
"description": "EmailTemplate",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/emailTemplate"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getEmailTemplate",
"group": "templates",
"weight": 94,
"cookies": false,
"type": "",
"demo": "projects\/get-email-template.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-email-template.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "type",
"description": "Template type",
"required": true,
"schema": {
"type": "string",
"x-example": "verification",
"enum": [
"verification",
"magicsession",
"recovery",
"invitation",
"mfachallenge",
"sessionalert",
"otpsession"
],
"x-enum-name": "EmailTemplateType",
"x-enum-keys": []
},
"in": "path"
},
{
"name": "locale",
"description": "Template locale",
"required": true,
"schema": {
"type": "string",
"x-example": "af",
"enum": [
"af",
"ar-ae",
"ar-bh",
"ar-dz",
"ar-eg",
"ar-iq",
"ar-jo",
"ar-kw",
"ar-lb",
"ar-ly",
"ar-ma",
"ar-om",
"ar-qa",
"ar-sa",
"ar-sy",
"ar-tn",
"ar-ye",
"as",
"az",
"be",
"bg",
"bh",
"bn",
"bs",
"ca",
"cs",
"cy",
"da",
"de",
"de-at",
"de-ch",
"de-li",
"de-lu",
"el",
"en",
"en-au",
"en-bz",
"en-ca",
"en-gb",
"en-ie",
"en-jm",
"en-nz",
"en-tt",
"en-us",
"en-za",
"eo",
"es",
"es-ar",
"es-bo",
"es-cl",
"es-co",
"es-cr",
"es-do",
"es-ec",
"es-gt",
"es-hn",
"es-mx",
"es-ni",
"es-pa",
"es-pe",
"es-pr",
"es-py",
"es-sv",
"es-uy",
"es-ve",
"et",
"eu",
"fa",
"fi",
"fo",
"fr",
"fr-be",
"fr-ca",
"fr-ch",
"fr-lu",
"ga",
"gd",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"it-ch",
"ja",
"ji",
"ko",
"ku",
"lt",
"lv",
"mk",
"ml",
"ms",
"mt",
"nb",
"ne",
"nl",
"nl-be",
"nn",
"no",
"pa",
"pl",
"pt",
"pt-br",
"rm",
"ro",
"ro-md",
"ru",
"ru-md",
"sb",
"sk",
"sl",
"sq",
"sr",
"sv",
"sv-fi",
"th",
"tn",
"tr",
"ts",
"ua",
"ur",
"ve",
"vi",
"xh",
"zh-cn",
"zh-hk",
"zh-sg",
"zh-tw",
"zu"
],
"x-enum-name": "EmailTemplateLocale",
"x-enum-keys": []
},
"in": "path"
}
]
},
"patch": {
"summary": "Update custom email templates",
"operationId": "projectsUpdateEmailTemplate",
"tags": [
"projects"
],
"description": "Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.",
"responses": {
"200": {
"description": "EmailTemplate",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/emailTemplate"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateEmailTemplate",
"group": "templates",
"weight": 96,
"cookies": false,
"type": "",
"demo": "projects\/update-email-template.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-email-template.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "type",
"description": "Template type",
"required": true,
"schema": {
"type": "string",
"x-example": "verification",
"enum": [
"verification",
"magicsession",
"recovery",
"invitation",
"mfachallenge",
"sessionalert",
"otpsession"
],
"x-enum-name": "EmailTemplateType",
"x-enum-keys": []
},
"in": "path"
},
{
"name": "locale",
"description": "Template locale",
"required": true,
"schema": {
"type": "string",
"x-example": "af",
"enum": [
"af",
"ar-ae",
"ar-bh",
"ar-dz",
"ar-eg",
"ar-iq",
"ar-jo",
"ar-kw",
"ar-lb",
"ar-ly",
"ar-ma",
"ar-om",
"ar-qa",
"ar-sa",
"ar-sy",
"ar-tn",
"ar-ye",
"as",
"az",
"be",
"bg",
"bh",
"bn",
"bs",
"ca",
"cs",
"cy",
"da",
"de",
"de-at",
"de-ch",
"de-li",
"de-lu",
"el",
"en",
"en-au",
"en-bz",
"en-ca",
"en-gb",
"en-ie",
"en-jm",
"en-nz",
"en-tt",
"en-us",
"en-za",
"eo",
"es",
"es-ar",
"es-bo",
"es-cl",
"es-co",
"es-cr",
"es-do",
"es-ec",
"es-gt",
"es-hn",
"es-mx",
"es-ni",
"es-pa",
"es-pe",
"es-pr",
"es-py",
"es-sv",
"es-uy",
"es-ve",
"et",
"eu",
"fa",
"fi",
"fo",
"fr",
"fr-be",
"fr-ca",
"fr-ch",
"fr-lu",
"ga",
"gd",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"it-ch",
"ja",
"ji",
"ko",
"ku",
"lt",
"lv",
"mk",
"ml",
"ms",
"mt",
"nb",
"ne",
"nl",
"nl-be",
"nn",
"no",
"pa",
"pl",
"pt",
"pt-br",
"rm",
"ro",
"ro-md",
"ru",
"ru-md",
"sb",
"sk",
"sl",
"sq",
"sr",
"sv",
"sv-fi",
"th",
"tn",
"tr",
"ts",
"ua",
"ur",
"ve",
"vi",
"xh",
"zh-cn",
"zh-hk",
"zh-sg",
"zh-tw",
"zu"
],
"x-enum-name": "EmailTemplateLocale",
"x-enum-keys": []
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"subject": {
"type": "string",
"description": "Email Subject",
"x-example": "<SUBJECT>"
},
"message": {
"type": "string",
"description": "Template message",
"x-example": "<MESSAGE>"
},
"senderName": {
"type": "string",
"description": "Name of the email sender",
"x-example": "<SENDER_NAME>"
},
"senderEmail": {
"type": "string",
"description": "Email of the sender",
"x-example": "email@example.com",
"format": "email"
},
"replyTo": {
"type": "string",
"description": "Reply to email",
"x-example": "email@example.com",
"format": "email"
}
},
"required": [
"subject",
"message"
]
}
}
}
}
},
"delete": {
"summary": "Delete custom email template",
"operationId": "projectsDeleteEmailTemplate",
"tags": [
"projects"
],
"description": "Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state. ",
"responses": {
"200": {
"description": "EmailTemplate",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/emailTemplate"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteEmailTemplate",
"group": "templates",
"weight": 98,
"cookies": false,
"type": "",
"demo": "projects\/delete-email-template.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-email-template.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "type",
"description": "Template type",
"required": true,
"schema": {
"type": "string",
"x-example": "verification",
"enum": [
"verification",
"magicsession",
"recovery",
"invitation",
"mfachallenge",
"sessionalert",
"otpsession"
],
"x-enum-name": "EmailTemplateType",
"x-enum-keys": []
},
"in": "path"
},
{
"name": "locale",
"description": "Template locale",
"required": true,
"schema": {
"type": "string",
"x-example": "af",
"enum": [
"af",
"ar-ae",
"ar-bh",
"ar-dz",
"ar-eg",
"ar-iq",
"ar-jo",
"ar-kw",
"ar-lb",
"ar-ly",
"ar-ma",
"ar-om",
"ar-qa",
"ar-sa",
"ar-sy",
"ar-tn",
"ar-ye",
"as",
"az",
"be",
"bg",
"bh",
"bn",
"bs",
"ca",
"cs",
"cy",
"da",
"de",
"de-at",
"de-ch",
"de-li",
"de-lu",
"el",
"en",
"en-au",
"en-bz",
"en-ca",
"en-gb",
"en-ie",
"en-jm",
"en-nz",
"en-tt",
"en-us",
"en-za",
"eo",
"es",
"es-ar",
"es-bo",
"es-cl",
"es-co",
"es-cr",
"es-do",
"es-ec",
"es-gt",
"es-hn",
"es-mx",
"es-ni",
"es-pa",
"es-pe",
"es-pr",
"es-py",
"es-sv",
"es-uy",
"es-ve",
"et",
"eu",
"fa",
"fi",
"fo",
"fr",
"fr-be",
"fr-ca",
"fr-ch",
"fr-lu",
"ga",
"gd",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"it-ch",
"ja",
"ji",
"ko",
"ku",
"lt",
"lv",
"mk",
"ml",
"ms",
"mt",
"nb",
"ne",
"nl",
"nl-be",
"nn",
"no",
"pa",
"pl",
"pt",
"pt-br",
"rm",
"ro",
"ro-md",
"ru",
"ru-md",
"sb",
"sk",
"sl",
"sq",
"sr",
"sv",
"sv-fi",
"th",
"tn",
"tr",
"ts",
"ua",
"ur",
"ve",
"vi",
"xh",
"zh-cn",
"zh-hk",
"zh-sg",
"zh-tw",
"zu"
],
"x-enum-name": "EmailTemplateLocale",
"x-enum-keys": []
},
"in": "path"
}
]
}
},
"\/projects\/{projectId}\/templates\/sms\/{type}\/{locale}": {
"get": {
"summary": "Get custom SMS template",
"operationId": "projectsGetSmsTemplate",
"tags": [
"projects"
],
"description": "Get a custom SMS template for the specified locale and type returning it's contents.",
"responses": {
"200": {
"description": "SmsTemplate",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/smsTemplate"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "getSmsTemplate",
"group": "templates",
"weight": 93,
"cookies": false,
"type": "",
"demo": "projects\/get-sms-template.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-sms-template.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.getSMSTemplate"
},
"methods": [
{
"name": "getSmsTemplate",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"type",
"locale"
],
"required": [
"projectId",
"type",
"locale"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/smsTemplate"
}
],
"description": "Get a custom SMS template for the specified locale and type returning it's contents.",
"demo": "projects\/get-sms-template.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.getSMSTemplate"
}
},
{
"name": "getSMSTemplate",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"type",
"locale"
],
"required": [
"projectId",
"type",
"locale"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/smsTemplate"
}
],
"description": "Get a custom SMS template for the specified locale and type returning it's contents.",
"demo": "projects\/get-sms-template.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "type",
"description": "Template type",
"required": true,
"schema": {
"type": "string",
"x-example": "verification",
"enum": [
"verification",
"login",
"invitation",
"mfachallenge"
],
"x-enum-name": "SmsTemplateType",
"x-enum-keys": []
},
"in": "path"
},
{
"name": "locale",
"description": "Template locale",
"required": true,
"schema": {
"type": "string",
"x-example": "af",
"enum": [
"af",
"ar-ae",
"ar-bh",
"ar-dz",
"ar-eg",
"ar-iq",
"ar-jo",
"ar-kw",
"ar-lb",
"ar-ly",
"ar-ma",
"ar-om",
"ar-qa",
"ar-sa",
"ar-sy",
"ar-tn",
"ar-ye",
"as",
"az",
"be",
"bg",
"bh",
"bn",
"bs",
"ca",
"cs",
"cy",
"da",
"de",
"de-at",
"de-ch",
"de-li",
"de-lu",
"el",
"en",
"en-au",
"en-bz",
"en-ca",
"en-gb",
"en-ie",
"en-jm",
"en-nz",
"en-tt",
"en-us",
"en-za",
"eo",
"es",
"es-ar",
"es-bo",
"es-cl",
"es-co",
"es-cr",
"es-do",
"es-ec",
"es-gt",
"es-hn",
"es-mx",
"es-ni",
"es-pa",
"es-pe",
"es-pr",
"es-py",
"es-sv",
"es-uy",
"es-ve",
"et",
"eu",
"fa",
"fi",
"fo",
"fr",
"fr-be",
"fr-ca",
"fr-ch",
"fr-lu",
"ga",
"gd",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"it-ch",
"ja",
"ji",
"ko",
"ku",
"lt",
"lv",
"mk",
"ml",
"ms",
"mt",
"nb",
"ne",
"nl",
"nl-be",
"nn",
"no",
"pa",
"pl",
"pt",
"pt-br",
"rm",
"ro",
"ro-md",
"ru",
"ru-md",
"sb",
"sk",
"sl",
"sq",
"sr",
"sv",
"sv-fi",
"th",
"tn",
"tr",
"ts",
"ua",
"ur",
"ve",
"vi",
"xh",
"zh-cn",
"zh-hk",
"zh-sg",
"zh-tw",
"zu"
],
"x-enum-name": "SmsTemplateLocale",
"x-enum-keys": []
},
"in": "path"
}
]
},
"patch": {
"summary": "Update custom SMS template",
"operationId": "projectsUpdateSmsTemplate",
"tags": [
"projects"
],
"description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ",
"responses": {
"200": {
"description": "SmsTemplate",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/smsTemplate"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateSmsTemplate",
"group": "templates",
"weight": 95,
"cookies": false,
"type": "",
"demo": "projects\/update-sms-template.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-sms-template.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.updateSMSTemplate"
},
"methods": [
{
"name": "updateSmsTemplate",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"type",
"locale",
"message"
],
"required": [
"projectId",
"type",
"locale",
"message"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/smsTemplate"
}
],
"description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ",
"demo": "projects\/update-sms-template.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.updateSMSTemplate"
}
},
{
"name": "updateSMSTemplate",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"type",
"locale",
"message"
],
"required": [
"projectId",
"type",
"locale",
"message"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/smsTemplate"
}
],
"description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ",
"demo": "projects\/update-sms-template.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "type",
"description": "Template type",
"required": true,
"schema": {
"type": "string",
"x-example": "verification",
"enum": [
"verification",
"login",
"invitation",
"mfachallenge"
],
"x-enum-name": "SmsTemplateType",
"x-enum-keys": []
},
"in": "path"
},
{
"name": "locale",
"description": "Template locale",
"required": true,
"schema": {
"type": "string",
"x-example": "af",
"enum": [
"af",
"ar-ae",
"ar-bh",
"ar-dz",
"ar-eg",
"ar-iq",
"ar-jo",
"ar-kw",
"ar-lb",
"ar-ly",
"ar-ma",
"ar-om",
"ar-qa",
"ar-sa",
"ar-sy",
"ar-tn",
"ar-ye",
"as",
"az",
"be",
"bg",
"bh",
"bn",
"bs",
"ca",
"cs",
"cy",
"da",
"de",
"de-at",
"de-ch",
"de-li",
"de-lu",
"el",
"en",
"en-au",
"en-bz",
"en-ca",
"en-gb",
"en-ie",
"en-jm",
"en-nz",
"en-tt",
"en-us",
"en-za",
"eo",
"es",
"es-ar",
"es-bo",
"es-cl",
"es-co",
"es-cr",
"es-do",
"es-ec",
"es-gt",
"es-hn",
"es-mx",
"es-ni",
"es-pa",
"es-pe",
"es-pr",
"es-py",
"es-sv",
"es-uy",
"es-ve",
"et",
"eu",
"fa",
"fi",
"fo",
"fr",
"fr-be",
"fr-ca",
"fr-ch",
"fr-lu",
"ga",
"gd",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"it-ch",
"ja",
"ji",
"ko",
"ku",
"lt",
"lv",
"mk",
"ml",
"ms",
"mt",
"nb",
"ne",
"nl",
"nl-be",
"nn",
"no",
"pa",
"pl",
"pt",
"pt-br",
"rm",
"ro",
"ro-md",
"ru",
"ru-md",
"sb",
"sk",
"sl",
"sq",
"sr",
"sv",
"sv-fi",
"th",
"tn",
"tr",
"ts",
"ua",
"ur",
"ve",
"vi",
"xh",
"zh-cn",
"zh-hk",
"zh-sg",
"zh-tw",
"zu"
],
"x-enum-name": "SmsTemplateLocale",
"x-enum-keys": []
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Template message",
"x-example": "<MESSAGE>"
}
},
"required": [
"message"
]
}
}
}
}
},
"delete": {
"summary": "Reset custom SMS template",
"operationId": "projectsDeleteSmsTemplate",
"tags": [
"projects"
],
"description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ",
"responses": {
"200": {
"description": "SmsTemplate",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/smsTemplate"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "deleteSmsTemplate",
"group": "templates",
"weight": 97,
"cookies": false,
"type": "",
"demo": "projects\/delete-sms-template.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-sms-template.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.deleteSMSTemplate"
},
"methods": [
{
"name": "deleteSmsTemplate",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"type",
"locale"
],
"required": [
"projectId",
"type",
"locale"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/smsTemplate"
}
],
"description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ",
"demo": "projects\/delete-sms-template.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "projects.deleteSMSTemplate"
}
},
{
"name": "deleteSMSTemplate",
"namespace": "projects",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"projectId",
"type",
"locale"
],
"required": [
"projectId",
"type",
"locale"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/smsTemplate"
}
],
"description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ",
"demo": "projects\/delete-sms-template.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "type",
"description": "Template type",
"required": true,
"schema": {
"type": "string",
"x-example": "verification",
"enum": [
"verification",
"login",
"invitation",
"mfachallenge"
],
"x-enum-name": "SmsTemplateType",
"x-enum-keys": []
},
"in": "path"
},
{
"name": "locale",
"description": "Template locale",
"required": true,
"schema": {
"type": "string",
"x-example": "af",
"enum": [
"af",
"ar-ae",
"ar-bh",
"ar-dz",
"ar-eg",
"ar-iq",
"ar-jo",
"ar-kw",
"ar-lb",
"ar-ly",
"ar-ma",
"ar-om",
"ar-qa",
"ar-sa",
"ar-sy",
"ar-tn",
"ar-ye",
"as",
"az",
"be",
"bg",
"bh",
"bn",
"bs",
"ca",
"cs",
"cy",
"da",
"de",
"de-at",
"de-ch",
"de-li",
"de-lu",
"el",
"en",
"en-au",
"en-bz",
"en-ca",
"en-gb",
"en-ie",
"en-jm",
"en-nz",
"en-tt",
"en-us",
"en-za",
"eo",
"es",
"es-ar",
"es-bo",
"es-cl",
"es-co",
"es-cr",
"es-do",
"es-ec",
"es-gt",
"es-hn",
"es-mx",
"es-ni",
"es-pa",
"es-pe",
"es-pr",
"es-py",
"es-sv",
"es-uy",
"es-ve",
"et",
"eu",
"fa",
"fi",
"fo",
"fr",
"fr-be",
"fr-ca",
"fr-ch",
"fr-lu",
"ga",
"gd",
"he",
"hi",
"hr",
"hu",
"id",
"is",
"it",
"it-ch",
"ja",
"ji",
"ko",
"ku",
"lt",
"lv",
"mk",
"ml",
"ms",
"mt",
"nb",
"ne",
"nl",
"nl-be",
"nn",
"no",
"pa",
"pl",
"pt",
"pt-br",
"rm",
"ro",
"ro-md",
"ru",
"ru-md",
"sb",
"sk",
"sl",
"sq",
"sr",
"sv",
"sv-fi",
"th",
"tn",
"tr",
"ts",
"ua",
"ur",
"ve",
"vi",
"xh",
"zh-cn",
"zh-hk",
"zh-sg",
"zh-tw",
"zu"
],
"x-enum-name": "SmsTemplateLocale",
"x-enum-keys": []
},
"in": "path"
}
]
}
},
"\/projects\/{projectId}\/webhooks": {
"get": {
"summary": "List webhooks",
"operationId": "projectsListWebhooks",
"tags": [
"projects"
],
"description": "Get a list of all webhooks belonging to the project. You can use the query params to filter your results. ",
"responses": {
"200": {
"description": "Webhooks List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/webhookList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listWebhooks",
"group": "webhooks",
"weight": 75,
"cookies": false,
"type": "",
"demo": "projects\/list-webhooks.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-webhooks.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "total",
"description": "When set to false, the total count returned will be 0 and will not be calculated.",
"required": false,
"schema": {
"type": "boolean",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create webhook",
"operationId": "projectsCreateWebhook",
"tags": [
"projects"
],
"description": "Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur. ",
"responses": {
"201": {
"description": "Webhook",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/webhook"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createWebhook",
"group": "webhooks",
"weight": 74,
"cookies": false,
"type": "",
"demo": "projects\/create-webhook.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-webhook.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Webhook name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Enable or disable a webhook.",
"x-example": false
},
"events": {
"type": "array",
"description": "Events list. Maximum of 100 events are allowed.",
"x-example": null,
"items": {
"type": "string"
}
},
"url": {
"type": "string",
"description": "Webhook URL.",
"x-example": null
},
"security": {
"type": "boolean",
"description": "Certificate verification, false for disabled or true for enabled.",
"x-example": false
},
"httpUser": {
"type": "string",
"description": "Webhook HTTP user. Max length: 256 chars.",
"x-example": "<HTTP_USER>"
},
"httpPass": {
"type": "string",
"description": "Webhook HTTP password. Max length: 256 chars.",
"x-example": "<HTTP_PASS>"
}
},
"required": [
"name",
"events",
"url",
"security"
]
}
}
}
}
}
},
"\/projects\/{projectId}\/webhooks\/{webhookId}": {
"get": {
"summary": "Get webhook",
"operationId": "projectsGetWebhook",
"tags": [
"projects"
],
"description": "Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project. ",
"responses": {
"200": {
"description": "Webhook",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/webhook"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getWebhook",
"group": "webhooks",
"weight": 76,
"cookies": false,
"type": "",
"demo": "projects\/get-webhook.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-webhook.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "webhookId",
"description": "Webhook unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<WEBHOOK_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update webhook",
"operationId": "projectsUpdateWebhook",
"tags": [
"projects"
],
"description": "Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook. ",
"responses": {
"200": {
"description": "Webhook",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/webhook"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateWebhook",
"group": "webhooks",
"weight": 77,
"cookies": false,
"type": "",
"demo": "projects\/update-webhook.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-webhook.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "webhookId",
"description": "Webhook unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<WEBHOOK_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Webhook name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Enable or disable a webhook.",
"x-example": false
},
"events": {
"type": "array",
"description": "Events list. Maximum of 100 events are allowed.",
"x-example": null,
"items": {
"type": "string"
}
},
"url": {
"type": "string",
"description": "Webhook URL.",
"x-example": null
},
"security": {
"type": "boolean",
"description": "Certificate verification, false for disabled or true for enabled.",
"x-example": false
},
"httpUser": {
"type": "string",
"description": "Webhook HTTP user. Max length: 256 chars.",
"x-example": "<HTTP_USER>"
},
"httpPass": {
"type": "string",
"description": "Webhook HTTP password. Max length: 256 chars.",
"x-example": "<HTTP_PASS>"
}
},
"required": [
"name",
"events",
"url",
"security"
]
}
}
}
}
},
"delete": {
"summary": "Delete webhook",
"operationId": "projectsDeleteWebhook",
"tags": [
"projects"
],
"description": "Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events. ",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteWebhook",
"group": "webhooks",
"weight": 79,
"cookies": false,
"type": "",
"demo": "projects\/delete-webhook.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-webhook.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "webhookId",
"description": "Webhook unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<WEBHOOK_ID>"
},
"in": "path"
}
]
}
},
"\/projects\/{projectId}\/webhooks\/{webhookId}\/signature": {
"patch": {
"summary": "Update webhook signature key",
"operationId": "projectsUpdateWebhookSignature",
"tags": [
"projects"
],
"description": "Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook. ",
"responses": {
"200": {
"description": "Webhook",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/webhook"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateWebhookSignature",
"group": "webhooks",
"weight": 78,
"cookies": false,
"type": "",
"demo": "projects\/update-webhook-signature.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "projects.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-webhook-signature.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "projectId",
"description": "Project unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROJECT_ID>"
},
"in": "path"
},
{
"name": "webhookId",
"description": "Webhook unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<WEBHOOK_ID>"
},
"in": "path"
}
]
}
},
"\/proxy\/rules": {
"get": {
"summary": "List rules",
"operationId": "proxyListRules",
"tags": [
"proxy"
],
"description": "Get a list of all the proxy rules. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Rule List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/proxyRuleList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listRules",
"group": null,
"weight": 517,
"cookies": false,
"type": "",
"demo": "proxy\/list-rules.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "rules.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"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\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: domain, type, trigger, deploymentResourceType, deploymentResourceId, deploymentId, deploymentVcsProviderBranch",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/proxy\/rules\/api": {
"post": {
"summary": "Create API rule",
"operationId": "proxyCreateAPIRule",
"tags": [
"proxy"
],
"description": "Create a new proxy rule for serving Appwrite's API on custom domain.",
"responses": {
"201": {
"description": "Rule",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/proxyRule"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createAPIRule",
"group": null,
"weight": 512,
"cookies": false,
"type": "",
"demo": "proxy\/create-api-rule.md",
"rate-limit": 10,
"rate-time": 60,
"rate-key": "userId:{userId}, url:{url}",
"scope": "rules.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name.",
"x-example": null
}
},
"required": [
"domain"
]
}
}
}
}
}
},
"\/proxy\/rules\/function": {
"post": {
"summary": "Create function rule",
"operationId": "proxyCreateFunctionRule",
"tags": [
"proxy"
],
"description": "Create a new proxy rule for executing Appwrite Function on custom domain.",
"responses": {
"201": {
"description": "Rule",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/proxyRule"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createFunctionRule",
"group": null,
"weight": 514,
"cookies": false,
"type": "",
"demo": "proxy\/create-function-rule.md",
"rate-limit": 10,
"rate-time": 60,
"rate-key": "userId:{userId}, url:{url}",
"scope": "rules.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name.",
"x-example": null
},
"functionId": {
"type": "string",
"description": "ID of function to be executed.",
"x-example": "<FUNCTION_ID>"
},
"branch": {
"type": "string",
"description": "Name of VCS branch to deploy changes automatically",
"x-example": "<BRANCH>"
}
},
"required": [
"domain",
"functionId"
]
}
}
}
}
}
},
"\/proxy\/rules\/redirect": {
"post": {
"summary": "Create Redirect rule",
"operationId": "proxyCreateRedirectRule",
"tags": [
"proxy"
],
"description": "Create a new proxy rule for to redirect from custom domain to another domain.",
"responses": {
"201": {
"description": "Rule",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/proxyRule"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createRedirectRule",
"group": null,
"weight": 515,
"cookies": false,
"type": "",
"demo": "proxy\/create-redirect-rule.md",
"rate-limit": 10,
"rate-time": 60,
"rate-key": "userId:{userId}, url:{url}",
"scope": "rules.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name.",
"x-example": null
},
"url": {
"type": "string",
"description": "Target URL of redirection",
"x-example": "https:\/\/example.com",
"format": "url"
},
"statusCode": {
"type": "string",
"description": "Status code of redirection",
"x-example": "301",
"enum": [
"301",
"302",
"307",
"308"
],
"x-enum-name": null,
"x-enum-keys": [
"Moved Permanently 301",
"Found 302",
"Temporary Redirect 307",
"Permanent Redirect 308"
]
},
"resourceId": {
"type": "string",
"description": "ID of parent resource.",
"x-example": "<RESOURCE_ID>"
},
"resourceType": {
"type": "string",
"description": "Type of parent resource.",
"x-example": "site",
"enum": [
"site",
"function"
],
"x-enum-name": "ProxyResourceType",
"x-enum-keys": [
"Site",
"Function"
]
}
},
"required": [
"domain",
"url",
"statusCode",
"resourceId",
"resourceType"
]
}
}
}
}
}
},
"\/proxy\/rules\/site": {
"post": {
"summary": "Create site rule",
"operationId": "proxyCreateSiteRule",
"tags": [
"proxy"
],
"description": "Create a new proxy rule for serving Appwrite Site on custom domain.",
"responses": {
"201": {
"description": "Rule",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/proxyRule"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createSiteRule",
"group": null,
"weight": 513,
"cookies": false,
"type": "",
"demo": "proxy\/create-site-rule.md",
"rate-limit": 10,
"rate-time": 60,
"rate-key": "userId:{userId}, url:{url}",
"scope": "rules.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"domain": {
"type": "string",
"description": "Domain name.",
"x-example": null
},
"siteId": {
"type": "string",
"description": "ID of site to be executed.",
"x-example": "<SITE_ID>"
},
"branch": {
"type": "string",
"description": "Name of VCS branch to deploy changes automatically",
"x-example": "<BRANCH>"
}
},
"required": [
"domain",
"siteId"
]
}
}
}
}
}
},
"\/proxy\/rules\/{ruleId}": {
"get": {
"summary": "Get rule",
"operationId": "proxyGetRule",
"tags": [
"proxy"
],
"description": "Get a proxy rule by its unique ID.",
"responses": {
"200": {
"description": "Rule",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/proxyRule"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getRule",
"group": null,
"weight": 516,
"cookies": false,
"type": "",
"demo": "proxy\/get-rule.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "rules.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "ruleId",
"description": "Rule ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<RULE_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete rule",
"operationId": "proxyDeleteRule",
"tags": [
"proxy"
],
"description": "Delete a proxy rule by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteRule",
"group": null,
"weight": 518,
"cookies": false,
"type": "",
"demo": "proxy\/delete-rule.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "rules.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "ruleId",
"description": "Rule ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<RULE_ID>"
},
"in": "path"
}
]
}
},
"\/proxy\/rules\/{ruleId}\/verification": {
"patch": {
"summary": "Update rule verification status",
"operationId": "proxyUpdateRuleVerification",
"tags": [
"proxy"
],
"description": "Retry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.",
"responses": {
"200": {
"description": "Rule",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/proxyRule"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateRuleVerification",
"group": null,
"weight": 519,
"cookies": false,
"type": "",
"demo": "proxy\/update-rule-verification.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "rules.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "ruleId",
"description": "Rule ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<RULE_ID>"
},
"in": "path"
}
]
}
},
"\/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": {
"method": "list",
"group": "sites",
"weight": 474,
"cookies": false,
"type": "",
"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": {
"Project": []
}
},
"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",
"x-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",
"x-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": {
"method": "create",
"group": "sites",
"weight": 472,
"cookies": false,
"type": "",
"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": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"siteId": {
"type": "string",
"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.",
"x-example": "<SITE_ID>"
},
"name": {
"type": "string",
"description": "Site name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"framework": {
"type": "string",
"description": "Sites framework.",
"x-example": "analog",
"enum": [
"analog",
"angular",
"nextjs",
"react",
"nuxt",
"vue",
"sveltekit",
"astro",
"tanstack-start",
"remix",
"lynx",
"flutter",
"react-native",
"vite",
"other"
],
"x-enum-name": null,
"x-enum-keys": []
},
"enabled": {
"type": "boolean",
"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.",
"x-example": false
},
"logging": {
"type": "boolean",
"description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.",
"x-example": false
},
"timeout": {
"type": "integer",
"description": "Maximum request time in seconds.",
"x-example": 1,
"format": "int32"
},
"installCommand": {
"type": "string",
"description": "Install Command.",
"x-example": "<INSTALL_COMMAND>"
},
"buildCommand": {
"type": "string",
"description": "Build Command.",
"x-example": "<BUILD_COMMAND>"
},
"outputDirectory": {
"type": "string",
"description": "Output Directory for site.",
"x-example": "<OUTPUT_DIRECTORY>"
},
"buildRuntime": {
"type": "string",
"description": "Runtime to use during build step.",
"x-example": "node-14.5",
"enum": [
"node-14.5",
"node-16.0",
"node-18.0",
"node-19.0",
"node-20.0",
"node-21.0",
"node-22",
"php-8.0",
"php-8.1",
"php-8.2",
"php-8.3",
"ruby-3.0",
"ruby-3.1",
"ruby-3.2",
"ruby-3.3",
"python-3.8",
"python-3.9",
"python-3.10",
"python-3.11",
"python-3.12",
"python-ml-3.11",
"python-ml-3.12",
"deno-1.21",
"deno-1.24",
"deno-1.35",
"deno-1.40",
"deno-1.46",
"deno-2.0",
"dart-2.15",
"dart-2.16",
"dart-2.17",
"dart-2.18",
"dart-2.19",
"dart-3.0",
"dart-3.1",
"dart-3.3",
"dart-3.5",
"dart-3.8",
"dart-3.9",
"dart-3.10",
"dotnet-6.0",
"dotnet-7.0",
"dotnet-8.0",
"java-8.0",
"java-11.0",
"java-17.0",
"java-18.0",
"java-21.0",
"java-22",
"swift-5.5",
"swift-5.8",
"swift-5.9",
"swift-5.10",
"kotlin-1.6",
"kotlin-1.8",
"kotlin-1.9",
"kotlin-2.0",
"cpp-17",
"cpp-20",
"bun-1.0",
"bun-1.1",
"go-1.23",
"static-1",
"flutter-3.24",
"flutter-3.27",
"flutter-3.29",
"flutter-3.32",
"flutter-3.35",
"flutter-3.38"
],
"x-enum-name": null,
"x-enum-keys": []
},
"adapter": {
"type": "string",
"description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr",
"x-example": "static",
"enum": [
"static",
"ssr"
],
"x-enum-name": null,
"x-enum-keys": []
},
"installationId": {
"type": "string",
"description": "Appwrite Installation ID for VCS (Version Control System) deployment.",
"x-example": "<INSTALLATION_ID>"
},
"fallbackFile": {
"type": "string",
"description": "Fallback file for single page application sites.",
"x-example": "<FALLBACK_FILE>"
},
"providerRepositoryId": {
"type": "string",
"description": "Repository ID of the repo linked to the site.",
"x-example": "<PROVIDER_REPOSITORY_ID>"
},
"providerBranch": {
"type": "string",
"description": "Production branch for the repo linked to the site.",
"x-example": "<PROVIDER_BRANCH>"
},
"providerSilentMode": {
"type": "boolean",
"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.",
"x-example": false
},
"providerRootDirectory": {
"type": "string",
"description": "Path to site code in the linked repo.",
"x-example": "<PROVIDER_ROOT_DIRECTORY>"
},
"specification": {
"type": "string",
"description": "Framework specification for the site and builds.",
"x-example": null
}
},
"required": [
"siteId",
"name",
"framework",
"buildRuntime"
]
}
}
}
}
}
},
"\/sites\/frameworks": {
"get": {
"summary": "List frameworks",
"operationId": "sitesListFrameworks",
"tags": [
"sites"
],
"description": "Get a list of all frameworks that are currently available on the server instance.",
"responses": {
"200": {
"description": "Frameworks List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/frameworkList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listFrameworks",
"group": "frameworks",
"weight": 477,
"cookies": false,
"type": "",
"demo": "sites\/list-frameworks.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/sites\/specifications": {
"get": {
"summary": "List specifications",
"operationId": "sitesListSpecifications",
"tags": [
"sites"
],
"description": "List allowed site specifications for this instance.",
"responses": {
"200": {
"description": "Specifications List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/specificationList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listSpecifications",
"group": "frameworks",
"weight": 500,
"cookies": false,
"type": "",
"demo": "sites\/list-specifications.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.read",
"platforms": [
"server",
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
]
}
},
"\/sites\/templates": {
"get": {
"summary": "List templates",
"operationId": "sitesListTemplates",
"tags": [
"sites"
],
"description": "List available site templates. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.",
"responses": {
"200": {
"description": "Site Templates List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/templateSiteList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listTemplates",
"group": "templates",
"weight": 496,
"cookies": false,
"type": "",
"demo": "sites\/list-templates.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "frameworks",
"description": "List of frameworks allowed for filtering site templates. Maximum of 100 frameworks are allowed.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"analog",
"angular",
"nextjs",
"react",
"nuxt",
"vue",
"sveltekit",
"astro",
"tanstack-start",
"remix",
"lynx",
"flutter",
"react-native",
"vite",
"other"
],
"x-enum-name": null,
"x-enum-keys": []
},
"default": []
},
"in": "query"
},
{
"name": "useCases",
"description": "List of use cases allowed for filtering site templates. Maximum of 100 use cases are allowed.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string",
"enum": [
"portfolio",
"starter",
"events",
"ecommerce",
"documentation",
"blog",
"ai",
"forms",
"dashboard"
],
"x-enum-name": null,
"x-enum-keys": []
},
"default": []
},
"in": "query"
},
{
"name": "limit",
"description": "Limit the number of templates returned in the response. Default limit is 25, and maximum limit is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 1,
"default": 25
},
"in": "query"
},
{
"name": "offset",
"description": "Offset the list of returned templates. Maximum offset is 5000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 0
},
"in": "query"
}
]
}
},
"\/sites\/templates\/{templateId}": {
"get": {
"summary": "Get site template",
"operationId": "sitesGetTemplate",
"tags": [
"sites"
],
"description": "Get a site template using ID. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.",
"responses": {
"200": {
"description": "Template Site",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/templateSite"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getTemplate",
"group": "templates",
"weight": 497,
"cookies": false,
"type": "",
"demo": "sites\/get-template.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "templateId",
"description": "Template ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEMPLATE_ID>"
},
"in": "path"
}
]
}
},
"\/sites\/usage": {
"get": {
"summary": "Get sites usage",
"operationId": "sitesListUsage",
"tags": [
"sites"
],
"description": "Get usage metrics and statistics for all sites in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.",
"responses": {
"200": {
"description": "UsageSites",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageSites"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listUsage",
"group": null,
"weight": 498,
"cookies": false,
"type": "",
"demo": "sites\/list-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/sites\/{siteId}": {
"get": {
"summary": "Get site",
"operationId": "sitesGet",
"tags": [
"sites"
],
"description": "Get a site by its unique ID.",
"responses": {
"200": {
"description": "Site",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/site"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": "sites",
"weight": 473,
"cookies": false,
"type": "",
"demo": "sites\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update site",
"operationId": "sitesUpdate",
"tags": [
"sites"
],
"description": "Update site by its unique ID.",
"responses": {
"200": {
"description": "Site",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/site"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "update",
"group": "sites",
"weight": 475,
"cookies": false,
"type": "",
"demo": "sites\/update.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Site name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"framework": {
"type": "string",
"description": "Sites framework.",
"x-example": "analog",
"enum": [
"analog",
"angular",
"nextjs",
"react",
"nuxt",
"vue",
"sveltekit",
"astro",
"tanstack-start",
"remix",
"lynx",
"flutter",
"react-native",
"vite",
"other"
],
"x-enum-name": null,
"x-enum-keys": []
},
"enabled": {
"type": "boolean",
"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.",
"x-example": false
},
"logging": {
"type": "boolean",
"description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.",
"x-example": false
},
"timeout": {
"type": "integer",
"description": "Maximum request time in seconds.",
"x-example": 1,
"format": "int32"
},
"installCommand": {
"type": "string",
"description": "Install Command.",
"x-example": "<INSTALL_COMMAND>"
},
"buildCommand": {
"type": "string",
"description": "Build Command.",
"x-example": "<BUILD_COMMAND>"
},
"outputDirectory": {
"type": "string",
"description": "Output Directory for site.",
"x-example": "<OUTPUT_DIRECTORY>"
},
"buildRuntime": {
"type": "string",
"description": "Runtime to use during build step.",
"x-example": "node-14.5",
"enum": [
"node-14.5",
"node-16.0",
"node-18.0",
"node-19.0",
"node-20.0",
"node-21.0",
"node-22",
"php-8.0",
"php-8.1",
"php-8.2",
"php-8.3",
"ruby-3.0",
"ruby-3.1",
"ruby-3.2",
"ruby-3.3",
"python-3.8",
"python-3.9",
"python-3.10",
"python-3.11",
"python-3.12",
"python-ml-3.11",
"python-ml-3.12",
"deno-1.21",
"deno-1.24",
"deno-1.35",
"deno-1.40",
"deno-1.46",
"deno-2.0",
"dart-2.15",
"dart-2.16",
"dart-2.17",
"dart-2.18",
"dart-2.19",
"dart-3.0",
"dart-3.1",
"dart-3.3",
"dart-3.5",
"dart-3.8",
"dart-3.9",
"dart-3.10",
"dotnet-6.0",
"dotnet-7.0",
"dotnet-8.0",
"java-8.0",
"java-11.0",
"java-17.0",
"java-18.0",
"java-21.0",
"java-22",
"swift-5.5",
"swift-5.8",
"swift-5.9",
"swift-5.10",
"kotlin-1.6",
"kotlin-1.8",
"kotlin-1.9",
"kotlin-2.0",
"cpp-17",
"cpp-20",
"bun-1.0",
"bun-1.1",
"go-1.23",
"static-1",
"flutter-3.24",
"flutter-3.27",
"flutter-3.29",
"flutter-3.32",
"flutter-3.35",
"flutter-3.38"
],
"x-enum-name": null,
"x-enum-keys": []
},
"adapter": {
"type": "string",
"description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr",
"x-example": "static",
"enum": [
"static",
"ssr"
],
"x-enum-name": null,
"x-enum-keys": []
},
"fallbackFile": {
"type": "string",
"description": "Fallback file for single page application sites.",
"x-example": "<FALLBACK_FILE>"
},
"installationId": {
"type": "string",
"description": "Appwrite Installation ID for VCS (Version Control System) deployment.",
"x-example": "<INSTALLATION_ID>"
},
"providerRepositoryId": {
"type": "string",
"description": "Repository ID of the repo linked to the site.",
"x-example": "<PROVIDER_REPOSITORY_ID>"
},
"providerBranch": {
"type": "string",
"description": "Production branch for the repo linked to the site.",
"x-example": "<PROVIDER_BRANCH>"
},
"providerSilentMode": {
"type": "boolean",
"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.",
"x-example": false
},
"providerRootDirectory": {
"type": "string",
"description": "Path to site code in the linked repo.",
"x-example": "<PROVIDER_ROOT_DIRECTORY>"
},
"specification": {
"type": "string",
"description": "Framework specification for the site and builds.",
"x-example": null
}
},
"required": [
"name",
"framework"
]
}
}
}
}
},
"delete": {
"summary": "Delete site",
"operationId": "sitesDelete",
"tags": [
"sites"
],
"description": "Delete a site by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "sites",
"weight": 476,
"cookies": false,
"type": "",
"demo": "sites\/delete.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
}
]
}
},
"\/sites\/{siteId}\/deployment": {
"patch": {
"summary": "Update site's deployment",
"operationId": "sitesUpdateSiteDeployment",
"tags": [
"sites"
],
"description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.",
"responses": {
"200": {
"description": "Site",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/site"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateSiteDeployment",
"group": "sites",
"weight": 483,
"cookies": false,
"type": "",
"demo": "sites\/update-site-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"deploymentId": {
"type": "string",
"description": "Deployment ID.",
"x-example": "<DEPLOYMENT_ID>"
}
},
"required": [
"deploymentId"
]
}
}
}
}
}
},
"\/sites\/{siteId}\/deployments": {
"get": {
"summary": "List deployments",
"operationId": "sitesListDeployments",
"tags": [
"sites"
],
"description": "Get a list of all the site's code deployments. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Deployments List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deploymentList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listDeployments",
"group": "deployments",
"weight": 482,
"cookies": false,
"type": "",
"demo": "sites\/list-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"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: buildSize, sourceSize, totalSize, buildDuration, status, activate, type",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create deployment",
"operationId": "sitesCreateDeployment",
"tags": [
"sites"
],
"description": "Create a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the site's deployment to use your new deployment ID.",
"responses": {
"202": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createDeployment",
"group": "deployments",
"weight": 478,
"cookies": false,
"type": "upload",
"demo": "sites\/create-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": true,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"multipart\/form-data": {
"schema": {
"type": "object",
"properties": {
"installCommand": {
"type": "string",
"description": "Install Commands.",
"x-example": "<INSTALL_COMMAND>",
"x-nullable": true
},
"buildCommand": {
"type": "string",
"description": "Build Commands.",
"x-example": "<BUILD_COMMAND>",
"x-nullable": true
},
"outputDirectory": {
"type": "string",
"description": "Output Directory.",
"x-example": "<OUTPUT_DIRECTORY>",
"x-nullable": true
},
"code": {
"type": "string",
"description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.",
"x-example": null,
"format": "binary"
},
"activate": {
"type": "boolean",
"description": "Automatically activate the deployment when it is finished building.",
"x-example": false
}
},
"required": [
"code",
"activate"
]
}
}
}
}
}
},
"\/sites\/{siteId}\/deployments\/duplicate": {
"post": {
"summary": "Create duplicate deployment",
"operationId": "sitesCreateDuplicateDeployment",
"tags": [
"sites"
],
"description": "Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build.",
"responses": {
"202": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createDuplicateDeployment",
"group": "deployments",
"weight": 486,
"cookies": false,
"type": "",
"demo": "sites\/create-duplicate-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"deploymentId": {
"type": "string",
"description": "Deployment ID.",
"x-example": "<DEPLOYMENT_ID>"
}
},
"required": [
"deploymentId"
]
}
}
}
}
}
},
"\/sites\/{siteId}\/deployments\/template": {
"post": {
"summary": "Create template deployment",
"operationId": "sitesCreateTemplateDeployment",
"tags": [
"sites"
],
"description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.",
"responses": {
"202": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTemplateDeployment",
"group": "deployments",
"weight": 479,
"cookies": false,
"type": "",
"demo": "sites\/create-template-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"repository": {
"type": "string",
"description": "Repository name of the template.",
"x-example": "<REPOSITORY>"
},
"owner": {
"type": "string",
"description": "The name of the owner of the template.",
"x-example": "<OWNER>"
},
"rootDirectory": {
"type": "string",
"description": "Path to site code in the template repo.",
"x-example": "<ROOT_DIRECTORY>"
},
"type": {
"type": "string",
"description": "Type for the reference provided. Can be commit, branch, or tag",
"x-example": "branch",
"enum": [
"branch",
"commit",
"tag"
],
"x-enum-name": "TemplateReferenceType",
"x-enum-keys": []
},
"reference": {
"type": "string",
"description": "Reference value, can be a commit hash, branch name, or release tag",
"x-example": "<REFERENCE>"
},
"activate": {
"type": "boolean",
"description": "Automatically activate the deployment when it is finished building.",
"x-example": false
}
},
"required": [
"repository",
"owner",
"rootDirectory",
"type",
"reference"
]
}
}
}
}
}
},
"\/sites\/{siteId}\/deployments\/vcs": {
"post": {
"summary": "Create VCS deployment",
"operationId": "sitesCreateVcsDeployment",
"tags": [
"sites"
],
"description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.",
"responses": {
"202": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createVcsDeployment",
"group": "deployments",
"weight": 480,
"cookies": false,
"type": "",
"demo": "sites\/create-vcs-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Type of reference passed. Allowed values are: branch, commit",
"x-example": "branch",
"enum": [
"branch",
"commit",
"tag"
],
"x-enum-name": "VCSReferenceType",
"x-enum-keys": []
},
"reference": {
"type": "string",
"description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash",
"x-example": "<REFERENCE>"
},
"activate": {
"type": "boolean",
"description": "Automatically activate the deployment when it is finished building.",
"x-example": false
}
},
"required": [
"type",
"reference"
]
}
}
}
}
}
},
"\/sites\/{siteId}\/deployments\/{deploymentId}": {
"get": {
"summary": "Get deployment",
"operationId": "sitesGetDeployment",
"tags": [
"sites"
],
"description": "Get a site deployment by its unique ID.",
"responses": {
"200": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getDeployment",
"group": "deployments",
"weight": 481,
"cookies": false,
"type": "",
"demo": "sites\/get-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete deployment",
"operationId": "sitesDeleteDeployment",
"tags": [
"sites"
],
"description": "Delete a site deployment by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteDeployment",
"group": "deployments",
"weight": 484,
"cookies": false,
"type": "",
"demo": "sites\/delete-deployment.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
]
}
},
"\/sites\/{siteId}\/deployments\/{deploymentId}\/download": {
"get": {
"summary": "Get deployment download",
"operationId": "sitesGetDeploymentDownload",
"tags": [
"sites"
],
"description": "Get a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.",
"responses": {
"200": {
"description": "File"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getDeploymentDownload",
"group": "deployments",
"weight": 485,
"cookies": false,
"type": "location",
"demo": "sites\/get-deployment-download.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.read",
"platforms": [
"console",
"server",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
},
{
"name": "type",
"description": "Deployment file to download. Can be: \"source\", \"output\".",
"required": false,
"schema": {
"type": "string",
"x-example": "source",
"enum": [
"source",
"output"
],
"x-enum-name": "DeploymentDownloadType",
"x-enum-keys": [],
"default": "source"
},
"in": "query"
}
]
}
},
"\/sites\/{siteId}\/deployments\/{deploymentId}\/status": {
"patch": {
"summary": "Update deployment status",
"operationId": "sitesUpdateDeploymentStatus",
"tags": [
"sites"
],
"description": "Cancel an ongoing site deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.",
"responses": {
"200": {
"description": "Deployment",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/deployment"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateDeploymentStatus",
"group": "deployments",
"weight": 487,
"cookies": false,
"type": "",
"demo": "sites\/update-deployment-status.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"name": "deploymentId",
"description": "Deployment ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DEPLOYMENT_ID>"
},
"in": "path"
}
]
}
},
"\/sites\/{siteId}\/logs": {
"get": {
"summary": "List logs",
"operationId": "sitesListLogs",
"tags": [
"sites"
],
"description": "Get a list of all site logs. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Executions List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/executionList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
"weight": 489,
"cookies": false,
"type": "",
"demo": "sites\/list-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "log.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"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: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/sites\/{siteId}\/logs\/{logId}": {
"get": {
"summary": "Get log",
"operationId": "sitesGetLog",
"tags": [
"sites"
],
"description": "Get a site request log by its unique ID.",
"responses": {
"200": {
"description": "Execution",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/execution"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getLog",
"group": "logs",
"weight": 488,
"cookies": false,
"type": "",
"demo": "sites\/get-log.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "log.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"name": "logId",
"description": "Log ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<LOG_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete log",
"operationId": "sitesDeleteLog",
"tags": [
"sites"
],
"description": "Delete a site log by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteLog",
"group": "logs",
"weight": 490,
"cookies": false,
"type": "",
"demo": "sites\/delete-log.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "log.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"name": "logId",
"description": "Log ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<LOG_ID>"
},
"in": "path"
}
]
}
},
"\/sites\/{siteId}\/usage": {
"get": {
"summary": "Get site usage",
"operationId": "sitesGetUsage",
"tags": [
"sites"
],
"description": "Get usage metrics and statistics for a for a specific site. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.",
"responses": {
"200": {
"description": "UsageSite",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageSite"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
"weight": 499,
"cookies": false,
"type": "",
"demo": "sites\/get-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/sites\/{siteId}\/variables": {
"get": {
"summary": "List variables",
"operationId": "sitesListVariables",
"tags": [
"sites"
],
"description": "Get a list of all variables of a specific site.",
"responses": {
"200": {
"description": "Variables List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variableList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listVariables",
"group": "variables",
"weight": 493,
"cookies": false,
"type": "",
"demo": "sites\/list-variables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
}
]
},
"post": {
"summary": "Create variable",
"operationId": "sitesCreateVariable",
"tags": [
"sites"
],
"description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.",
"responses": {
"201": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createVariable",
"group": "variables",
"weight": 491,
"cookies": false,
"type": "",
"demo": "sites\/create-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Variable key. Max length: 255 chars.",
"x-example": "<KEY>"
},
"value": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"x-example": "<VALUE>"
},
"secret": {
"type": "boolean",
"description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.",
"x-example": false
}
},
"required": [
"key",
"value"
]
}
}
}
}
}
},
"\/sites\/{siteId}\/variables\/{variableId}": {
"get": {
"summary": "Get variable",
"operationId": "sitesGetVariable",
"tags": [
"sites"
],
"description": "Get a variable by its unique ID.",
"responses": {
"200": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getVariable",
"group": "variables",
"weight": 492,
"cookies": false,
"type": "",
"demo": "sites\/get-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"name": "variableId",
"description": "Variable unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<VARIABLE_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update variable",
"operationId": "sitesUpdateVariable",
"tags": [
"sites"
],
"description": "Update variable by its unique ID.",
"responses": {
"200": {
"description": "Variable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/variable"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
"weight": 494,
"cookies": false,
"type": "",
"demo": "sites\/update-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"name": "variableId",
"description": "Variable unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<VARIABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Variable key. Max length: 255 chars.",
"x-example": "<KEY>"
},
"value": {
"type": "string",
"description": "Variable value. Max length: 8192 chars.",
"x-example": "<VALUE>",
"x-nullable": true
},
"secret": {
"type": "boolean",
"description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.",
"x-example": false,
"x-nullable": true
}
},
"required": [
"key"
]
}
}
}
}
},
"delete": {
"summary": "Delete variable",
"operationId": "sitesDeleteVariable",
"tags": [
"sites"
],
"description": "Delete a variable by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
"weight": 495,
"cookies": false,
"type": "",
"demo": "sites\/delete-variable.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "sites.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "siteId",
"description": "Site unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SITE_ID>"
},
"in": "path"
},
{
"name": "variableId",
"description": "Variable unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<VARIABLE_ID>"
},
"in": "path"
}
]
}
},
"\/storage\/buckets": {
"get": {
"summary": "List buckets",
"operationId": "storageListBuckets",
"tags": [
"storage"
],
"description": "Get a list of all the storage buckets. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Buckets List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/bucketList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listBuckets",
"group": "buckets",
"weight": 527,
"cookies": false,
"type": "",
"demo": "storage\/list-buckets.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "buckets.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md",
"auth": {
"Project": []
}
},
"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: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create bucket",
"operationId": "storageCreateBucket",
"tags": [
"storage"
],
"description": "Create a new storage bucket.",
"responses": {
"201": {
"description": "Bucket",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/bucket"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createBucket",
"group": "buckets",
"weight": 525,
"cookies": false,
"type": "",
"demo": "storage\/create-bucket.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "buckets.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"bucketId": {
"type": "string",
"description": "Unique 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.",
"x-example": "<BUCKET_ID>"
},
"name": {
"type": "string",
"description": "Bucket name",
"x-example": "<NAME>"
},
"permissions": {
"type": "array",
"description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"fileSecurity": {
"type": "boolean",
"description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": false
},
"enabled": {
"type": "boolean",
"description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.",
"x-example": false
},
"maximumFileSize": {
"type": "integer",
"description": "Maximum file size allowed in bytes. Maximum allowed value is 30MB.",
"x-example": 1,
"format": "int32"
},
"allowedFileExtensions": {
"type": "array",
"description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.",
"x-example": null,
"items": {
"type": "string"
}
},
"compression": {
"type": "string",
"description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled",
"x-example": "none",
"enum": [
"none",
"gzip",
"zstd"
],
"x-enum-name": null,
"x-enum-keys": []
},
"encryption": {
"type": "boolean",
"description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled",
"x-example": false
},
"antivirus": {
"type": "boolean",
"description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled",
"x-example": false
},
"transformations": {
"type": "boolean",
"description": "Are image transformations enabled?",
"x-example": false
}
},
"required": [
"bucketId",
"name"
]
}
}
}
}
}
},
"\/storage\/buckets\/{bucketId}": {
"get": {
"summary": "Get bucket",
"operationId": "storageGetBucket",
"tags": [
"storage"
],
"description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.",
"responses": {
"200": {
"description": "Bucket",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/bucket"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getBucket",
"group": "buckets",
"weight": 526,
"cookies": false,
"type": "",
"demo": "storage\/get-bucket.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "buckets.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Bucket unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update bucket",
"operationId": "storageUpdateBucket",
"tags": [
"storage"
],
"description": "Update a storage bucket by its unique ID.",
"responses": {
"200": {
"description": "Bucket",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/bucket"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateBucket",
"group": "buckets",
"weight": 528,
"cookies": false,
"type": "",
"demo": "storage\/update-bucket.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "buckets.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Bucket unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Bucket name",
"x-example": "<NAME>"
},
"permissions": {
"type": "array",
"description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"fileSecurity": {
"type": "boolean",
"description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": false
},
"enabled": {
"type": "boolean",
"description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.",
"x-example": false
},
"maximumFileSize": {
"type": "integer",
"description": "Maximum file size allowed in bytes. Maximum allowed value is 30MB.",
"x-example": 1,
"format": "int32"
},
"allowedFileExtensions": {
"type": "array",
"description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.",
"x-example": null,
"items": {
"type": "string"
}
},
"compression": {
"type": "string",
"description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled",
"x-example": "none",
"enum": [
"none",
"gzip",
"zstd"
],
"x-enum-name": null,
"x-enum-keys": []
},
"encryption": {
"type": "boolean",
"description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled",
"x-example": false
},
"antivirus": {
"type": "boolean",
"description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled",
"x-example": false
},
"transformations": {
"type": "boolean",
"description": "Are image transformations enabled?",
"x-example": false
}
},
"required": [
"name"
]
}
}
}
}
},
"delete": {
"summary": "Delete bucket",
"operationId": "storageDeleteBucket",
"tags": [
"storage"
],
"description": "Delete a storage bucket by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteBucket",
"group": "buckets",
"weight": 529,
"cookies": false,
"type": "",
"demo": "storage\/delete-bucket.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "buckets.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Bucket unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
}
]
}
},
"\/storage\/buckets\/{bucketId}\/files": {
"get": {
"summary": "List files",
"operationId": "storageListFiles",
"tags": [
"storage"
],
"description": "Get a list of all the user files. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Files List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/fileList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listFiles",
"group": "files",
"weight": 532,
"cookies": false,
"type": "",
"demo": "storage\/list-files.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "files.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"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, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create file",
"operationId": "storageCreateFile",
"tags": [
"storage"
],
"description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n",
"responses": {
"201": {
"description": "File",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/file"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createFile",
"group": "files",
"weight": 530,
"cookies": false,
"type": "upload",
"demo": "storage\/create-file.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}",
"scope": "files.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"multipart\/form-data": {
"schema": {
"type": "object",
"properties": {
"fileId": {
"type": "string",
"description": "File 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.",
"x-example": "<FILE_ID>",
"x-upload-id": true
},
"file": {
"type": "string",
"description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).",
"x-example": null,
"format": "binary"
},
"permissions": {
"type": "array",
"description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
}
},
"required": [
"fileId",
"file"
]
}
}
}
}
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}": {
"get": {
"summary": "Get file",
"operationId": "storageGetFile",
"tags": [
"storage"
],
"description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.",
"responses": {
"200": {
"description": "File",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/file"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getFile",
"group": "files",
"weight": 531,
"cookies": false,
"type": "",
"demo": "storage\/get-file.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "files.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update file",
"operationId": "storageUpdateFile",
"tags": [
"storage"
],
"description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.",
"responses": {
"200": {
"description": "File",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/file"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateFile",
"group": "files",
"weight": 533,
"cookies": false,
"type": "",
"demo": "storage\/update-file.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "files.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Bucket unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "File name.",
"x-example": "<NAME>"
},
"permissions": {
"type": "array",
"description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
}
}
}
}
}
}
},
"delete": {
"summary": "Delete file",
"operationId": "storageDeleteFile",
"tags": [
"storage"
],
"description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteFile",
"group": "files",
"weight": 534,
"cookies": false,
"type": "",
"demo": "storage\/delete-file.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "files.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
}
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": {
"get": {
"summary": "Get file for download",
"operationId": "storageGetFileDownload",
"tags": [
"storage"
],
"description": "Get a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.",
"responses": {
"200": {
"description": "File"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getFileDownload",
"group": "files",
"weight": 536,
"cookies": false,
"type": "location",
"demo": "storage\/get-file-download.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "files.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
},
{
"name": "token",
"description": "File token for accessing this file.",
"required": false,
"schema": {
"type": "string",
"x-example": "<TOKEN>",
"default": ""
},
"in": "query"
}
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": {
"get": {
"summary": "Get file preview",
"operationId": "storageGetFilePreview",
"tags": [
"storage"
],
"description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.",
"responses": {
"200": {
"description": "Image"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getFilePreview",
"group": "files",
"weight": 535,
"cookies": false,
"type": "location",
"demo": "storage\/get-file-preview.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "files.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File ID",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
},
{
"name": "width",
"description": "Resize preview image width, Pass an integer between 0 to 4000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 0
},
"in": "query"
},
{
"name": "height",
"description": "Resize preview image height, Pass an integer between 0 to 4000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 0
},
"in": "query"
},
{
"name": "gravity",
"description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right",
"required": false,
"schema": {
"type": "string",
"x-example": "center",
"enum": [
"center",
"top-left",
"top",
"top-right",
"left",
"right",
"bottom-left",
"bottom",
"bottom-right"
],
"x-enum-name": "ImageGravity",
"x-enum-keys": [],
"default": "center"
},
"in": "query"
},
{
"name": "quality",
"description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": -1,
"default": -1
},
"in": "query"
},
{
"name": "borderWidth",
"description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 0
},
"in": "query"
},
{
"name": "borderColor",
"description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"in": "query"
},
{
"name": "borderRadius",
"description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": 0,
"default": 0
},
"in": "query"
},
{
"name": "opacity",
"description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.",
"required": false,
"schema": {
"type": "number",
"format": "float",
"x-example": 0,
"default": 1
},
"in": "query"
},
{
"name": "rotation",
"description": "Preview image rotation in degrees. Pass an integer between -360 and 360.",
"required": false,
"schema": {
"type": "integer",
"format": "int32",
"x-example": -360,
"default": 0
},
"in": "query"
},
{
"name": "background",
"description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.",
"required": false,
"schema": {
"type": "string",
"default": ""
},
"in": "query"
},
{
"name": "output",
"description": "Output format type (jpeg, jpg, png, gif and webp).",
"required": false,
"schema": {
"type": "string",
"x-example": "jpg",
"enum": [
"jpg",
"jpeg",
"png",
"webp",
"heic",
"avif",
"gif"
],
"x-enum-name": "ImageFormat",
"x-enum-keys": [],
"default": ""
},
"in": "query"
},
{
"name": "token",
"description": "File token for accessing this file.",
"required": false,
"schema": {
"type": "string",
"x-example": "<TOKEN>",
"default": ""
},
"in": "query"
}
]
}
},
"\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": {
"get": {
"summary": "Get file for view",
"operationId": "storageGetFileView",
"tags": [
"storage"
],
"description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.",
"responses": {
"200": {
"description": "File"
}
},
"deprecated": false,
"x-appwrite": {
"method": "getFileView",
"group": "files",
"weight": 537,
"cookies": false,
"type": "location",
"demo": "storage\/get-file-view.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "files.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
},
{
"name": "token",
"description": "File token for accessing this file.",
"required": false,
"schema": {
"type": "string",
"x-example": "<TOKEN>",
"default": ""
},
"in": "query"
}
]
}
},
"\/storage\/usage": {
"get": {
"summary": "Get storage usage stats",
"operationId": "storageGetUsage",
"tags": [
"storage"
],
"description": "Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n",
"responses": {
"200": {
"description": "StorageUsage",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageStorage"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
"weight": 539,
"cookies": false,
"type": "",
"demo": "storage\/get-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "files.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-usage.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/storage\/{bucketId}\/usage": {
"get": {
"summary": "Get bucket usage stats",
"operationId": "storageGetBucketUsage",
"tags": [
"storage"
],
"description": "Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n",
"responses": {
"200": {
"description": "UsageBuckets",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageBuckets"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getBucketUsage",
"group": null,
"weight": 540,
"cookies": false,
"type": "",
"demo": "storage\/get-bucket-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "files.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket-usage.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Bucket ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/tablesdb": {
"get": {
"summary": "List databases",
"operationId": "tablesDBList",
"tags": [
"tablesDB"
],
"description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.",
"responses": {
"200": {
"description": "Databases List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/databaseList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "list",
"group": "tablesdb",
"weight": 338,
"cookies": false,
"type": "",
"demo": "tablesdb\/list.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md",
"auth": {
"Project": []
}
},
"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 columns: name",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create database",
"operationId": "tablesDBCreate",
"tags": [
"tablesDB"
],
"description": "Create a new Database.\n",
"responses": {
"201": {
"description": "Database",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/database"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "create",
"group": "tablesdb",
"weight": 334,
"cookies": false,
"type": "",
"demo": "tablesdb\/create.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"databaseId": {
"type": "string",
"description": "Unique 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.",
"x-example": "<DATABASE_ID>"
},
"name": {
"type": "string",
"description": "Database name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
}
},
"required": [
"databaseId",
"name"
]
}
}
}
}
}
},
"\/tablesdb\/transactions": {
"get": {
"summary": "List transactions",
"operationId": "tablesDBListTransactions",
"tags": [
"tablesDB"
],
"description": "List transactions across all databases.",
"responses": {
"200": {
"description": "Transaction List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/transactionList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listTransactions",
"group": "transactions",
"weight": 405,
"cookies": false,
"type": "",
"demo": "tablesdb\/list-transactions.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"documents.read",
"rows.read"
],
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"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).",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
},
"post": {
"summary": "Create transaction",
"operationId": "tablesDBCreateTransaction",
"tags": [
"tablesDB"
],
"description": "Create a new transaction.",
"responses": {
"201": {
"description": "Transaction",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/transaction"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTransaction",
"group": "transactions",
"weight": 401,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-transaction.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"documents.write",
"rows.write"
],
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"ttl": {
"type": "integer",
"description": "Seconds before the transaction expires.",
"x-example": 60,
"format": "int32"
}
}
}
}
}
}
}
},
"\/tablesdb\/transactions\/{transactionId}": {
"get": {
"summary": "Get transaction",
"operationId": "tablesDBGetTransaction",
"tags": [
"tablesDB"
],
"description": "Get a transaction by its unique ID.",
"responses": {
"200": {
"description": "Transaction",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/transaction"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getTransaction",
"group": "transactions",
"weight": 402,
"cookies": false,
"type": "",
"demo": "tablesdb\/get-transaction.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"documents.read",
"rows.read"
],
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "transactionId",
"description": "Transaction ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Update transaction",
"operationId": "tablesDBUpdateTransaction",
"tags": [
"tablesDB"
],
"description": "Update a transaction, to either commit or roll back its operations.",
"responses": {
"200": {
"description": "Transaction",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/transaction"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTransaction",
"group": "transactions",
"weight": 403,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-transaction.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"documents.write",
"rows.write"
],
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "transactionId",
"description": "Transaction ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"commit": {
"type": "boolean",
"description": "Commit transaction?",
"x-example": false
},
"rollback": {
"type": "boolean",
"description": "Rollback transaction?",
"x-example": false
}
}
}
}
}
}
},
"delete": {
"summary": "Delete transaction",
"operationId": "tablesDBDeleteTransaction",
"tags": [
"tablesDB"
],
"description": "Delete a transaction by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteTransaction",
"group": "transactions",
"weight": 404,
"cookies": false,
"type": "",
"demo": "tablesdb\/delete-transaction.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"documents.write",
"rows.write"
],
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "transactionId",
"description": "Transaction ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"in": "path"
}
]
}
},
"\/tablesdb\/transactions\/{transactionId}\/operations": {
"post": {
"summary": "Create operations",
"operationId": "tablesDBCreateOperations",
"tags": [
"tablesDB"
],
"description": "Create multiple operations in a single transaction.",
"responses": {
"201": {
"description": "Transaction",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/transaction"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createOperations",
"group": "transactions",
"weight": 406,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-operations.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"documents.write",
"rows.write"
],
"platforms": [
"console",
"server",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "transactionId",
"description": "Transaction ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"operations": {
"type": "array",
"description": "Array of staged operations.",
"x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"<DATABASE_ID>\",\n\t \"tableId\": \"<TABLE_ID>\",\n\t \"rowId\": \"<ROW_ID>\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]",
"items": {
"type": "object"
}
}
}
}
}
}
}
}
},
"\/tablesdb\/usage": {
"get": {
"summary": "Get TablesDB usage stats",
"operationId": "tablesDBListUsage",
"tags": [
"tablesDB"
],
"description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"responses": {
"200": {
"description": "UsageDatabases",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageDatabases"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listUsage",
"group": null,
"weight": 340,
"cookies": false,
"type": "",
"demo": "tablesdb\/list-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.read",
"collections.read"
],
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-usage.md",
"methods": [
{
"name": "listUsage",
"namespace": "tablesDB",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"range"
],
"required": [],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/usageDatabases"
}
],
"description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"demo": "tablesdb\/list-usage.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/tablesdb\/{databaseId}": {
"get": {
"summary": "Get database",
"operationId": "tablesDBGet",
"tags": [
"tablesDB"
],
"description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.",
"responses": {
"200": {
"description": "Database",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/database"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": "tablesdb",
"weight": 335,
"cookies": false,
"type": "",
"demo": "tablesdb\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update database",
"operationId": "tablesDBUpdate",
"tags": [
"tablesDB"
],
"description": "Update a database by its unique ID.",
"responses": {
"200": {
"description": "Database",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/database"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "update",
"group": "tablesdb",
"weight": 336,
"cookies": false,
"type": "",
"demo": "tablesdb\/update.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Database name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"enabled": {
"type": "boolean",
"description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
"x-example": false
}
}
}
}
}
}
},
"delete": {
"summary": "Delete database",
"operationId": "tablesDBDelete",
"tags": [
"tablesDB"
],
"description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "tablesdb",
"weight": 337,
"cookies": false,
"type": "",
"demo": "tablesdb\/delete.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "databases.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
}
]
}
},
"\/tablesdb\/{databaseId}\/tables": {
"get": {
"summary": "List tables",
"operationId": "tablesDBListTables",
"tags": [
"tablesDB"
],
"description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.",
"responses": {
"200": {
"description": "Tables List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/tableList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listTables",
"group": "tables",
"weight": 345,
"cookies": false,
"type": "",
"demo": "tablesdb\/list-tables.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.read",
"collections.read"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"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 columns: name, enabled, rowSecurity",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create table",
"operationId": "tablesDBCreateTable",
"tags": [
"tablesDB"
],
"description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.",
"responses": {
"201": {
"description": "Table",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/table"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTable",
"group": "tables",
"weight": 341,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-table.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"tableId": {
"type": "string",
"description": "Unique 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.",
"x-example": "<TABLE_ID>"
},
"name": {
"type": "string",
"description": "Table name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"rowSecurity": {
"type": "boolean",
"description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": false
},
"enabled": {
"type": "boolean",
"description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.",
"x-example": false
},
"columns": {
"type": "array",
"description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.",
"x-example": null,
"items": {
"type": "object"
}
},
"indexes": {
"type": "array",
"description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).",
"x-example": null,
"items": {
"type": "object"
}
}
},
"required": [
"tableId",
"name"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}": {
"get": {
"summary": "Get table",
"operationId": "tablesDBGetTable",
"tags": [
"tablesDB"
],
"description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.",
"responses": {
"200": {
"description": "Table",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/table"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getTable",
"group": "tables",
"weight": 342,
"cookies": false,
"type": "",
"demo": "tablesdb\/get-table.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.read",
"collections.read"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update table",
"operationId": "tablesDBUpdateTable",
"tags": [
"tablesDB"
],
"description": "Update a table by its unique ID.",
"responses": {
"200": {
"description": "Table",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/table"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTable",
"group": "tables",
"weight": 343,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-table.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Table name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"permissions": {
"type": "array",
"description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"rowSecurity": {
"type": "boolean",
"description": "Enables configuring permissions for individual rows. A user needs one of row or table-level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": false
},
"enabled": {
"type": "boolean",
"description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.",
"x-example": false
}
}
}
}
}
}
},
"delete": {
"summary": "Delete table",
"operationId": "tablesDBDeleteTable",
"tags": [
"tablesDB"
],
"description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteTable",
"group": "tables",
"weight": 344,
"cookies": false,
"type": "",
"demo": "tablesdb\/delete-table.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
]
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": {
"get": {
"summary": "List columns",
"operationId": "tablesDBListColumns",
"tags": [
"tablesDB"
],
"description": "List columns in the table.",
"responses": {
"200": {
"description": "Columns List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listColumns",
"group": "columns",
"weight": 350,
"cookies": false,
"type": "",
"demo": "tablesdb\/list-columns.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.read",
"collections.read"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"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 columns: key, type, size, required, array, status, error",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": {
"post": {
"summary": "Create boolean column",
"operationId": "tablesDBCreateBooleanColumn",
"tags": [
"tablesDB"
],
"description": "Create a boolean column.\n",
"responses": {
"202": {
"description": "ColumnBoolean",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnBoolean"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createBooleanColumn",
"group": "columns",
"weight": 351,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-boolean-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "boolean",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": false,
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": {
"patch": {
"summary": "Update boolean column",
"operationId": "tablesDBUpdateBooleanColumn",
"tags": [
"tablesDB"
],
"description": "Update a boolean column. Changing the `default` value will not update already existing rows.",
"responses": {
"200": {
"description": "ColumnBoolean",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnBoolean"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateBooleanColumn",
"group": "columns",
"weight": 352,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-boolean-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "boolean",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": false,
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": {
"post": {
"summary": "Create datetime column",
"operationId": "tablesDBCreateDatetimeColumn",
"tags": [
"tablesDB"
],
"description": "Create a date time column according to the ISO 8601 standard.",
"responses": {
"202": {
"description": "ColumnDatetime",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnDatetime"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createDatetimeColumn",
"group": "columns",
"weight": 353,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-datetime-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.",
"x-example": null,
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": {
"patch": {
"summary": "Update dateTime column",
"operationId": "tablesDBUpdateDatetimeColumn",
"tags": [
"tablesDB"
],
"description": "Update a date time column. Changing the `default` value will not update already existing rows.",
"responses": {
"200": {
"description": "ColumnDatetime",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnDatetime"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateDatetimeColumn",
"group": "columns",
"weight": 354,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-datetime-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": null,
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": {
"post": {
"summary": "Create email column",
"operationId": "tablesDBCreateEmailColumn",
"tags": [
"tablesDB"
],
"description": "Create an email column.\n",
"responses": {
"202": {
"description": "ColumnEmail",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnEmail"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createEmailColumn",
"group": "columns",
"weight": 355,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-email-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "email@example.com",
"format": "email",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": {
"patch": {
"summary": "Update email column",
"operationId": "tablesDBUpdateEmailColumn",
"tags": [
"tablesDB"
],
"description": "Update an email column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnEmail",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnEmail"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateEmailColumn",
"group": "columns",
"weight": 356,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-email-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "email@example.com",
"format": "email",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": {
"post": {
"summary": "Create enum column",
"operationId": "tablesDBCreateEnumColumn",
"tags": [
"tablesDB"
],
"description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.",
"responses": {
"202": {
"description": "ColumnEnum",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnEnum"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createEnumColumn",
"group": "columns",
"weight": 357,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-enum-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"elements": {
"type": "array",
"description": "Array of enum values.",
"x-example": null,
"items": {
"type": "string"
}
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"elements",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": {
"patch": {
"summary": "Update enum column",
"operationId": "tablesDBUpdateEnumColumn",
"tags": [
"tablesDB"
],
"description": "Update an enum column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnEnum",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnEnum"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateEnumColumn",
"group": "columns",
"weight": 358,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-enum-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"elements": {
"type": "array",
"description": "Updated list of enum values.",
"x-example": null,
"items": {
"type": "string"
}
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"elements",
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": {
"post": {
"summary": "Create float column",
"operationId": "tablesDBCreateFloatColumn",
"tags": [
"tablesDB"
],
"description": "Create a float column. Optionally, minimum and maximum values can be provided.\n",
"responses": {
"202": {
"description": "ColumnFloat",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnFloat"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createFloatColumn",
"group": "columns",
"weight": 359,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-float-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"min": {
"type": "number",
"description": "Minimum value",
"x-example": null,
"format": "float",
"x-nullable": true
},
"max": {
"type": "number",
"description": "Maximum value",
"x-example": null,
"format": "float",
"x-nullable": true
},
"default": {
"type": "number",
"description": "Default value. Cannot be set when required.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": {
"patch": {
"summary": "Update float column",
"operationId": "tablesDBUpdateFloatColumn",
"tags": [
"tablesDB"
],
"description": "Update a float column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnFloat",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnFloat"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateFloatColumn",
"group": "columns",
"weight": 360,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-float-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"min": {
"type": "number",
"description": "Minimum value",
"x-example": null,
"format": "float",
"x-nullable": true
},
"max": {
"type": "number",
"description": "Maximum value",
"x-example": null,
"format": "float",
"x-nullable": true
},
"default": {
"type": "number",
"description": "Default value. Cannot be set when required.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": {
"post": {
"summary": "Create integer column",
"operationId": "tablesDBCreateIntegerColumn",
"tags": [
"tablesDB"
],
"description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n",
"responses": {
"202": {
"description": "ColumnInteger",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnInteger"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createIntegerColumn",
"group": "columns",
"weight": 361,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-integer-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"min": {
"type": "integer",
"description": "Minimum value",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"max": {
"type": "integer",
"description": "Maximum value",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"default": {
"type": "integer",
"description": "Default value. Cannot be set when column is required.",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": {
"patch": {
"summary": "Update integer column",
"operationId": "tablesDBUpdateIntegerColumn",
"tags": [
"tablesDB"
],
"description": "Update an integer column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnInteger",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnInteger"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateIntegerColumn",
"group": "columns",
"weight": 362,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-integer-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"min": {
"type": "integer",
"description": "Minimum value",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"max": {
"type": "integer",
"description": "Maximum value",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"default": {
"type": "integer",
"description": "Default value. Cannot be set when column is required.",
"x-example": null,
"format": "int64",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": {
"post": {
"summary": "Create IP address column",
"operationId": "tablesDBCreateIpColumn",
"tags": [
"tablesDB"
],
"description": "Create IP address column.\n",
"responses": {
"202": {
"description": "ColumnIP",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnIp"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createIpColumn",
"group": "columns",
"weight": 363,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-ip-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value. Cannot be set when column is required.",
"x-example": null,
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": {
"patch": {
"summary": "Update IP address column",
"operationId": "tablesDBUpdateIpColumn",
"tags": [
"tablesDB"
],
"description": "Update an ip column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnIP",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnIp"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateIpColumn",
"group": "columns",
"weight": 364,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-ip-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value. Cannot be set when column is required.",
"x-example": null,
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": {
"post": {
"summary": "Create line column",
"operationId": "tablesDBCreateLineColumn",
"tags": [
"tablesDB"
],
"description": "Create a geometric line column.",
"responses": {
"202": {
"description": "ColumnLine",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnLine"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createLineColumn",
"group": "columns",
"weight": 365,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-line-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.",
"x-example": "[[1, 2], [3, 4], [5, 6]]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": {
"patch": {
"summary": "Update line column",
"operationId": "tablesDBUpdateLineColumn",
"tags": [
"tablesDB"
],
"description": "Update a line column. Changing the `default` value will not update already existing rows.",
"responses": {
"200": {
"description": "ColumnLine",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnLine"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateLineColumn",
"group": "columns",
"weight": 366,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-line-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.",
"x-example": "[[1, 2], [3, 4], [5, 6]]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": {
"post": {
"summary": "Create longtext column",
"operationId": "tablesDBCreateLongtextColumn",
"tags": [
"tablesDB"
],
"description": "Create a longtext column.\n",
"responses": {
"202": {
"description": "ColumnLongtext",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnLongtext"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createLongtextColumn",
"group": "columns",
"weight": 383,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-longtext-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": {
"patch": {
"summary": "Update longtext column",
"operationId": "tablesDBUpdateLongtextColumn",
"tags": [
"tablesDB"
],
"description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnLongtext",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnLongtext"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateLongtextColumn",
"group": "columns",
"weight": 384,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-longtext-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": {
"post": {
"summary": "Create mediumtext column",
"operationId": "tablesDBCreateMediumtextColumn",
"tags": [
"tablesDB"
],
"description": "Create a mediumtext column.\n",
"responses": {
"202": {
"description": "ColumnMediumtext",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnMediumtext"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createMediumtextColumn",
"group": "columns",
"weight": 381,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-mediumtext-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": {
"patch": {
"summary": "Update mediumtext column",
"operationId": "tablesDBUpdateMediumtextColumn",
"tags": [
"tablesDB"
],
"description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnMediumtext",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnMediumtext"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateMediumtextColumn",
"group": "columns",
"weight": 382,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-mediumtext-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": {
"post": {
"summary": "Create point column",
"operationId": "tablesDBCreatePointColumn",
"tags": [
"tablesDB"
],
"description": "Create a geometric point column.",
"responses": {
"202": {
"description": "ColumnPoint",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnPoint"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createPointColumn",
"group": "columns",
"weight": 367,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-point-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.",
"x-example": "[1, 2]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": {
"patch": {
"summary": "Update point column",
"operationId": "tablesDBUpdatePointColumn",
"tags": [
"tablesDB"
],
"description": "Update a point column. Changing the `default` value will not update already existing rows.",
"responses": {
"200": {
"description": "ColumnPoint",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnPoint"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePointColumn",
"group": "columns",
"weight": 368,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-point-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.",
"x-example": "[1, 2]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": {
"post": {
"summary": "Create polygon column",
"operationId": "tablesDBCreatePolygonColumn",
"tags": [
"tablesDB"
],
"description": "Create a geometric polygon column.",
"responses": {
"202": {
"description": "ColumnPolygon",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnPolygon"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createPolygonColumn",
"group": "columns",
"weight": 369,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-polygon-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.",
"x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": {
"patch": {
"summary": "Update polygon column",
"operationId": "tablesDBUpdatePolygonColumn",
"tags": [
"tablesDB"
],
"description": "Update a polygon column. Changing the `default` value will not update already existing rows.",
"responses": {
"200": {
"description": "ColumnPolygon",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnPolygon"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePolygonColumn",
"group": "columns",
"weight": 370,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-polygon-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "array",
"description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.",
"x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]",
"items": {
"oneOf": [
{
"type": "array"
}
]
},
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": {
"post": {
"summary": "Create relationship column",
"operationId": "tablesDBCreateRelationshipColumn",
"tags": [
"tablesDB"
],
"description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n",
"responses": {
"202": {
"description": "ColumnRelationship",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnRelationship"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createRelationshipColumn",
"group": "columns",
"weight": 371,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-relationship-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"relatedTableId": {
"type": "string",
"description": "Related Table ID.",
"x-example": "<RELATED_TABLE_ID>"
},
"type": {
"type": "string",
"description": "Relation type",
"x-example": "oneToOne",
"enum": [
"oneToOne",
"manyToOne",
"manyToMany",
"oneToMany"
],
"x-enum-name": "RelationshipType",
"x-enum-keys": []
},
"twoWay": {
"type": "boolean",
"description": "Is Two Way?",
"x-example": false
},
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null,
"x-nullable": true
},
"twoWayKey": {
"type": "string",
"description": "Two Way Column Key.",
"x-example": null,
"x-nullable": true
},
"onDelete": {
"type": "string",
"description": "Constraints option",
"x-example": "cascade",
"enum": [
"cascade",
"restrict",
"setNull"
],
"x-enum-name": "RelationMutate",
"x-enum-keys": []
}
},
"required": [
"relatedTableId",
"type"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": {
"post": {
"summary": "Create string column",
"operationId": "tablesDBCreateStringColumn",
"tags": [
"tablesDB"
],
"description": "Create a string column.\n",
"responses": {
"202": {
"description": "ColumnString",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnString"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createStringColumn",
"group": "columns",
"weight": 373,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-string-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md",
"deprecated": {
"since": "1.9.0",
"replaceWith": "tablesDB.createTextColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"size": {
"type": "integer",
"description": "Column size for text columns, in number of characters.",
"x-example": 1,
"format": "int32"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
},
"encrypt": {
"type": "boolean",
"description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.",
"x-example": false
}
},
"required": [
"key",
"size",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": {
"patch": {
"summary": "Update string column",
"operationId": "tablesDBUpdateStringColumn",
"tags": [
"tablesDB"
],
"description": "Update a string column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnString",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnString"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateStringColumn",
"group": "columns",
"weight": 374,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-string-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "tablesDB.updateTextColumn"
},
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"size": {
"type": "integer",
"description": "Maximum size of the string column.",
"x-example": 1,
"format": "int32",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": {
"post": {
"summary": "Create text column",
"operationId": "tablesDBCreateTextColumn",
"tags": [
"tablesDB"
],
"description": "Create a text column.\n",
"responses": {
"202": {
"description": "ColumnText",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnText"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTextColumn",
"group": "columns",
"weight": 379,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-text-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": {
"patch": {
"summary": "Update text column",
"operationId": "tablesDBUpdateTextColumn",
"tags": [
"tablesDB"
],
"description": "Update a text column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnText",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnText"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTextColumn",
"group": "columns",
"weight": 380,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-text-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": {
"post": {
"summary": "Create URL column",
"operationId": "tablesDBCreateUrlColumn",
"tags": [
"tablesDB"
],
"description": "Create a URL column.\n",
"responses": {
"202": {
"description": "ColumnURL",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnUrl"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createUrlColumn",
"group": "columns",
"weight": 375,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-url-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "https:\/\/example.com",
"format": "url",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": {
"patch": {
"summary": "Update URL column",
"operationId": "tablesDBUpdateUrlColumn",
"tags": [
"tablesDB"
],
"description": "Update an url column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnURL",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnUrl"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateUrlColumn",
"group": "columns",
"weight": 376,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-url-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "https:\/\/example.com",
"format": "url",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": {
"post": {
"summary": "Create varchar column",
"operationId": "tablesDBCreateVarcharColumn",
"tags": [
"tablesDB"
],
"description": "Create a varchar column.\n",
"responses": {
"202": {
"description": "ColumnVarchar",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnVarchar"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createVarcharColumn",
"group": "columns",
"weight": 377,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-varchar-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": null
},
"size": {
"type": "integer",
"description": "Column size for varchar columns, in number of characters. Maximum size is 16381.",
"x-example": 1,
"format": "int32"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false
}
},
"required": [
"key",
"size",
"required"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": {
"patch": {
"summary": "Update varchar column",
"operationId": "tablesDBUpdateVarcharColumn",
"tags": [
"tablesDB"
],
"description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n",
"responses": {
"200": {
"description": "ColumnVarchar",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnVarchar"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateVarcharColumn",
"group": "columns",
"weight": 378,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-varchar-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": false
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "<DEFAULT>",
"x-nullable": true
},
"size": {
"type": "integer",
"description": "Maximum size of the varchar column.",
"x-example": 1,
"format": "int32",
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
},
"required": [
"required",
"default"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}": {
"get": {
"summary": "Get column",
"operationId": "tablesDBGetColumn",
"tags": [
"tablesDB"
],
"description": "Get column by ID.",
"responses": {
"200": {
"description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString",
"content": {
"application\/json": {
"schema": {
"oneOf": [
{
"$ref": "#\/components\/schemas\/columnBoolean"
},
{
"$ref": "#\/components\/schemas\/columnInteger"
},
{
"$ref": "#\/components\/schemas\/columnFloat"
},
{
"$ref": "#\/components\/schemas\/columnEmail"
},
{
"$ref": "#\/components\/schemas\/columnEnum"
},
{
"$ref": "#\/components\/schemas\/columnUrl"
},
{
"$ref": "#\/components\/schemas\/columnIp"
},
{
"$ref": "#\/components\/schemas\/columnDatetime"
},
{
"$ref": "#\/components\/schemas\/columnRelationship"
},
{
"$ref": "#\/components\/schemas\/columnString"
}
]
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getColumn",
"group": "columns",
"weight": 348,
"cookies": false,
"type": "",
"demo": "tablesdb\/get-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.read",
"collections.read"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete column",
"operationId": "tablesDBDeleteColumn",
"tags": [
"tablesDB"
],
"description": "Deletes a column.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteColumn",
"group": "columns",
"weight": 349,
"cookies": false,
"type": "",
"demo": "tablesdb\/delete-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
]
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": {
"patch": {
"summary": "Update relationship column",
"operationId": "tablesDBUpdateRelationshipColumn",
"tags": [
"tablesDB"
],
"description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n",
"responses": {
"200": {
"description": "ColumnRelationship",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnRelationship"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateRelationshipColumn",
"group": "columns",
"weight": 372,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-relationship-column.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-relationship-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Column Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"onDelete": {
"type": "string",
"description": "Constraints option",
"x-example": "cascade",
"enum": [
"cascade",
"restrict",
"setNull"
],
"x-enum-name": "RelationMutate",
"x-enum-keys": [],
"x-nullable": true
},
"newKey": {
"type": "string",
"description": "New Column Key.",
"x-example": null,
"x-nullable": true
}
}
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes": {
"get": {
"summary": "List indexes",
"operationId": "tablesDBListIndexes",
"tags": [
"tablesDB"
],
"description": "List indexes on the table.",
"responses": {
"200": {
"description": "Column Indexes List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnIndexList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listIndexes",
"group": "indexes",
"weight": 388,
"cookies": false,
"type": "",
"demo": "tablesdb\/list-indexes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.read",
"collections.read"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-indexes.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"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 columns: key, type, status, attributes, error",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create index",
"operationId": "tablesDBCreateIndex",
"tags": [
"tablesDB"
],
"description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.",
"responses": {
"202": {
"description": "Index",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnIndex"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createIndex",
"group": "indexes",
"weight": 385,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-index.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-index.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Index Key.",
"x-example": null
},
"type": {
"type": "string",
"description": "Index type.",
"x-example": "key",
"enum": [
"key",
"fulltext",
"unique",
"spatial"
],
"x-enum-name": "IndexType",
"x-enum-keys": []
},
"columns": {
"type": "array",
"description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.",
"x-example": null,
"items": {
"type": "string"
}
},
"orders": {
"type": "array",
"description": "Array of index orders. Maximum of 100 orders are allowed.",
"x-example": null,
"items": {
"type": "string",
"enum": [
"asc",
"desc"
],
"x-enum-name": "OrderBy",
"x-enum-keys": []
}
},
"lengths": {
"type": "array",
"description": "Length of index. Maximum of 100",
"x-example": null,
"items": {
"type": "integer"
}
}
},
"required": [
"key",
"type",
"columns"
]
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": {
"get": {
"summary": "Get index",
"operationId": "tablesDBGetIndex",
"tags": [
"tablesDB"
],
"description": "Get index by ID.",
"responses": {
"200": {
"description": "Index",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/columnIndex"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getIndex",
"group": "indexes",
"weight": 386,
"cookies": false,
"type": "",
"demo": "tablesdb\/get-index.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.read",
"collections.read"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-index.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Index Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete index",
"operationId": "tablesDBDeleteIndex",
"tags": [
"tablesDB"
],
"description": "Delete an index.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteIndex",
"group": "indexes",
"weight": 387,
"cookies": false,
"type": "",
"demo": "tablesdb\/delete-index.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.write",
"collections.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-index.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "key",
"description": "Index Key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
]
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/logs": {
"get": {
"summary": "List table logs",
"operationId": "tablesDBListTableLogs",
"tags": [
"tablesDB"
],
"description": "Get the table activity logs list by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listTableLogs",
"group": "tables",
"weight": 346,
"cookies": false,
"type": "",
"demo": "tablesdb\/list-table-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.read",
"collections.read"
],
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-logs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": {
"get": {
"summary": "List rows",
"operationId": "tablesDBListRows",
"tags": [
"tablesDB"
],
"description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Rows List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/rowList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listRows",
"group": "rows",
"weight": 397,
"cookies": false,
"type": "",
"demo": "tablesdb\/list-rows.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"rows.read",
"documents.read"
],
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/products\/databases\/tables#create-table).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"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.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
},
{
"name": "transactionId",
"description": "Transaction ID to read uncommitted changes within the transaction.",
"required": false,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create row",
"operationId": "tablesDBCreateRow",
"tags": [
"tablesDB"
],
"description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.",
"responses": {
"201": {
"description": "Row",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/row"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createRow",
"group": "rows",
"weight": 389,
"cookies": false,
"type": "",
"demo": "tablesdb\/create-row.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": [
"rows.write",
"documents.write"
],
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md",
"methods": [
{
"name": "createRow",
"namespace": "tablesDB",
"desc": "Create row",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"tableId",
"rowId",
"data",
"permissions",
"transactionId"
],
"required": [
"databaseId",
"tableId",
"rowId",
"data"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/row"
}
],
"description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.",
"demo": "tablesdb\/create-row.md",
"public": true
},
{
"name": "createRows",
"namespace": "tablesDB",
"desc": "Create rows",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"tableId",
"rows",
"transactionId"
],
"required": [
"databaseId",
"tableId",
"rows"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/rowList"
}
],
"description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.",
"demo": "tablesdb\/create-rows.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable). Make sure to define columns before creating rows.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"rowId": {
"type": "string",
"description": "Row 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.",
"x-example": "<ROW_ID>"
},
"data": {
"type": "object",
"description": "Row data as JSON object.",
"x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}"
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"rows": {
"type": "array",
"description": "Array of rows data as JSON objects.",
"x-example": null,
"items": {
"type": "object"
}
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
},
"put": {
"summary": "Upsert rows",
"operationId": "tablesDBUpsertRows",
"tags": [
"tablesDB"
],
"description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n",
"responses": {
"201": {
"description": "Rows List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/rowList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "upsertRows",
"group": "rows",
"weight": 394,
"cookies": false,
"type": "",
"demo": "tablesdb\/upsert-rows.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": [
"rows.write",
"documents.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-rows.md",
"methods": [
{
"name": "upsertRows",
"namespace": "tablesDB",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"tableId",
"rows",
"transactionId"
],
"required": [
"databaseId",
"tableId",
"rows"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/rowList"
}
],
"description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.\n",
"demo": "tablesdb\/upsert-rows.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"description": "Array of row data as JSON objects. May contain partial rows.",
"x-example": null,
"items": {
"type": "object"
}
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
},
"required": [
"rows"
]
}
}
}
}
},
"patch": {
"summary": "Update rows",
"operationId": "tablesDBUpdateRows",
"tags": [
"tablesDB"
],
"description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.",
"responses": {
"200": {
"description": "Rows List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/rowList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateRows",
"group": "rows",
"weight": 392,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-rows.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": [
"rows.write",
"documents.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Row data as JSON object. Include only column and value pairs to be updated.",
"x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}"
},
"queries": {
"type": "array",
"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.",
"x-example": null,
"items": {
"type": "string"
}
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
},
"delete": {
"summary": "Delete rows",
"operationId": "tablesDBDeleteRows",
"tags": [
"tablesDB"
],
"description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.",
"responses": {
"200": {
"description": "Rows List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/rowList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteRows",
"group": "rows",
"weight": 396,
"cookies": false,
"type": "",
"demo": "tablesdb\/delete-rows.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": [
"rows.write",
"documents.write"
],
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"queries": {
"type": "array",
"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.",
"x-example": null,
"items": {
"type": "string"
}
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": {
"get": {
"summary": "Get row",
"operationId": "tablesDBGetRow",
"tags": [
"tablesDB"
],
"description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.",
"responses": {
"200": {
"description": "Row",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/row"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getRow",
"group": "rows",
"weight": 390,
"cookies": false,
"type": "",
"demo": "tablesdb\/get-row.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"rows.read",
"documents.read"
],
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "rowId",
"description": "Row ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<ROW_ID>"
},
"in": "path"
},
{
"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.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
},
{
"name": "transactionId",
"description": "Transaction ID to read uncommitted changes within the transaction.",
"required": false,
"schema": {
"type": "string",
"x-example": "<TRANSACTION_ID>"
},
"in": "query"
}
]
},
"put": {
"summary": "Upsert a row",
"operationId": "tablesDBUpsertRow",
"tags": [
"tablesDB"
],
"description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.",
"responses": {
"201": {
"description": "Row",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/row"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "upsertRow",
"group": "rows",
"weight": 393,
"cookies": false,
"type": "",
"demo": "tablesdb\/upsert-row.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": [
"rows.write",
"documents.write"
],
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md",
"methods": [
{
"name": "upsertRow",
"namespace": "tablesDB",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"tableId",
"rowId",
"data",
"permissions",
"transactionId"
],
"required": [
"databaseId",
"tableId",
"rowId"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/row"
}
],
"description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.",
"demo": "tablesdb\/upsert-row.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "rowId",
"description": "Row ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<ROW_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Row data as JSON object. Include all required columns of the row to be created or updated.",
"x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}"
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
},
"patch": {
"summary": "Update row",
"operationId": "tablesDBUpdateRow",
"tags": [
"tablesDB"
],
"description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.",
"responses": {
"200": {
"description": "Row",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/row"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateRow",
"group": "rows",
"weight": 391,
"cookies": false,
"type": "",
"demo": "tablesdb\/update-row.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": [
"rows.write",
"documents.write"
],
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "rowId",
"description": "Row ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<ROW_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"data": {
"type": "object",
"description": "Row data as JSON object. Include only columns and value pairs to be updated.",
"x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}"
},
"permissions": {
"type": "array",
"description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": "[\"read(\"any\")\"]",
"items": {
"type": "string"
},
"x-nullable": true
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
},
"delete": {
"summary": "Delete row",
"operationId": "tablesDBDeleteRow",
"tags": [
"tablesDB"
],
"description": "Delete a row by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteRow",
"group": "rows",
"weight": 395,
"cookies": false,
"type": "",
"demo": "tablesdb\/delete-row.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": [
"rows.write",
"documents.write"
],
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "rowId",
"description": "Row ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<ROW_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": {
"get": {
"summary": "List row logs",
"operationId": "tablesDBListRowLogs",
"tags": [
"tablesDB"
],
"description": "Get the row activity logs list by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listRowLogs",
"group": "logs",
"weight": 398,
"cookies": false,
"type": "",
"demo": "tablesdb\/list-row-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"rows.read",
"documents.read"
],
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row-logs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "rowId",
"description": "Row ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<ROW_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": {
"patch": {
"summary": "Decrement row column",
"operationId": "tablesDBDecrementRowColumn",
"tags": [
"tablesDB"
],
"description": "Decrement a specific column of a row by a given value.",
"responses": {
"200": {
"description": "Row",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/row"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "decrementRowColumn",
"group": "rows",
"weight": 400,
"cookies": false,
"type": "",
"demo": "tablesdb\/decrement-row-column.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": [
"rows.write",
"documents.write"
],
"platforms": [
"client",
"server",
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "rowId",
"description": "Row ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<ROW_ID>"
},
"in": "path"
},
{
"name": "column",
"description": "Column key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "Value to increment the column by. The value must be a number.",
"x-example": null,
"format": "float"
},
"min": {
"type": "number",
"description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": {
"patch": {
"summary": "Increment row column",
"operationId": "tablesDBIncrementRowColumn",
"tags": [
"tablesDB"
],
"description": "Increment a specific column of a row by a given value.",
"responses": {
"200": {
"description": "Row",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/row"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "incrementRowColumn",
"group": "rows",
"weight": 399,
"cookies": false,
"type": "",
"demo": "tablesdb\/increment-row-column.md",
"rate-limit": 120,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": [
"rows.write",
"documents.write"
],
"platforms": [
"client",
"server",
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": [],
"Key": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
},
{
"name": "rowId",
"description": "Row ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<ROW_ID>"
},
"in": "path"
},
{
"name": "column",
"description": "Column key.",
"required": true,
"schema": {
"type": "string"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"value": {
"type": "number",
"description": "Value to increment the column by. The value must be a number.",
"x-example": null,
"format": "float"
},
"max": {
"type": "number",
"description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.",
"x-example": null,
"format": "float",
"x-nullable": true
},
"transactionId": {
"type": "string",
"description": "Transaction ID for staging the operation.",
"x-example": "<TRANSACTION_ID>",
"x-nullable": true
}
}
}
}
}
}
}
},
"\/tablesdb\/{databaseId}\/tables\/{tableId}\/usage": {
"get": {
"summary": "Get table usage stats",
"operationId": "tablesDBGetTableUsage",
"tags": [
"tablesDB"
],
"description": "Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"responses": {
"200": {
"description": "UsageTable",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageTable"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getTableUsage",
"group": null,
"weight": 347,
"cookies": false,
"type": "",
"demo": "tablesdb\/get-table-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.read",
"collections.read"
],
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-usage.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
},
{
"name": "tableId",
"description": "Table ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TABLE_ID>"
},
"in": "path"
}
]
}
},
"\/tablesdb\/{databaseId}\/usage": {
"get": {
"summary": "Get TablesDB usage stats",
"operationId": "tablesDBGetUsage",
"tags": [
"tablesDB"
],
"description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"responses": {
"200": {
"description": "UsageDatabase",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageDatabase"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
"weight": 339,
"cookies": false,
"type": "",
"demo": "tablesdb\/get-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": [
"tables.read",
"collections.read"
],
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-database-usage.md",
"methods": [
{
"name": "getUsage",
"namespace": "tablesDB",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"databaseId",
"range"
],
"required": [
"databaseId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/usageDatabase"
}
],
"description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"demo": "tablesdb\/get-usage.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "databaseId",
"description": "Database ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<DATABASE_ID>"
},
"in": "path"
},
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/teams": {
"get": {
"summary": "List teams",
"operationId": "teamsList",
"tags": [
"teams"
],
"description": "Get a list of all the teams in which the current user is a member. You can use the parameters to filter your results.",
"responses": {
"200": {
"description": "Teams List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/teamList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "list",
"group": "teams",
"weight": 107,
"cookies": false,
"type": "",
"demo": "teams\/list.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"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, total, billingPlan",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create team",
"operationId": "teamsCreate",
"tags": [
"teams"
],
"description": "Create a new team. The user who creates the team will automatically be assigned as the owner of the team. Only the users with the owner role can invite new members, add new owners and delete or update the team.",
"responses": {
"201": {
"description": "Team",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/team"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "create",
"group": "teams",
"weight": 106,
"cookies": false,
"type": "",
"demo": "teams\/create.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"teamId": {
"type": "string",
"description": "Team 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.",
"x-example": "<TEAM_ID>"
},
"name": {
"type": "string",
"description": "Team name. Max length: 128 chars.",
"x-example": "<NAME>"
},
"roles": {
"type": "array",
"description": "Array of strings. Use this param to set the roles in the team for the user who created it. The default role is **owner**. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.",
"x-example": null,
"items": {
"type": "string"
}
}
},
"required": [
"teamId",
"name"
]
}
}
}
}
}
},
"\/teams\/{teamId}": {
"get": {
"summary": "Get team",
"operationId": "teamsGet",
"tags": [
"teams"
],
"description": "Get a team by its ID. All team members have read access for this resource.",
"responses": {
"200": {
"description": "Team",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/team"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": "teams",
"weight": 108,
"cookies": false,
"type": "",
"demo": "teams\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update name",
"operationId": "teamsUpdateName",
"tags": [
"teams"
],
"description": "Update the team's name by its unique ID.",
"responses": {
"200": {
"description": "Team",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/team"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateName",
"group": "teams",
"weight": 110,
"cookies": false,
"type": "",
"demo": "teams\/update-name.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "New team name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"name"
]
}
}
}
}
},
"delete": {
"summary": "Delete team",
"operationId": "teamsDelete",
"tags": [
"teams"
],
"description": "Delete a team using its ID. Only team members with the owner role can delete the team.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "teams",
"weight": 112,
"cookies": false,
"type": "",
"demo": "teams\/delete.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
}
]
}
},
"\/teams\/{teamId}\/logs": {
"get": {
"summary": "List team logs",
"operationId": "teamsListLogs",
"tags": [
"teams"
],
"description": "Get the team activity logs list by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
"weight": 119,
"cookies": false,
"type": "",
"demo": "teams\/list-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/teams\/{teamId}\/memberships": {
"get": {
"summary": "List team memberships",
"operationId": "teamsListMemberships",
"tags": [
"teams"
],
"description": "Use this endpoint to list a team's members using the team's ID. All team members have read access to this endpoint. Hide sensitive attributes from the response by toggling membership privacy in the Console.",
"responses": {
"200": {
"description": "Memberships List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/membershipList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listMemberships",
"group": "memberships",
"weight": 114,
"cookies": false,
"type": "",
"demo": "teams\/list-memberships.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
},
{
"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: userId, teamId, invited, joined, confirm, roles",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create team membership",
"operationId": "teamsCreateMembership",
"tags": [
"teams"
],
"description": "Invite a new member to join your team. Provide an ID for existing users, or invite unregistered users using an email or phone number. If initiated from a Client SDK, Appwrite will send an email or sms with a link to join the team to the invited user, and an account will be created for them if one doesn't exist. If initiated from a Server SDK, the new member will be added automatically to the team.\n\nYou only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters.\n\nUse the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. \n\nPlease note that to avoid a [Redirect Attack](https:\/\/github.com\/OWASP\/CheatSheetSeries\/blob\/master\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console.\n",
"responses": {
"201": {
"description": "Membership",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/membership"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createMembership",
"group": "memberships",
"weight": 113,
"cookies": false,
"type": "",
"demo": "teams\/create-membership.md",
"rate-limit": 10,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "Email of the new team member.",
"x-example": "email@example.com",
"format": "email"
},
"userId": {
"type": "string",
"description": "ID of the user to be added to a team.",
"x-example": "<USER_ID>"
},
"phone": {
"type": "string",
"description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.",
"x-example": "+12065550100",
"format": "phone"
},
"roles": {
"type": "array",
"description": "Array of strings. Use this param to set the user roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.",
"x-example": null,
"items": {
"type": "string"
}
},
"url": {
"type": "string",
"description": "URL to redirect the user back to your app from the invitation email. This parameter is not required when an API key is supplied. Only URLs from hostnames in your project platform list are allowed. This requirement helps to prevent an [open redirect](https:\/\/cheatsheetseries.owasp.org\/cheatsheets\/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.html) attack against your project API.",
"x-example": "https:\/\/example.com",
"format": "url"
},
"name": {
"type": "string",
"description": "Name of the new team member. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"roles"
]
}
}
}
}
}
},
"\/teams\/{teamId}\/memberships\/{membershipId}": {
"get": {
"summary": "Get team membership",
"operationId": "teamsGetMembership",
"tags": [
"teams"
],
"description": "Get a team member by the membership unique id. All team members have read access for this resource. Hide sensitive attributes from the response by toggling membership privacy in the Console.",
"responses": {
"200": {
"description": "Membership",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/membership"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getMembership",
"group": "memberships",
"weight": 115,
"cookies": false,
"type": "",
"demo": "teams\/get-membership.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.read",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
},
{
"name": "membershipId",
"description": "Membership ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MEMBERSHIP_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Update membership",
"operationId": "teamsUpdateMembership",
"tags": [
"teams"
],
"description": "Modify the roles of a team member. Only team members with the owner role have access to this endpoint. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions).\n",
"responses": {
"200": {
"description": "Membership",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/membership"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateMembership",
"group": "memberships",
"weight": 116,
"cookies": false,
"type": "",
"demo": "teams\/update-membership.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
},
{
"name": "membershipId",
"description": "Membership ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MEMBERSHIP_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"roles": {
"type": "array",
"description": "An array of strings. Use this param to set the user's roles in the team. A role can be any string. Learn more about [roles and permissions](https:\/\/appwrite.io\/docs\/permissions). Maximum of 100 roles are allowed, each 32 characters long.",
"x-example": null,
"items": {
"type": "string"
}
}
},
"required": [
"roles"
]
}
}
}
}
},
"delete": {
"summary": "Delete team membership",
"operationId": "teamsDeleteMembership",
"tags": [
"teams"
],
"description": "This endpoint allows a user to leave a team or for a team owner to delete the membership of any other team member. You can also use this endpoint to delete a user membership even if it is not accepted.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteMembership",
"group": "memberships",
"weight": 118,
"cookies": false,
"type": "",
"demo": "teams\/delete-membership.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.write",
"platforms": [
"console",
"client",
"server",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
},
{
"name": "membershipId",
"description": "Membership ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MEMBERSHIP_ID>"
},
"in": "path"
}
]
}
},
"\/teams\/{teamId}\/memberships\/{membershipId}\/status": {
"patch": {
"summary": "Update team membership status",
"operationId": "teamsUpdateMembershipStatus",
"tags": [
"teams"
],
"description": "Use this endpoint to allow a user to accept an invitation to join a team after being redirected back to your app from the invitation email received by the user.\n\nIf the request is successful, a session for the user is automatically created.\n",
"responses": {
"200": {
"description": "Membership",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/membership"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateMembershipStatus",
"group": "memberships",
"weight": 117,
"cookies": false,
"type": "",
"demo": "teams\/update-membership-status.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "public",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
},
{
"name": "membershipId",
"description": "Membership ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<MEMBERSHIP_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "<USER_ID>"
},
"secret": {
"type": "string",
"description": "Secret key.",
"x-example": "<SECRET>"
}
},
"required": [
"userId",
"secret"
]
}
}
}
}
}
},
"\/teams\/{teamId}\/prefs": {
"get": {
"summary": "Get team preferences",
"operationId": "teamsGetPrefs",
"tags": [
"teams"
],
"description": "Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#getPrefs).",
"responses": {
"200": {
"description": "Preferences",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/preferences"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getPrefs",
"group": "teams",
"weight": 109,
"cookies": false,
"type": "",
"demo": "teams\/get-prefs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.read",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update preferences",
"operationId": "teamsUpdatePrefs",
"tags": [
"teams"
],
"description": "Update the team's preferences by its unique ID. The object you pass is stored as is and replaces any previous value. The maximum allowed prefs size is 64kB and throws an error if exceeded.",
"responses": {
"200": {
"description": "Preferences",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/preferences"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePrefs",
"group": "teams",
"weight": 111,
"cookies": false,
"type": "",
"demo": "teams\/update-prefs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "teams.write",
"platforms": [
"console",
"client",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"JWT": []
}
],
"parameters": [
{
"name": "teamId",
"description": "Team ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TEAM_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"prefs": {
"type": "object",
"description": "Prefs key-value JSON object.",
"x-example": "{}"
}
},
"required": [
"prefs"
]
}
}
}
}
}
},
"\/tokens\/buckets\/{bucketId}\/files\/{fileId}": {
"get": {
"summary": "List tokens",
"operationId": "tokensList",
"tags": [
"tokens"
],
"description": "List all the tokens created for a specific file or bucket. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Resource Tokens List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/resourceTokenList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "list",
"group": "files",
"weight": 522,
"cookies": false,
"type": "",
"demo": "tokens\/list.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "tokens.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
},
{
"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: expire",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create file token",
"operationId": "tokensCreateFileToken",
"tags": [
"tokens"
],
"description": "Create a new token. A token is linked to a file. Token can be passed as a request URL search parameter.",
"responses": {
"201": {
"description": "ResourceToken",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/resourceToken"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createFileToken",
"group": "files",
"weight": 520,
"cookies": false,
"type": "",
"demo": "tokens\/create-file-token.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "tokens.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "bucketId",
"description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).",
"required": true,
"schema": {
"type": "string",
"x-example": "<BUCKET_ID>"
},
"in": "path"
},
{
"name": "fileId",
"description": "File unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<FILE_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"expire": {
"type": "string",
"description": "Token expiry date",
"x-example": null,
"x-nullable": true
}
}
}
}
}
}
}
},
"\/tokens\/{tokenId}": {
"get": {
"summary": "Get token",
"operationId": "tokensGet",
"tags": [
"tokens"
],
"description": "Get a token by its unique ID.",
"responses": {
"200": {
"description": "ResourceToken",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/resourceToken"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": "tokens",
"weight": 521,
"cookies": false,
"type": "",
"demo": "tokens\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "tokens.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "tokenId",
"description": "Token ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOKEN_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Update token",
"operationId": "tokensUpdate",
"tags": [
"tokens"
],
"description": "Update a token by its unique ID. Use this endpoint to update a token's expiry date.",
"responses": {
"200": {
"description": "ResourceToken",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/resourceToken"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "update",
"group": "tokens",
"weight": 523,
"cookies": false,
"type": "",
"demo": "tokens\/update.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "tokens.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "tokenId",
"description": "Token unique ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOKEN_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"expire": {
"type": "string",
"description": "File token expiry date",
"x-example": null,
"x-nullable": true
}
}
}
}
}
}
},
"delete": {
"summary": "Delete token",
"operationId": "tokensDelete",
"tags": [
"tokens"
],
"description": "Delete a token by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "tokens",
"weight": 524,
"cookies": false,
"type": "",
"demo": "tokens\/delete.md",
"rate-limit": 60,
"rate-time": 60,
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "tokens.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "tokenId",
"description": "Token ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TOKEN_ID>"
},
"in": "path"
}
]
}
},
"\/users": {
"get": {
"summary": "List users",
"operationId": "usersList",
"tags": [
"users"
],
"description": "Get a list of all the project's users. You can use the query params to filter your results.",
"responses": {
"200": {
"description": "Users List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/userList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "list",
"group": "users",
"weight": 129,
"cookies": false,
"type": "",
"demo": "users\/list.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md",
"auth": {
"Project": []
}
},
"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, email, phone, status, passwordUpdate, registration, emailVerification, phoneVerification, labels",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create user",
"operationId": "usersCreate",
"tags": [
"users"
],
"description": "Create a new user.",
"responses": {
"201": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "create",
"group": "users",
"weight": 120,
"cookies": false,
"type": "",
"demo": "users\/create.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email",
"x-nullable": true
},
"phone": {
"type": "string",
"description": "Phone number. Format this number with a leading '+' and a country code, e.g., +16175551212.",
"x-example": "+12065550100",
"format": "phone",
"x-nullable": true
},
"password": {
"type": "string",
"description": "Plain text user password. Must be at least 8 chars.",
"x-example": null
},
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"userId"
]
}
}
}
}
}
},
"\/users\/argon2": {
"post": {
"summary": "Create user with Argon2 password",
"operationId": "usersCreateArgon2User",
"tags": [
"users"
],
"description": "Create a new user. Password provided must be hashed with the [Argon2](https:\/\/en.wikipedia.org\/wiki\/Argon2) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.",
"responses": {
"201": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createArgon2User",
"group": "users",
"weight": 123,
"cookies": false,
"type": "",
"demo": "users\/create-argon-2-user.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"password": {
"type": "string",
"description": "User password hashed using Argon2.",
"x-example": "password",
"format": "password"
},
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"userId",
"email",
"password"
]
}
}
}
}
}
},
"\/users\/bcrypt": {
"post": {
"summary": "Create user with bcrypt password",
"operationId": "usersCreateBcryptUser",
"tags": [
"users"
],
"description": "Create a new user. Password provided must be hashed with the [Bcrypt](https:\/\/en.wikipedia.org\/wiki\/Bcrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.",
"responses": {
"201": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createBcryptUser",
"group": "users",
"weight": 121,
"cookies": false,
"type": "",
"demo": "users\/create-bcrypt-user.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"password": {
"type": "string",
"description": "User password hashed using Bcrypt.",
"x-example": "password",
"format": "password"
},
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"userId",
"email",
"password"
]
}
}
}
}
}
},
"\/users\/identities": {
"get": {
"summary": "List identities",
"operationId": "usersListIdentities",
"tags": [
"users"
],
"description": "Get identities for all users.",
"responses": {
"200": {
"description": "Identities List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/identityList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listIdentities",
"group": "identities",
"weight": 137,
"cookies": false,
"type": "",
"demo": "users\/list-identities.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md",
"auth": {
"Project": []
}
},
"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: userId, provider, providerUid, providerEmail, providerAccessTokenExpiry",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/users\/identities\/{identityId}": {
"delete": {
"summary": "Delete identity",
"operationId": "usersDeleteIdentity",
"tags": [
"users"
],
"description": "Delete an identity by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteIdentity",
"group": "identities",
"weight": 160,
"cookies": false,
"type": "",
"demo": "users\/delete-identity.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "identityId",
"description": "Identity ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<IDENTITY_ID>"
},
"in": "path"
}
]
}
},
"\/users\/md5": {
"post": {
"summary": "Create user with MD5 password",
"operationId": "usersCreateMD5User",
"tags": [
"users"
],
"description": "Create a new user. Password provided must be hashed with the [MD5](https:\/\/en.wikipedia.org\/wiki\/MD5) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.",
"responses": {
"201": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createMD5User",
"group": "users",
"weight": 122,
"cookies": false,
"type": "",
"demo": "users\/create-md-5-user.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"password": {
"type": "string",
"description": "User password hashed using MD5.",
"x-example": "password",
"format": "password"
},
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"userId",
"email",
"password"
]
}
}
}
}
}
},
"\/users\/phpass": {
"post": {
"summary": "Create user with PHPass password",
"operationId": "usersCreatePHPassUser",
"tags": [
"users"
],
"description": "Create a new user. Password provided must be hashed with the [PHPass](https:\/\/www.openwall.com\/phpass\/) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.",
"responses": {
"201": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createPHPassUser",
"group": "users",
"weight": 125,
"cookies": false,
"type": "",
"demo": "users\/create-ph-pass-user.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User ID. Choose a custom ID or pass the string `ID.unique()`to auto generate it. 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.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"password": {
"type": "string",
"description": "User password hashed using PHPass.",
"x-example": "password",
"format": "password"
},
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"userId",
"email",
"password"
]
}
}
}
}
}
},
"\/users\/scrypt": {
"post": {
"summary": "Create user with Scrypt password",
"operationId": "usersCreateScryptUser",
"tags": [
"users"
],
"description": "Create a new user. Password provided must be hashed with the [Scrypt](https:\/\/github.com\/Tarsnap\/scrypt) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.",
"responses": {
"201": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createScryptUser",
"group": "users",
"weight": 126,
"cookies": false,
"type": "",
"demo": "users\/create-scrypt-user.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"password": {
"type": "string",
"description": "User password hashed using Scrypt.",
"x-example": "password",
"format": "password"
},
"passwordSalt": {
"type": "string",
"description": "Optional salt used to hash password.",
"x-example": "<PASSWORD_SALT>"
},
"passwordCpu": {
"type": "integer",
"description": "Optional CPU cost used to hash password.",
"x-example": null,
"format": "int32"
},
"passwordMemory": {
"type": "integer",
"description": "Optional memory cost used to hash password.",
"x-example": null,
"format": "int32"
},
"passwordParallel": {
"type": "integer",
"description": "Optional parallelization cost used to hash password.",
"x-example": null,
"format": "int32"
},
"passwordLength": {
"type": "integer",
"description": "Optional hash length used to hash password.",
"x-example": null,
"format": "int32"
},
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"userId",
"email",
"password",
"passwordSalt",
"passwordCpu",
"passwordMemory",
"passwordParallel",
"passwordLength"
]
}
}
}
}
}
},
"\/users\/scrypt-modified": {
"post": {
"summary": "Create user with Scrypt modified password",
"operationId": "usersCreateScryptModifiedUser",
"tags": [
"users"
],
"description": "Create a new user. Password provided must be hashed with the [Scrypt Modified](https:\/\/gist.github.com\/Meldiron\/eecf84a0225eccb5a378d45bb27462cc) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.",
"responses": {
"201": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createScryptModifiedUser",
"group": "users",
"weight": 127,
"cookies": false,
"type": "",
"demo": "users\/create-scrypt-modified-user.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"password": {
"type": "string",
"description": "User password hashed using Scrypt Modified.",
"x-example": "password",
"format": "password"
},
"passwordSalt": {
"type": "string",
"description": "Salt used to hash password.",
"x-example": "<PASSWORD_SALT>"
},
"passwordSaltSeparator": {
"type": "string",
"description": "Salt separator used to hash password.",
"x-example": "<PASSWORD_SALT_SEPARATOR>"
},
"passwordSignerKey": {
"type": "string",
"description": "Signer key used to hash password.",
"x-example": "<PASSWORD_SIGNER_KEY>"
},
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"userId",
"email",
"password",
"passwordSalt",
"passwordSaltSeparator",
"passwordSignerKey"
]
}
}
}
}
}
},
"\/users\/sha": {
"post": {
"summary": "Create user with SHA password",
"operationId": "usersCreateSHAUser",
"tags": [
"users"
],
"description": "Create a new user. Password provided must be hashed with the [SHA](https:\/\/en.wikipedia.org\/wiki\/Secure_Hash_Algorithm) algorithm. Use the [POST \/users](https:\/\/appwrite.io\/docs\/server\/users#usersCreate) endpoint to create users with a plain text password.",
"responses": {
"201": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createSHAUser",
"group": "users",
"weight": 124,
"cookies": false,
"type": "",
"demo": "users\/create-sha-user.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"userId": {
"type": "string",
"description": "User 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.",
"x-example": "<USER_ID>"
},
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
},
"password": {
"type": "string",
"description": "User password hashed using SHA.",
"x-example": "password",
"format": "password"
},
"passwordVersion": {
"type": "string",
"description": "Optional SHA version used to hash password. Allowed values are: 'sha1', 'sha224', 'sha256', 'sha384', 'sha512\/224', 'sha512\/256', 'sha512', 'sha3-224', 'sha3-256', 'sha3-384', 'sha3-512'",
"x-example": "sha1",
"enum": [
"sha1",
"sha224",
"sha256",
"sha384",
"sha512\/224",
"sha512\/256",
"sha512",
"sha3-224",
"sha3-256",
"sha3-384",
"sha3-512"
],
"x-enum-name": "PasswordHash",
"x-enum-keys": []
},
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"userId",
"email",
"password"
]
}
}
}
}
}
},
"\/users\/usage": {
"get": {
"summary": "Get users usage stats",
"operationId": "usersGetUsage",
"tags": [
"users"
],
"description": "Get usage metrics and statistics for all users in the project. You can view the total number of users and sessions. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.\n",
"responses": {
"200": {
"description": "UsageUsers",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/usageUsers"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
"weight": 162,
"cookies": false,
"type": "",
"demo": "users\/get-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-usage.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "range",
"description": "Date range.",
"required": false,
"schema": {
"type": "string",
"x-example": "24h",
"enum": [
"24h",
"30d",
"90d"
],
"x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
"Ninety Days"
],
"default": "30d"
},
"in": "query"
}
]
}
},
"\/users\/{userId}": {
"get": {
"summary": "Get user",
"operationId": "usersGet",
"tags": [
"users"
],
"description": "Get a user by its unique ID.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "get",
"group": "users",
"weight": 130,
"cookies": false,
"type": "",
"demo": "users\/get.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete user",
"operationId": "usersDelete",
"tags": [
"users"
],
"description": "Delete a user by its unique ID, thereby releasing it's ID. Since ID is released and can be reused, all user-related resources like documents or storage files should be deleted before user deletion. If you want to keep ID reserved, use the [updateStatus](https:\/\/appwrite.io\/docs\/server\/users#usersUpdateStatus) endpoint instead.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "users",
"weight": 158,
"cookies": false,
"type": "",
"demo": "users\/delete.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
]
}
},
"\/users\/{userId}\/email": {
"patch": {
"summary": "Update email",
"operationId": "usersUpdateEmail",
"tags": [
"users"
],
"description": "Update the user email by its unique ID.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateEmail",
"group": "users",
"weight": 143,
"cookies": false,
"type": "",
"demo": "users\/update-email.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"email": {
"type": "string",
"description": "User email.",
"x-example": "email@example.com",
"format": "email"
}
},
"required": [
"email"
]
}
}
}
}
}
},
"\/users\/{userId}\/jwts": {
"post": {
"summary": "Create user JWT",
"operationId": "usersCreateJWT",
"tags": [
"users"
],
"description": "Use this endpoint to create a JSON Web Token for user by its unique ID. You can use the resulting JWT to authenticate on behalf of the user. The JWT secret will become invalid if the session it uses gets deleted.",
"responses": {
"201": {
"description": "JWT",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/jwt"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createJWT",
"group": "sessions",
"weight": 161,
"cookies": false,
"type": "",
"demo": "users\/create-jwt.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"sessionId": {
"type": "string",
"description": "Session ID. Use the string 'recent' to use the most recent session. Defaults to the most recent session.",
"x-example": "<SESSION_ID>"
},
"duration": {
"type": "integer",
"description": "Time in seconds before JWT expires. Default duration is 900 seconds, and maximum is 3600 seconds.",
"x-example": 0,
"format": "int32"
}
}
}
}
}
}
}
},
"\/users\/{userId}\/labels": {
"put": {
"summary": "Update user labels",
"operationId": "usersUpdateLabels",
"tags": [
"users"
],
"description": "Update the user labels by its unique ID. \n\nLabels can be used to grant access to resources. While teams are a way for user's to share access to a resource, labels can be defined by the developer to grant access without an invitation. See the [Permissions docs](https:\/\/appwrite.io\/docs\/permissions) for more info.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateLabels",
"group": "users",
"weight": 139,
"cookies": false,
"type": "",
"demo": "users\/update-labels.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"labels": {
"type": "array",
"description": "Array of user labels. Replaces the previous labels. Maximum of 1000 labels are allowed, each up to 36 alphanumeric characters long.",
"x-example": null,
"items": {
"type": "string"
}
}
},
"required": [
"labels"
]
}
}
}
}
}
},
"\/users\/{userId}\/logs": {
"get": {
"summary": "List user logs",
"operationId": "usersListLogs",
"tags": [
"users"
],
"description": "Get the user activity logs list by its unique ID.",
"responses": {
"200": {
"description": "Logs List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/logList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
"weight": 135,
"cookies": false,
"type": "",
"demo": "users\/list-logs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/users\/{userId}\/memberships": {
"get": {
"summary": "List user memberships",
"operationId": "usersListMemberships",
"tags": [
"users"
],
"description": "Get the user membership list by its unique ID.",
"responses": {
"200": {
"description": "Memberships List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/membershipList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listMemberships",
"group": "memberships",
"weight": 134,
"cookies": false,
"type": "",
"demo": "users\/list-memberships.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
},
{
"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: userId, teamId, invited, joined, confirm, roles",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/users\/{userId}\/mfa": {
"patch": {
"summary": "Update MFA",
"operationId": "usersUpdateMfa",
"tags": [
"users"
],
"description": "Enable or disable MFA on a user account.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateMfa",
"group": "users",
"weight": 148,
"cookies": false,
"type": "",
"demo": "users\/update-mfa.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.updateMFA"
},
"methods": [
{
"name": "updateMfa",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId",
"mfa"
],
"required": [
"userId",
"mfa"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/user"
}
],
"description": "Enable or disable MFA on a user account.",
"demo": "users\/update-mfa.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.updateMFA"
}
},
{
"name": "updateMFA",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId",
"mfa"
],
"required": [
"userId",
"mfa"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/user"
}
],
"description": "Enable or disable MFA on a user account.",
"demo": "users\/update-mfa.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"mfa": {
"type": "boolean",
"description": "Enable or disable MFA.",
"x-example": false
}
},
"required": [
"mfa"
]
}
}
}
}
}
},
"\/users\/{userId}\/mfa\/authenticators\/{type}": {
"delete": {
"summary": "Delete authenticator",
"operationId": "usersDeleteMfaAuthenticator",
"tags": [
"users"
],
"description": "Delete an authenticator app.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": true,
"x-appwrite": {
"method": "deleteMfaAuthenticator",
"group": "mfa",
"weight": 153,
"cookies": false,
"type": "",
"demo": "users\/delete-mfa-authenticator.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.deleteMFAAuthenticator"
},
"methods": [
{
"name": "deleteMfaAuthenticator",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId",
"type"
],
"required": [
"userId",
"type"
],
"responses": [
{
"code": 204
}
],
"description": "Delete an authenticator app.",
"demo": "users\/delete-mfa-authenticator.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.deleteMFAAuthenticator"
}
},
{
"name": "deleteMFAAuthenticator",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId",
"type"
],
"required": [
"userId",
"type"
],
"responses": [
{
"code": 204
}
],
"description": "Delete an authenticator app.",
"demo": "users\/delete-mfa-authenticator.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
},
{
"name": "type",
"description": "Type of authenticator.",
"required": true,
"schema": {
"type": "string",
"x-example": "totp",
"enum": [
"totp"
],
"x-enum-name": "AuthenticatorType",
"x-enum-keys": []
},
"in": "path"
}
]
}
},
"\/users\/{userId}\/mfa\/factors": {
"get": {
"summary": "List factors",
"operationId": "usersListMfaFactors",
"tags": [
"users"
],
"description": "List the factors available on the account to be used as a MFA challange.",
"responses": {
"200": {
"description": "MFAFactors",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/mfaFactors"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "listMfaFactors",
"group": "mfa",
"weight": 149,
"cookies": false,
"type": "",
"demo": "users\/list-mfa-factors.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.listMFAFactors"
},
"methods": [
{
"name": "listMfaFactors",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId"
],
"required": [
"userId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaFactors"
}
],
"description": "List the factors available on the account to be used as a MFA challange.",
"demo": "users\/list-mfa-factors.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.listMFAFactors"
}
},
{
"name": "listMFAFactors",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId"
],
"required": [
"userId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaFactors"
}
],
"description": "List the factors available on the account to be used as a MFA challange.",
"demo": "users\/list-mfa-factors.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
]
}
},
"\/users\/{userId}\/mfa\/recovery-codes": {
"get": {
"summary": "Get MFA recovery codes",
"operationId": "usersGetMfaRecoveryCodes",
"tags": [
"users"
],
"description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.",
"responses": {
"200": {
"description": "MFA Recovery Codes",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/mfaRecoveryCodes"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "getMfaRecoveryCodes",
"group": "mfa",
"weight": 150,
"cookies": false,
"type": "",
"demo": "users\/get-mfa-recovery-codes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.getMFARecoveryCodes"
},
"methods": [
{
"name": "getMfaRecoveryCodes",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId"
],
"required": [
"userId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.",
"demo": "users\/get-mfa-recovery-codes.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.getMFARecoveryCodes"
}
},
{
"name": "getMFARecoveryCodes",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId"
],
"required": [
"userId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.",
"demo": "users\/get-mfa-recovery-codes.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
]
},
"put": {
"summary": "Update MFA recovery codes (regenerate)",
"operationId": "usersUpdateMfaRecoveryCodes",
"tags": [
"users"
],
"description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.",
"responses": {
"200": {
"description": "MFA Recovery Codes",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/mfaRecoveryCodes"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "updateMfaRecoveryCodes",
"group": "mfa",
"weight": 152,
"cookies": false,
"type": "",
"demo": "users\/update-mfa-recovery-codes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.updateMFARecoveryCodes"
},
"methods": [
{
"name": "updateMfaRecoveryCodes",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId"
],
"required": [
"userId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.",
"demo": "users\/update-mfa-recovery-codes.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.updateMFARecoveryCodes"
}
},
{
"name": "updateMFARecoveryCodes",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId"
],
"required": [
"userId"
],
"responses": [
{
"code": 200,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.",
"demo": "users\/update-mfa-recovery-codes.md",
"public": false
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Create MFA recovery codes",
"operationId": "usersCreateMfaRecoveryCodes",
"tags": [
"users"
],
"description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.",
"responses": {
"201": {
"description": "MFA Recovery Codes",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/mfaRecoveryCodes"
}
}
}
}
},
"deprecated": true,
"x-appwrite": {
"method": "createMfaRecoveryCodes",
"group": "mfa",
"weight": 151,
"cookies": false,
"type": "",
"demo": "users\/create-mfa-recovery-codes.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": false,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md",
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.createMFARecoveryCodes"
},
"methods": [
{
"name": "createMfaRecoveryCodes",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId"
],
"required": [
"userId"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.",
"demo": "users\/create-mfa-recovery-codes.md",
"public": false,
"deprecated": {
"since": "1.8.0",
"replaceWith": "users.createMFARecoveryCodes"
}
},
{
"name": "createMFARecoveryCodes",
"namespace": "users",
"desc": "",
"auth": {
"Project": []
},
"parameters": [
"userId"
],
"required": [
"userId"
],
"responses": [
{
"code": 201,
"model": "#\/components\/schemas\/mfaRecoveryCodes"
}
],
"description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.",
"demo": "users\/create-mfa-recovery-codes.md",
"public": true
}
],
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
]
}
},
"\/users\/{userId}\/name": {
"patch": {
"summary": "Update name",
"operationId": "usersUpdateName",
"tags": [
"users"
],
"description": "Update the user name by its unique ID.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateName",
"group": "users",
"weight": 141,
"cookies": false,
"type": "",
"demo": "users\/update-name.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "User name. Max length: 128 chars.",
"x-example": "<NAME>"
}
},
"required": [
"name"
]
}
}
}
}
}
},
"\/users\/{userId}\/password": {
"patch": {
"summary": "Update password",
"operationId": "usersUpdatePassword",
"tags": [
"users"
],
"description": "Update the user password by its unique ID.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePassword",
"group": "users",
"weight": 142,
"cookies": false,
"type": "",
"demo": "users\/update-password.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"password": {
"type": "string",
"description": "New user password. Must be at least 8 chars.",
"x-example": null
}
},
"required": [
"password"
]
}
}
}
}
}
},
"\/users\/{userId}\/phone": {
"patch": {
"summary": "Update phone",
"operationId": "usersUpdatePhone",
"tags": [
"users"
],
"description": "Update the user phone by its unique ID.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePhone",
"group": "users",
"weight": 144,
"cookies": false,
"type": "",
"demo": "users\/update-phone.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "User phone number.",
"x-example": "+12065550100",
"format": "phone"
}
},
"required": [
"number"
]
}
}
}
}
}
},
"\/users\/{userId}\/prefs": {
"get": {
"summary": "Get user preferences",
"operationId": "usersGetPrefs",
"tags": [
"users"
],
"description": "Get the user preferences by its unique ID.",
"responses": {
"200": {
"description": "Preferences",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/preferences"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getPrefs",
"group": "users",
"weight": 131,
"cookies": false,
"type": "",
"demo": "users\/get-prefs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Update user preferences",
"operationId": "usersUpdatePrefs",
"tags": [
"users"
],
"description": "Update the user preferences by its unique ID. The object you pass is stored as is, and replaces any previous value. The maximum allowed prefs size is 64kB and throws error if exceeded.",
"responses": {
"200": {
"description": "Preferences",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/preferences"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePrefs",
"group": "users",
"weight": 146,
"cookies": false,
"type": "",
"demo": "users\/update-prefs.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"prefs": {
"type": "object",
"description": "Prefs key-value JSON object.",
"x-example": "{}"
}
},
"required": [
"prefs"
]
}
}
}
}
}
},
"\/users\/{userId}\/sessions": {
"get": {
"summary": "List user sessions",
"operationId": "usersListSessions",
"tags": [
"users"
],
"description": "Get the user sessions list by its unique ID.",
"responses": {
"200": {
"description": "Sessions List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/sessionList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listSessions",
"group": "sessions",
"weight": 133,
"cookies": false,
"type": "",
"demo": "users\/list-sessions.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.read",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
},
{
"name": "total",
"description": "When set to false, the total count returned will be 0 and will not be calculated.",
"required": false,
"schema": {
"type": "boolean",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create session",
"operationId": "usersCreateSession",
"tags": [
"users"
],
"description": "Creates a session for a user. Returns an immediately usable session object.\n\nIf you want to generate a token for a custom authentication flow, use the [POST \/users\/{userId}\/tokens](https:\/\/appwrite.io\/docs\/server\/users#createToken) endpoint.",
"responses": {
"201": {
"description": "Session",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/session"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createSession",
"group": "sessions",
"weight": 154,
"cookies": false,
"type": "",
"demo": "users\/create-session.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User 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.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete user sessions",
"operationId": "usersDeleteSessions",
"tags": [
"users"
],
"description": "Delete all user's sessions by using the user's unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteSessions",
"group": "sessions",
"weight": 157,
"cookies": false,
"type": "",
"demo": "users\/delete-sessions.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
]
}
},
"\/users\/{userId}\/sessions\/{sessionId}": {
"delete": {
"summary": "Delete user session",
"operationId": "usersDeleteSession",
"tags": [
"users"
],
"description": "Delete a user sessions by its unique ID.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteSession",
"group": "sessions",
"weight": 156,
"cookies": false,
"type": "",
"demo": "users\/delete-session.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
},
{
"name": "sessionId",
"description": "Session ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<SESSION_ID>"
},
"in": "path"
}
]
}
},
"\/users\/{userId}\/status": {
"patch": {
"summary": "Update user status",
"operationId": "usersUpdateStatus",
"tags": [
"users"
],
"description": "Update the user status by its unique ID. Use this endpoint as an alternative to deleting a user if you want to keep user's ID reserved.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateStatus",
"group": "users",
"weight": 138,
"cookies": false,
"type": "",
"demo": "users\/update-status.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"status": {
"type": "boolean",
"description": "User Status. To activate the user pass `true` and to block the user pass `false`.",
"x-example": false
}
},
"required": [
"status"
]
}
}
}
}
}
},
"\/users\/{userId}\/targets": {
"get": {
"summary": "List user targets",
"operationId": "usersListTargets",
"tags": [
"users"
],
"description": "List the messaging targets that are associated with a user.",
"responses": {
"200": {
"description": "Target list",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/targetList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listTargets",
"group": "targets",
"weight": 136,
"cookies": false,
"type": "",
"demo": "users\/list-targets.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "targets.read",
"platforms": [
"server",
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
},
{
"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: userId, providerId, identifier, providerType",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"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",
"x-example": false,
"default": true
},
"in": "query"
}
]
},
"post": {
"summary": "Create user target",
"operationId": "usersCreateTarget",
"tags": [
"users"
],
"description": "Create a messaging target.",
"responses": {
"201": {
"description": "Target",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/target"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createTarget",
"group": "targets",
"weight": 128,
"cookies": false,
"type": "",
"demo": "users\/create-target.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "targets.write",
"platforms": [
"server",
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"targetId": {
"type": "string",
"description": "Target 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.",
"x-example": "<TARGET_ID>"
},
"providerType": {
"type": "string",
"description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.",
"x-example": "email",
"enum": [
"email",
"sms",
"push"
],
"x-enum-name": "MessagingProviderType",
"x-enum-keys": []
},
"identifier": {
"type": "string",
"description": "The target identifier (token, email, phone etc.)",
"x-example": "<IDENTIFIER>"
},
"providerId": {
"type": "string",
"description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.",
"x-example": "<NAME>"
}
},
"required": [
"targetId",
"providerType",
"identifier"
]
}
}
}
}
}
},
"\/users\/{userId}\/targets\/{targetId}": {
"get": {
"summary": "Get user target",
"operationId": "usersGetTarget",
"tags": [
"users"
],
"description": "Get a user's push notification target by ID.",
"responses": {
"200": {
"description": "Target",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/target"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getTarget",
"group": "targets",
"weight": 132,
"cookies": false,
"type": "",
"demo": "users\/get-target.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "targets.read",
"platforms": [
"server",
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
},
{
"name": "targetId",
"description": "Target ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TARGET_ID>"
},
"in": "path"
}
]
},
"patch": {
"summary": "Update user target",
"operationId": "usersUpdateTarget",
"tags": [
"users"
],
"description": "Update a messaging target.",
"responses": {
"200": {
"description": "Target",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/target"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateTarget",
"group": "targets",
"weight": 147,
"cookies": false,
"type": "",
"demo": "users\/update-target.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "targets.write",
"platforms": [
"server",
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
},
{
"name": "targetId",
"description": "Target ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TARGET_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The target identifier (token, email, phone etc.)",
"x-example": "<IDENTIFIER>"
},
"providerId": {
"type": "string",
"description": "Provider ID. Message will be sent to this target from the specified provider ID. If no provider ID is set the first setup provider will be used.",
"x-example": "<PROVIDER_ID>"
},
"name": {
"type": "string",
"description": "Target name. Max length: 128 chars. For example: My Awesome App Galaxy S23.",
"x-example": "<NAME>"
}
}
}
}
}
}
},
"delete": {
"summary": "Delete user target",
"operationId": "usersDeleteTarget",
"tags": [
"users"
],
"description": "Delete a messaging target.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteTarget",
"group": "targets",
"weight": 159,
"cookies": false,
"type": "",
"demo": "users\/delete-target.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "targets.write",
"platforms": [
"server",
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
},
{
"name": "targetId",
"description": "Target ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<TARGET_ID>"
},
"in": "path"
}
]
}
},
"\/users\/{userId}\/tokens": {
"post": {
"summary": "Create token",
"operationId": "usersCreateToken",
"tags": [
"users"
],
"description": "Returns a token with a secret key for creating a session. Use the user ID and secret and submit a request to the [PUT \/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process.\n",
"responses": {
"201": {
"description": "Token",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/token"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createToken",
"group": "sessions",
"weight": 155,
"cookies": false,
"type": "",
"demo": "users\/create-token.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"length": {
"type": "integer",
"description": "Token length in characters. The default length is 6 characters",
"x-example": 4,
"format": "int32"
},
"expire": {
"type": "integer",
"description": "Token expiration period in seconds. The default expiration is 15 minutes.",
"x-example": 60,
"format": "int32"
}
}
}
}
}
}
}
},
"\/users\/{userId}\/verification": {
"patch": {
"summary": "Update email verification",
"operationId": "usersUpdateEmailVerification",
"tags": [
"users"
],
"description": "Update the user email verification status by its unique ID.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateEmailVerification",
"group": "users",
"weight": 145,
"cookies": false,
"type": "",
"demo": "users\/update-email-verification.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"emailVerification": {
"type": "boolean",
"description": "User email verification status.",
"x-example": false
}
},
"required": [
"emailVerification"
]
}
}
}
}
}
},
"\/users\/{userId}\/verification\/phone": {
"patch": {
"summary": "Update phone verification",
"operationId": "usersUpdatePhoneVerification",
"tags": [
"users"
],
"description": "Update the user phone verification status by its unique ID.",
"responses": {
"200": {
"description": "User",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/user"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "updatePhoneVerification",
"group": "users",
"weight": 140,
"cookies": false,
"type": "",
"demo": "users\/update-phone-verification.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "users.write",
"platforms": [
"console",
"server"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": [],
"Key": []
}
],
"parameters": [
{
"name": "userId",
"description": "User ID.",
"required": true,
"schema": {
"type": "string",
"x-example": "<USER_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"phoneVerification": {
"type": "boolean",
"description": "User phone verification status.",
"x-example": false
}
},
"required": [
"phoneVerification"
]
}
}
}
}
}
},
"\/vcs\/github\/installations\/{installationId}\/detections": {
"post": {
"summary": "Create repository detection",
"operationId": "vcsCreateRepositoryDetection",
"tags": [
"vcs"
],
"description": "Analyze a GitHub repository to automatically detect the programming language and runtime environment. This endpoint scans the repository's files and language statistics to determine the appropriate runtime settings for your function. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.",
"responses": {
"200": {
"description": "DetectionFramework",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/detectionFramework"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createRepositoryDetection",
"group": "repositories",
"weight": 551,
"cookies": false,
"type": "",
"demo": "vcs\/create-repository-detection.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "vcs.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository-detection.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "installationId",
"description": "Installation Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<INSTALLATION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerRepositoryId": {
"type": "string",
"description": "Repository Id",
"x-example": "<PROVIDER_REPOSITORY_ID>"
},
"type": {
"type": "string",
"description": "Detector type. Must be one of the following: runtime, framework",
"x-example": "runtime",
"enum": [
"runtime",
"framework"
],
"x-enum-name": "VCSDetectionType",
"x-enum-keys": []
},
"providerRootDirectory": {
"type": "string",
"description": "Path to Root Directory",
"x-example": "<PROVIDER_ROOT_DIRECTORY>"
}
},
"required": [
"providerRepositoryId",
"type"
]
}
}
}
}
}
},
"\/vcs\/github\/installations\/{installationId}\/providerRepositories": {
"get": {
"summary": "List repositories",
"operationId": "vcsListRepositories",
"tags": [
"vcs"
],
"description": "Get a list of GitHub repositories available through your installation. This endpoint returns repositories with their basic information, detected runtime environments, and latest push dates. You can optionally filter repositories using a search term. Each repository's runtime is automatically detected based on its contents and language statistics. The GitHub installation must be properly configured for this endpoint to work.",
"responses": {
"200": {
"description": "Framework Provider Repositories List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/providerRepositoryFrameworkList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listRepositories",
"group": "repositories",
"weight": 548,
"cookies": false,
"type": "",
"demo": "vcs\/list-repositories.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "vcs.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repositories.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "installationId",
"description": "Installation Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<INSTALLATION_ID>"
},
"in": "path"
},
{
"name": "type",
"description": "Detector type. Must be one of the following: runtime, framework",
"required": true,
"schema": {
"type": "string",
"x-example": "runtime",
"enum": [
"runtime",
"framework"
],
"x-enum-name": "VCSDetectionType",
"x-enum-keys": []
},
"in": "query"
},
{
"name": "search",
"description": "Search term to filter your list results. Max length: 256 chars.",
"required": false,
"schema": {
"type": "string",
"x-example": "<SEARCH>",
"default": ""
},
"in": "query"
},
{
"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). Only supported methods are limit and offset",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"in": "query"
}
]
},
"post": {
"summary": "Create repository",
"operationId": "vcsCreateRepository",
"tags": [
"vcs"
],
"description": "Create a new GitHub repository through your installation. This endpoint allows you to create either a public or private repository by specifying a name and visibility setting. The repository will be created under your GitHub user account or organization, depending on your installation type. The GitHub installation must be properly configured and have the necessary permissions for repository creation.",
"responses": {
"200": {
"description": "ProviderRepository",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/providerRepository"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "createRepository",
"group": "repositories",
"weight": 546,
"cookies": false,
"type": "",
"demo": "vcs\/create-repository.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "vcs.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "installationId",
"description": "Installation Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<INSTALLATION_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Repository name (slug)",
"x-example": "<NAME>"
},
"private": {
"type": "boolean",
"description": "Mark repository public or private",
"x-example": false
}
},
"required": [
"name",
"private"
]
}
}
}
}
}
},
"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}": {
"get": {
"summary": "Get repository",
"operationId": "vcsGetRepository",
"tags": [
"vcs"
],
"description": "Get detailed information about a specific GitHub repository from your installation. This endpoint returns repository details including its ID, name, visibility status, organization, and latest push date. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.",
"responses": {
"200": {
"description": "ProviderRepository",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/providerRepository"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getRepository",
"group": "repositories",
"weight": 547,
"cookies": false,
"type": "",
"demo": "vcs\/get-repository.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "vcs.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "installationId",
"description": "Installation Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<INSTALLATION_ID>"
},
"in": "path"
},
{
"name": "providerRepositoryId",
"description": "Repository Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_REPOSITORY_ID>"
},
"in": "path"
}
]
}
},
"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/branches": {
"get": {
"summary": "List repository branches",
"operationId": "vcsListRepositoryBranches",
"tags": [
"vcs"
],
"description": "Get a list of all branches from a GitHub repository in your installation. This endpoint returns the names of all branches in the repository and their total count. The GitHub installation must be properly configured and have access to the requested repository for this endpoint to work.\n",
"responses": {
"200": {
"description": "Branches List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/branchList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listRepositoryBranches",
"group": "repositories",
"weight": 549,
"cookies": false,
"type": "",
"demo": "vcs\/list-repository-branches.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "vcs.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repository-branches.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "installationId",
"description": "Installation Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<INSTALLATION_ID>"
},
"in": "path"
},
{
"name": "providerRepositoryId",
"description": "Repository Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_REPOSITORY_ID>"
},
"in": "path"
}
]
}
},
"\/vcs\/github\/installations\/{installationId}\/providerRepositories\/{providerRepositoryId}\/contents": {
"get": {
"summary": "Get files and directories of a VCS repository",
"operationId": "vcsGetRepositoryContents",
"tags": [
"vcs"
],
"description": "Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.",
"responses": {
"200": {
"description": "VCS Content List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/vcsContentList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getRepositoryContents",
"group": "repositories",
"weight": 550,
"cookies": false,
"type": "",
"demo": "vcs\/get-repository-contents.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "vcs.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository-contents.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "installationId",
"description": "Installation Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<INSTALLATION_ID>"
},
"in": "path"
},
{
"name": "providerRepositoryId",
"description": "Repository Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<PROVIDER_REPOSITORY_ID>"
},
"in": "path"
},
{
"name": "providerRootDirectory",
"description": "Path to get contents of nested directory",
"required": false,
"schema": {
"type": "string",
"x-example": "<PROVIDER_ROOT_DIRECTORY>",
"default": ""
},
"in": "query"
},
{
"name": "providerReference",
"description": "Git reference (branch, tag, commit) to get contents from",
"required": false,
"schema": {
"type": "string",
"x-example": "<PROVIDER_REFERENCE>",
"default": ""
},
"in": "query"
}
]
}
},
"\/vcs\/github\/installations\/{installationId}\/repositories\/{repositoryId}": {
"patch": {
"summary": "Update external deployment (authorize)",
"operationId": "vcsUpdateExternalDeployments",
"tags": [
"vcs"
],
"description": "Authorize and create deployments for a GitHub pull request in your project. This endpoint allows external contributions by creating deployments from pull requests, enabling preview environments for code review. The pull request must be open and not previously authorized. The GitHub installation must be properly configured and have access to both the repository and pull request for this endpoint to work.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "updateExternalDeployments",
"group": "repositories",
"weight": 164,
"cookies": false,
"type": "",
"demo": "vcs\/update-external-deployments.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "vcs.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/update-external-deployments.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "installationId",
"description": "Installation Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<INSTALLATION_ID>"
},
"in": "path"
},
{
"name": "repositoryId",
"description": "VCS Repository Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<REPOSITORY_ID>"
},
"in": "path"
}
],
"requestBody": {
"content": {
"application\/json": {
"schema": {
"type": "object",
"properties": {
"providerPullRequestId": {
"type": "string",
"description": "GitHub Pull Request Id",
"x-example": "<PROVIDER_PULL_REQUEST_ID>"
}
},
"required": [
"providerPullRequestId"
]
}
}
}
}
}
},
"\/vcs\/installations": {
"get": {
"summary": "List installations",
"operationId": "vcsListInstallations",
"tags": [
"vcs"
],
"description": "List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.\n",
"responses": {
"200": {
"description": "Installations List",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/installationList"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "listInstallations",
"group": "installations",
"weight": 544,
"cookies": false,
"type": "",
"demo": "vcs\/list-installations.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "vcs.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"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: provider, organization",
"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",
"x-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",
"x-example": false,
"default": true
},
"in": "query"
}
]
}
},
"\/vcs\/installations\/{installationId}": {
"get": {
"summary": "Get installation",
"operationId": "vcsGetInstallation",
"tags": [
"vcs"
],
"description": "Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration. ",
"responses": {
"200": {
"description": "Installation",
"content": {
"application\/json": {
"schema": {
"$ref": "#\/components\/schemas\/installation"
}
}
}
}
},
"deprecated": false,
"x-appwrite": {
"method": "getInstallation",
"group": "installations",
"weight": 543,
"cookies": false,
"type": "",
"demo": "vcs\/get-installation.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "vcs.read",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "installationId",
"description": "Installation Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<INSTALLATION_ID>"
},
"in": "path"
}
]
},
"delete": {
"summary": "Delete installation",
"operationId": "vcsDeleteInstallation",
"tags": [
"vcs"
],
"description": "Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.",
"responses": {
"204": {
"description": "No content"
}
},
"deprecated": false,
"x-appwrite": {
"method": "deleteInstallation",
"group": "installations",
"weight": 545,
"cookies": false,
"type": "",
"demo": "vcs\/delete-installation.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
"scope": "vcs.write",
"platforms": [
"console"
],
"packaging": false,
"public": true,
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md",
"auth": {
"Project": []
}
},
"security": [
{
"Project": []
}
],
"parameters": [
{
"name": "installationId",
"description": "Installation Id",
"required": true,
"schema": {
"type": "string",
"x-example": "<INSTALLATION_ID>"
},
"in": "path"
}
]
}
}
},
"tags": [
{
"name": "account",
"description": "The Account service allows you to authenticate and manage a user account."
},
{
"name": "avatars",
"description": "The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars."
},
{
"name": "databases",
"description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents"
},
{
"name": "tablesdb",
"description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows"
},
{
"name": "locale",
"description": "The Locale service allows you to customize your app based on your users' location."
},
{
"name": "health",
"description": "The Health service allows you to both validate and monitor your Appwrite server's health."
},
{
"name": "projects",
"description": "The Project service allows you to manage all the projects in your Appwrite server."
},
{
"name": "project",
"description": "The Project service allows you to manage all the projects in your Appwrite server."
},
{
"name": "storage",
"description": "The Storage service allows you to manage your project files."
},
{
"name": "teams",
"description": "The Teams service allows you to group users of your project and to enable them to share read and write access to your project resources"
},
{
"name": "users",
"description": "The Users service allows you to manage your project users."
},
{
"name": "sites",
"description": "The Sites Service allows you view, create and manage your web applications."
},
{
"name": "functions",
"description": "The Functions Service allows you view, create and manage your Cloud Functions."
},
{
"name": "proxy",
"description": "The Proxy Service allows you to configure actions for your domains beyond DNS configuration."
},
{
"name": "graphql",
"description": "The GraphQL API allows you to query and mutate your Appwrite server using GraphQL."
},
{
"name": "console",
"description": "The Console service allows you to interact with console relevant information."
},
{
"name": "migrations",
"description": "The Migrations service allows you to migrate third-party data to your Appwrite project."
},
{
"name": "messaging",
"description": "The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.)."
}
],
"components": {
"schemas": {
"any": {
"description": "Any",
"type": "object",
"additionalProperties": true,
"example": []
},
"error": {
"description": "Error",
"type": "object",
"properties": {
"message": {
"type": "string",
"description": "Error message.",
"x-example": "Not found"
},
"code": {
"type": "string",
"description": "Error code.",
"x-example": "404"
},
"type": {
"type": "string",
"description": "Error type. You can learn more about all the error types at https:\/\/appwrite.io\/docs\/error-codes#errorTypes",
"x-example": "not_found"
},
"version": {
"type": "string",
"description": "Server version number.",
"x-example": "1.0"
}
},
"required": [
"message",
"code",
"type",
"version"
],
"example": {
"message": "Not found",
"code": "404",
"type": "not_found",
"version": "1.0"
}
},
"rowList": {
"description": "Rows List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of rows that matched your query.",
"x-example": 5,
"format": "int32"
},
"rows": {
"type": "array",
"description": "List of rows.",
"items": {
"$ref": "#\/components\/schemas\/row"
},
"x-example": ""
}
},
"required": [
"total",
"rows"
],
"example": {
"total": 5,
"rows": ""
}
},
"documentList": {
"description": "Documents List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of documents that matched your query.",
"x-example": 5,
"format": "int32"
},
"documents": {
"type": "array",
"description": "List of documents.",
"items": {
"$ref": "#\/components\/schemas\/document"
},
"x-example": ""
}
},
"required": [
"total",
"documents"
],
"example": {
"total": 5,
"documents": ""
}
},
"tableList": {
"description": "Tables List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of tables that matched your query.",
"x-example": 5,
"format": "int32"
},
"tables": {
"type": "array",
"description": "List of tables.",
"items": {
"$ref": "#\/components\/schemas\/table"
},
"x-example": ""
}
},
"required": [
"total",
"tables"
],
"example": {
"total": 5,
"tables": ""
}
},
"collectionList": {
"description": "Collections List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of collections that matched your query.",
"x-example": 5,
"format": "int32"
},
"collections": {
"type": "array",
"description": "List of collections.",
"items": {
"$ref": "#\/components\/schemas\/collection"
},
"x-example": ""
}
},
"required": [
"total",
"collections"
],
"example": {
"total": 5,
"collections": ""
}
},
"databaseList": {
"description": "Databases List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of databases that matched your query.",
"x-example": 5,
"format": "int32"
},
"databases": {
"type": "array",
"description": "List of databases.",
"items": {
"$ref": "#\/components\/schemas\/database"
},
"x-example": ""
}
},
"required": [
"total",
"databases"
],
"example": {
"total": 5,
"databases": ""
}
},
"indexList": {
"description": "Indexes List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of indexes that matched your query.",
"x-example": 5,
"format": "int32"
},
"indexes": {
"type": "array",
"description": "List of indexes.",
"items": {
"$ref": "#\/components\/schemas\/index"
},
"x-example": ""
}
},
"required": [
"total",
"indexes"
],
"example": {
"total": 5,
"indexes": ""
}
},
"columnIndexList": {
"description": "Column Indexes List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of indexes that matched your query.",
"x-example": 5,
"format": "int32"
},
"indexes": {
"type": "array",
"description": "List of indexes.",
"items": {
"$ref": "#\/components\/schemas\/columnIndex"
},
"x-example": ""
}
},
"required": [
"total",
"indexes"
],
"example": {
"total": 5,
"indexes": ""
}
},
"userList": {
"description": "Users List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of users that matched your query.",
"x-example": 5,
"format": "int32"
},
"users": {
"type": "array",
"description": "List of users.",
"items": {
"$ref": "#\/components\/schemas\/user"
},
"x-example": ""
}
},
"required": [
"total",
"users"
],
"example": {
"total": 5,
"users": ""
}
},
"sessionList": {
"description": "Sessions List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of sessions that matched your query.",
"x-example": 5,
"format": "int32"
},
"sessions": {
"type": "array",
"description": "List of sessions.",
"items": {
"$ref": "#\/components\/schemas\/session"
},
"x-example": ""
}
},
"required": [
"total",
"sessions"
],
"example": {
"total": 5,
"sessions": ""
}
},
"identityList": {
"description": "Identities List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of identities that matched your query.",
"x-example": 5,
"format": "int32"
},
"identities": {
"type": "array",
"description": "List of identities.",
"items": {
"$ref": "#\/components\/schemas\/identity"
},
"x-example": ""
}
},
"required": [
"total",
"identities"
],
"example": {
"total": 5,
"identities": ""
}
},
"logList": {
"description": "Logs List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of logs that matched your query.",
"x-example": 5,
"format": "int32"
},
"logs": {
"type": "array",
"description": "List of logs.",
"items": {
"$ref": "#\/components\/schemas\/log"
},
"x-example": ""
}
},
"required": [
"total",
"logs"
],
"example": {
"total": 5,
"logs": ""
}
},
"fileList": {
"description": "Files List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of files that matched your query.",
"x-example": 5,
"format": "int32"
},
"files": {
"type": "array",
"description": "List of files.",
"items": {
"$ref": "#\/components\/schemas\/file"
},
"x-example": ""
}
},
"required": [
"total",
"files"
],
"example": {
"total": 5,
"files": ""
}
},
"bucketList": {
"description": "Buckets List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of buckets that matched your query.",
"x-example": 5,
"format": "int32"
},
"buckets": {
"type": "array",
"description": "List of buckets.",
"items": {
"$ref": "#\/components\/schemas\/bucket"
},
"x-example": ""
}
},
"required": [
"total",
"buckets"
],
"example": {
"total": 5,
"buckets": ""
}
},
"resourceTokenList": {
"description": "Resource Tokens List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of tokens that matched your query.",
"x-example": 5,
"format": "int32"
},
"tokens": {
"type": "array",
"description": "List of tokens.",
"items": {
"$ref": "#\/components\/schemas\/resourceToken"
},
"x-example": ""
}
},
"required": [
"total",
"tokens"
],
"example": {
"total": 5,
"tokens": ""
}
},
"teamList": {
"description": "Teams List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of teams that matched your query.",
"x-example": 5,
"format": "int32"
},
"teams": {
"type": "array",
"description": "List of teams.",
"items": {
"$ref": "#\/components\/schemas\/team"
},
"x-example": ""
}
},
"required": [
"total",
"teams"
],
"example": {
"total": 5,
"teams": ""
}
},
"membershipList": {
"description": "Memberships List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of memberships that matched your query.",
"x-example": 5,
"format": "int32"
},
"memberships": {
"type": "array",
"description": "List of memberships.",
"items": {
"$ref": "#\/components\/schemas\/membership"
},
"x-example": ""
}
},
"required": [
"total",
"memberships"
],
"example": {
"total": 5,
"memberships": ""
}
},
"siteList": {
"description": "Sites List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of sites that matched your query.",
"x-example": 5,
"format": "int32"
},
"sites": {
"type": "array",
"description": "List of sites.",
"items": {
"$ref": "#\/components\/schemas\/site"
},
"x-example": ""
}
},
"required": [
"total",
"sites"
],
"example": {
"total": 5,
"sites": ""
}
},
"templateSiteList": {
"description": "Site Templates List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of templates that matched your query.",
"x-example": 5,
"format": "int32"
},
"templates": {
"type": "array",
"description": "List of templates.",
"items": {
"$ref": "#\/components\/schemas\/templateSite"
},
"x-example": ""
}
},
"required": [
"total",
"templates"
],
"example": {
"total": 5,
"templates": ""
}
},
"functionList": {
"description": "Functions List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of functions that matched your query.",
"x-example": 5,
"format": "int32"
},
"functions": {
"type": "array",
"description": "List of functions.",
"items": {
"$ref": "#\/components\/schemas\/function"
},
"x-example": ""
}
},
"required": [
"total",
"functions"
],
"example": {
"total": 5,
"functions": ""
}
},
"templateFunctionList": {
"description": "Function Templates List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of templates that matched your query.",
"x-example": 5,
"format": "int32"
},
"templates": {
"type": "array",
"description": "List of templates.",
"items": {
"$ref": "#\/components\/schemas\/templateFunction"
},
"x-example": ""
}
},
"required": [
"total",
"templates"
],
"example": {
"total": 5,
"templates": ""
}
},
"installationList": {
"description": "Installations List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of installations that matched your query.",
"x-example": 5,
"format": "int32"
},
"installations": {
"type": "array",
"description": "List of installations.",
"items": {
"$ref": "#\/components\/schemas\/installation"
},
"x-example": ""
}
},
"required": [
"total",
"installations"
],
"example": {
"total": 5,
"installations": ""
}
},
"providerRepositoryFrameworkList": {
"description": "Framework Provider Repositories List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of frameworkProviderRepositories that matched your query.",
"x-example": 5,
"format": "int32"
},
"frameworkProviderRepositories": {
"type": "array",
"description": "List of frameworkProviderRepositories.",
"items": {
"$ref": "#\/components\/schemas\/providerRepositoryFramework"
},
"x-example": ""
}
},
"required": [
"total",
"frameworkProviderRepositories"
],
"example": {
"total": 5,
"frameworkProviderRepositories": ""
}
},
"providerRepositoryRuntimeList": {
"description": "Runtime Provider Repositories List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of runtimeProviderRepositories that matched your query.",
"x-example": 5,
"format": "int32"
},
"runtimeProviderRepositories": {
"type": "array",
"description": "List of runtimeProviderRepositories.",
"items": {
"$ref": "#\/components\/schemas\/providerRepositoryRuntime"
},
"x-example": ""
}
},
"required": [
"total",
"runtimeProviderRepositories"
],
"example": {
"total": 5,
"runtimeProviderRepositories": ""
}
},
"branchList": {
"description": "Branches List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of branches that matched your query.",
"x-example": 5,
"format": "int32"
},
"branches": {
"type": "array",
"description": "List of branches.",
"items": {
"$ref": "#\/components\/schemas\/branch"
},
"x-example": ""
}
},
"required": [
"total",
"branches"
],
"example": {
"total": 5,
"branches": ""
}
},
"frameworkList": {
"description": "Frameworks List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of frameworks that matched your query.",
"x-example": 5,
"format": "int32"
},
"frameworks": {
"type": "array",
"description": "List of frameworks.",
"items": {
"$ref": "#\/components\/schemas\/framework"
},
"x-example": ""
}
},
"required": [
"total",
"frameworks"
],
"example": {
"total": 5,
"frameworks": ""
}
},
"runtimeList": {
"description": "Runtimes List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of runtimes that matched your query.",
"x-example": 5,
"format": "int32"
},
"runtimes": {
"type": "array",
"description": "List of runtimes.",
"items": {
"$ref": "#\/components\/schemas\/runtime"
},
"x-example": ""
}
},
"required": [
"total",
"runtimes"
],
"example": {
"total": 5,
"runtimes": ""
}
},
"deploymentList": {
"description": "Deployments List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of deployments that matched your query.",
"x-example": 5,
"format": "int32"
},
"deployments": {
"type": "array",
"description": "List of deployments.",
"items": {
"$ref": "#\/components\/schemas\/deployment"
},
"x-example": ""
}
},
"required": [
"total",
"deployments"
],
"example": {
"total": 5,
"deployments": ""
}
},
"executionList": {
"description": "Executions List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of executions that matched your query.",
"x-example": 5,
"format": "int32"
},
"executions": {
"type": "array",
"description": "List of executions.",
"items": {
"$ref": "#\/components\/schemas\/execution"
},
"x-example": ""
}
},
"required": [
"total",
"executions"
],
"example": {
"total": 5,
"executions": ""
}
},
"projectList": {
"description": "Projects List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of projects that matched your query.",
"x-example": 5,
"format": "int32"
},
"projects": {
"type": "array",
"description": "List of projects.",
"items": {
"$ref": "#\/components\/schemas\/project"
},
"x-example": ""
}
},
"required": [
"total",
"projects"
],
"example": {
"total": 5,
"projects": ""
}
},
"webhookList": {
"description": "Webhooks List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of webhooks that matched your query.",
"x-example": 5,
"format": "int32"
},
"webhooks": {
"type": "array",
"description": "List of webhooks.",
"items": {
"$ref": "#\/components\/schemas\/webhook"
},
"x-example": ""
}
},
"required": [
"total",
"webhooks"
],
"example": {
"total": 5,
"webhooks": ""
}
},
"keyList": {
"description": "API Keys List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of keys that matched your query.",
"x-example": 5,
"format": "int32"
},
"keys": {
"type": "array",
"description": "List of keys.",
"items": {
"$ref": "#\/components\/schemas\/key"
},
"x-example": ""
}
},
"required": [
"total",
"keys"
],
"example": {
"total": 5,
"keys": ""
}
},
"devKeyList": {
"description": "Dev Keys List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of devKeys that matched your query.",
"x-example": 5,
"format": "int32"
},
"devKeys": {
"type": "array",
"description": "List of devKeys.",
"items": {
"$ref": "#\/components\/schemas\/devKey"
},
"x-example": ""
}
},
"required": [
"total",
"devKeys"
],
"example": {
"total": 5,
"devKeys": ""
}
},
"platformList": {
"description": "Platforms List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of platforms that matched your query.",
"x-example": 5,
"format": "int32"
},
"platforms": {
"type": "array",
"description": "List of platforms.",
"items": {
"$ref": "#\/components\/schemas\/platform"
},
"x-example": ""
}
},
"required": [
"total",
"platforms"
],
"example": {
"total": 5,
"platforms": ""
}
},
"countryList": {
"description": "Countries List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of countries that matched your query.",
"x-example": 5,
"format": "int32"
},
"countries": {
"type": "array",
"description": "List of countries.",
"items": {
"$ref": "#\/components\/schemas\/country"
},
"x-example": ""
}
},
"required": [
"total",
"countries"
],
"example": {
"total": 5,
"countries": ""
}
},
"continentList": {
"description": "Continents List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of continents that matched your query.",
"x-example": 5,
"format": "int32"
},
"continents": {
"type": "array",
"description": "List of continents.",
"items": {
"$ref": "#\/components\/schemas\/continent"
},
"x-example": ""
}
},
"required": [
"total",
"continents"
],
"example": {
"total": 5,
"continents": ""
}
},
"languageList": {
"description": "Languages List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of languages that matched your query.",
"x-example": 5,
"format": "int32"
},
"languages": {
"type": "array",
"description": "List of languages.",
"items": {
"$ref": "#\/components\/schemas\/language"
},
"x-example": ""
}
},
"required": [
"total",
"languages"
],
"example": {
"total": 5,
"languages": ""
}
},
"currencyList": {
"description": "Currencies List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of currencies that matched your query.",
"x-example": 5,
"format": "int32"
},
"currencies": {
"type": "array",
"description": "List of currencies.",
"items": {
"$ref": "#\/components\/schemas\/currency"
},
"x-example": ""
}
},
"required": [
"total",
"currencies"
],
"example": {
"total": 5,
"currencies": ""
}
},
"phoneList": {
"description": "Phones List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of phones that matched your query.",
"x-example": 5,
"format": "int32"
},
"phones": {
"type": "array",
"description": "List of phones.",
"items": {
"$ref": "#\/components\/schemas\/phone"
},
"x-example": ""
}
},
"required": [
"total",
"phones"
],
"example": {
"total": 5,
"phones": ""
}
},
"variableList": {
"description": "Variables List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of variables that matched your query.",
"x-example": 5,
"format": "int32"
},
"variables": {
"type": "array",
"description": "List of variables.",
"items": {
"$ref": "#\/components\/schemas\/variable"
},
"x-example": ""
}
},
"required": [
"total",
"variables"
],
"example": {
"total": 5,
"variables": ""
}
},
"healthStatusList": {
"description": "Status List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of statuses that matched your query.",
"x-example": 5,
"format": "int32"
},
"statuses": {
"type": "array",
"description": "List of statuses.",
"items": {
"$ref": "#\/components\/schemas\/healthStatus"
},
"x-example": ""
}
},
"required": [
"total",
"statuses"
],
"example": {
"total": 5,
"statuses": ""
}
},
"proxyRuleList": {
"description": "Rule List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of rules that matched your query.",
"x-example": 5,
"format": "int32"
},
"rules": {
"type": "array",
"description": "List of rules.",
"items": {
"$ref": "#\/components\/schemas\/proxyRule"
},
"x-example": ""
}
},
"required": [
"total",
"rules"
],
"example": {
"total": 5,
"rules": ""
}
},
"localeCodeList": {
"description": "Locale codes list",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of localeCodes that matched your query.",
"x-example": 5,
"format": "int32"
},
"localeCodes": {
"type": "array",
"description": "List of localeCodes.",
"items": {
"$ref": "#\/components\/schemas\/localeCode"
},
"x-example": ""
}
},
"required": [
"total",
"localeCodes"
],
"example": {
"total": 5,
"localeCodes": ""
}
},
"providerList": {
"description": "Provider list",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of providers that matched your query.",
"x-example": 5,
"format": "int32"
},
"providers": {
"type": "array",
"description": "List of providers.",
"items": {
"$ref": "#\/components\/schemas\/provider"
},
"x-example": ""
}
},
"required": [
"total",
"providers"
],
"example": {
"total": 5,
"providers": ""
}
},
"messageList": {
"description": "Message list",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of messages that matched your query.",
"x-example": 5,
"format": "int32"
},
"messages": {
"type": "array",
"description": "List of messages.",
"items": {
"$ref": "#\/components\/schemas\/message"
},
"x-example": ""
}
},
"required": [
"total",
"messages"
],
"example": {
"total": 5,
"messages": ""
}
},
"topicList": {
"description": "Topic list",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of topics that matched your query.",
"x-example": 5,
"format": "int32"
},
"topics": {
"type": "array",
"description": "List of topics.",
"items": {
"$ref": "#\/components\/schemas\/topic"
},
"x-example": ""
}
},
"required": [
"total",
"topics"
],
"example": {
"total": 5,
"topics": ""
}
},
"subscriberList": {
"description": "Subscriber list",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of subscribers that matched your query.",
"x-example": 5,
"format": "int32"
},
"subscribers": {
"type": "array",
"description": "List of subscribers.",
"items": {
"$ref": "#\/components\/schemas\/subscriber"
},
"x-example": ""
}
},
"required": [
"total",
"subscribers"
],
"example": {
"total": 5,
"subscribers": ""
}
},
"targetList": {
"description": "Target list",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of targets that matched your query.",
"x-example": 5,
"format": "int32"
},
"targets": {
"type": "array",
"description": "List of targets.",
"items": {
"$ref": "#\/components\/schemas\/target"
},
"x-example": ""
}
},
"required": [
"total",
"targets"
],
"example": {
"total": 5,
"targets": ""
}
},
"transactionList": {
"description": "Transaction List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of transactions that matched your query.",
"x-example": 5,
"format": "int32"
},
"transactions": {
"type": "array",
"description": "List of transactions.",
"items": {
"$ref": "#\/components\/schemas\/transaction"
},
"x-example": ""
}
},
"required": [
"total",
"transactions"
],
"example": {
"total": 5,
"transactions": ""
}
},
"migrationList": {
"description": "Migrations List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of migrations that matched your query.",
"x-example": 5,
"format": "int32"
},
"migrations": {
"type": "array",
"description": "List of migrations.",
"items": {
"$ref": "#\/components\/schemas\/migration"
},
"x-example": ""
}
},
"required": [
"total",
"migrations"
],
"example": {
"total": 5,
"migrations": ""
}
},
"specificationList": {
"description": "Specifications List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of specifications that matched your query.",
"x-example": 5,
"format": "int32"
},
"specifications": {
"type": "array",
"description": "List of specifications.",
"items": {
"$ref": "#\/components\/schemas\/specification"
},
"x-example": ""
}
},
"required": [
"total",
"specifications"
],
"example": {
"total": 5,
"specifications": ""
}
},
"vcsContentList": {
"description": "VCS Content List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of contents that matched your query.",
"x-example": 5,
"format": "int32"
},
"contents": {
"type": "array",
"description": "List of contents.",
"items": {
"$ref": "#\/components\/schemas\/vcsContent"
},
"x-example": ""
}
},
"required": [
"total",
"contents"
],
"example": {
"total": 5,
"contents": ""
}
},
"database": {
"description": "Database",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c16897e"
},
"name": {
"type": "string",
"description": "Database name.",
"x-example": "My Database"
},
"$createdAt": {
"type": "string",
"description": "Database creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Database update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"enabled": {
"type": "boolean",
"description": "If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.",
"x-example": false
},
"type": {
"type": "string",
"description": "Database type.",
"x-example": "legacy",
"enum": [
"legacy",
"tablesdb"
]
}
},
"required": [
"$id",
"name",
"$createdAt",
"$updatedAt",
"enabled",
"type"
],
"example": {
"$id": "5e5ea5c16897e",
"name": "My Database",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"enabled": false,
"type": "legacy"
}
},
"collection": {
"description": "Collection",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Collection creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Collection update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$permissions": {
"type": "array",
"description": "Collection permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"items": {
"type": "string"
},
"x-example": [
"read(\"any\")"
]
},
"databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c16897e"
},
"name": {
"type": "string",
"description": "Collection name.",
"x-example": "My Collection"
},
"enabled": {
"type": "boolean",
"description": "Collection enabled. Can be 'enabled' or 'disabled'. When disabled, the collection is inaccessible to users, but remains accessible to Server SDKs using API keys.",
"x-example": false
},
"documentSecurity": {
"type": "boolean",
"description": "Whether document-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": true
},
"attributes": {
"type": "array",
"description": "Collection attributes.",
"items": {
"anyOf": [
{
"$ref": "#\/components\/schemas\/attributeBoolean"
},
{
"$ref": "#\/components\/schemas\/attributeInteger"
},
{
"$ref": "#\/components\/schemas\/attributeFloat"
},
{
"$ref": "#\/components\/schemas\/attributeEmail"
},
{
"$ref": "#\/components\/schemas\/attributeEnum"
},
{
"$ref": "#\/components\/schemas\/attributeUrl"
},
{
"$ref": "#\/components\/schemas\/attributeIp"
},
{
"$ref": "#\/components\/schemas\/attributeDatetime"
},
{
"$ref": "#\/components\/schemas\/attributeRelationship"
},
{
"$ref": "#\/components\/schemas\/attributePoint"
},
{
"$ref": "#\/components\/schemas\/attributeLine"
},
{
"$ref": "#\/components\/schemas\/attributePolygon"
},
{
"$ref": "#\/components\/schemas\/attributeString"
}
]
},
"x-example": {}
},
"indexes": {
"type": "array",
"description": "Collection indexes.",
"items": {
"$ref": "#\/components\/schemas\/index"
},
"x-example": {}
},
"bytesMax": {
"type": "integer",
"description": "Maximum document size in bytes. Returns 0 when no limit applies.",
"x-example": 65535,
"format": "int32"
},
"bytesUsed": {
"type": "integer",
"description": "Currently used document size in bytes based on defined attributes.",
"x-example": 1500,
"format": "int32"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"$permissions",
"databaseId",
"name",
"enabled",
"documentSecurity",
"attributes",
"indexes",
"bytesMax",
"bytesUsed"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"$permissions": [
"read(\"any\")"
],
"databaseId": "5e5ea5c16897e",
"name": "My Collection",
"enabled": false,
"documentSecurity": true,
"attributes": {},
"indexes": {},
"bytesMax": 65535,
"bytesUsed": 1500
}
},
"attributeList": {
"description": "Attributes List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of attributes in the given collection.",
"x-example": 5,
"format": "int32"
},
"attributes": {
"type": "array",
"description": "List of attributes.",
"items": {
"anyOf": [
{
"$ref": "#\/components\/schemas\/attributeBoolean"
},
{
"$ref": "#\/components\/schemas\/attributeInteger"
},
{
"$ref": "#\/components\/schemas\/attributeFloat"
},
{
"$ref": "#\/components\/schemas\/attributeEmail"
},
{
"$ref": "#\/components\/schemas\/attributeEnum"
},
{
"$ref": "#\/components\/schemas\/attributeUrl"
},
{
"$ref": "#\/components\/schemas\/attributeIp"
},
{
"$ref": "#\/components\/schemas\/attributeDatetime"
},
{
"$ref": "#\/components\/schemas\/attributeRelationship"
},
{
"$ref": "#\/components\/schemas\/attributePoint"
},
{
"$ref": "#\/components\/schemas\/attributeLine"
},
{
"$ref": "#\/components\/schemas\/attributePolygon"
},
{
"$ref": "#\/components\/schemas\/attributeString"
}
]
},
"x-example": ""
}
},
"required": [
"total",
"attributes"
],
"example": {
"total": 5,
"attributes": ""
}
},
"attributeString": {
"description": "AttributeString",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"size": {
"type": "integer",
"description": "Attribute size.",
"x-example": 128,
"format": "int32"
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "default",
"nullable": true
},
"encrypt": {
"type": "boolean",
"description": "Defines whether this attribute is encrypted or not.",
"x-example": false,
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"size"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"size": 128,
"default": "default",
"encrypt": false
}
},
"attributeInteger": {
"description": "AttributeInteger",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "count"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "integer"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"min": {
"type": "integer",
"description": "Minimum value to enforce for new documents.",
"x-example": 1,
"format": "int64",
"nullable": true
},
"max": {
"type": "integer",
"description": "Maximum value to enforce for new documents.",
"x-example": 10,
"format": "int64",
"nullable": true
},
"default": {
"type": "integer",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": 10,
"format": "int32",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "count",
"type": "integer",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"min": 1,
"max": 10,
"default": 10
}
},
"attributeFloat": {
"description": "AttributeFloat",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "percentageCompleted"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "double"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"min": {
"type": "number",
"description": "Minimum value to enforce for new documents.",
"x-example": 1.5,
"format": "double",
"nullable": true
},
"max": {
"type": "number",
"description": "Maximum value to enforce for new documents.",
"x-example": 10.5,
"format": "double",
"nullable": true
},
"default": {
"type": "number",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": 2.5,
"format": "double",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "percentageCompleted",
"type": "double",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"min": 1.5,
"max": 10.5,
"default": 2.5
}
},
"attributeBoolean": {
"description": "AttributeBoolean",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "isEnabled"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "boolean"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "boolean",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": false,
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "isEnabled",
"type": "boolean",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": false
}
},
"attributeEmail": {
"description": "AttributeEmail",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "userEmail"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"format": {
"type": "string",
"description": "String format.",
"x-example": "email"
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "default@example.com",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"format"
],
"example": {
"key": "userEmail",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"format": "email",
"default": "default@example.com"
}
},
"attributeEnum": {
"description": "AttributeEnum",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "status"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"elements": {
"type": "array",
"description": "Array of elements in enumerated type.",
"items": {
"type": "string"
},
"x-example": "element"
},
"format": {
"type": "string",
"description": "String format.",
"x-example": "enum"
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "element",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"elements",
"format"
],
"example": {
"key": "status",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"elements": "element",
"format": "enum",
"default": "element"
}
},
"attributeIp": {
"description": "AttributeIP",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "ipAddress"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"format": {
"type": "string",
"description": "String format.",
"x-example": "ip"
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "192.0.2.0",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"format"
],
"example": {
"key": "ipAddress",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"format": "ip",
"default": "192.0.2.0"
}
},
"attributeUrl": {
"description": "AttributeURL",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "githubUrl"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"format": {
"type": "string",
"description": "String format.",
"x-example": "url"
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "http:\/\/example.com",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"format"
],
"example": {
"key": "githubUrl",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"format": "url",
"default": "http:\/\/example.com"
}
},
"attributeDatetime": {
"description": "AttributeDatetime",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "birthDay"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "datetime"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"format": {
"type": "string",
"description": "ISO 8601 format.",
"x-example": "datetime"
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Only null is optional",
"x-example": "2020-10-15T06:38:00.000+00:00",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"format"
],
"example": {
"key": "birthDay",
"type": "datetime",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"format": "datetime",
"default": "2020-10-15T06:38:00.000+00:00"
}
},
"attributeRelationship": {
"description": "AttributeRelationship",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"relatedCollection": {
"type": "string",
"description": "The ID of the related collection.",
"x-example": "collection"
},
"relationType": {
"type": "string",
"description": "The type of the relationship.",
"x-example": "oneToOne|oneToMany|manyToOne|manyToMany"
},
"twoWay": {
"type": "boolean",
"description": "Is the relationship two-way?",
"x-example": false
},
"twoWayKey": {
"type": "string",
"description": "The key of the two-way relationship.",
"x-example": "string"
},
"onDelete": {
"type": "string",
"description": "How deleting the parent document will propagate to child documents.",
"x-example": "restrict|cascade|setNull"
},
"side": {
"type": "string",
"description": "Whether this is the parent or child side of the relationship",
"x-example": "parent|child"
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"relatedCollection",
"relationType",
"twoWay",
"twoWayKey",
"onDelete",
"side"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"relatedCollection": "collection",
"relationType": "oneToOne|oneToMany|manyToOne|manyToMany",
"twoWay": false,
"twoWayKey": "string",
"onDelete": "restrict|cascade|setNull",
"side": "parent|child"
}
},
"attributePoint": {
"description": "AttributePoint",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "array",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": [
0,
0
],
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": [
0,
0
]
}
},
"attributeLine": {
"description": "AttributeLine",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "array",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": [
[
0,
0
],
[
1,
1
]
],
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": [
[
0,
0
],
[
1,
1
]
]
}
},
"attributePolygon": {
"description": "AttributePolygon",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "array",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": [
[
[
0,
0
],
[
0,
10
]
],
[
[
10,
10
],
[
0,
0
]
]
],
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": [
[
[
0,
0
],
[
0,
10
]
],
[
[
10,
10
],
[
0,
0
]
]
]
}
},
"attributeVarchar": {
"description": "AttributeVarchar",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"size": {
"type": "integer",
"description": "Attribute size.",
"x-example": 128,
"format": "int32"
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "default",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"size"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"size": 128,
"default": "default"
}
},
"attributeText": {
"description": "AttributeText",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "default",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": "default"
}
},
"attributeMediumtext": {
"description": "AttributeMediumtext",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "default",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": "default"
}
},
"attributeLongtext": {
"description": "AttributeLongtext",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Attribute Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Attribute type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is attribute required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is attribute an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Attribute creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Attribute update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "string",
"description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
"x-example": "default",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": "default"
}
},
"table": {
"description": "Table",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Table ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Table creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Table update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$permissions": {
"type": "array",
"description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"items": {
"type": "string"
},
"x-example": [
"read(\"any\")"
]
},
"databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c16897e"
},
"name": {
"type": "string",
"description": "Table name.",
"x-example": "My Table"
},
"enabled": {
"type": "boolean",
"description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.",
"x-example": false
},
"rowSecurity": {
"type": "boolean",
"description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": true
},
"columns": {
"type": "array",
"description": "Table columns.",
"items": {
"anyOf": [
{
"$ref": "#\/components\/schemas\/columnBoolean"
},
{
"$ref": "#\/components\/schemas\/columnInteger"
},
{
"$ref": "#\/components\/schemas\/columnFloat"
},
{
"$ref": "#\/components\/schemas\/columnEmail"
},
{
"$ref": "#\/components\/schemas\/columnEnum"
},
{
"$ref": "#\/components\/schemas\/columnUrl"
},
{
"$ref": "#\/components\/schemas\/columnIp"
},
{
"$ref": "#\/components\/schemas\/columnDatetime"
},
{
"$ref": "#\/components\/schemas\/columnRelationship"
},
{
"$ref": "#\/components\/schemas\/columnPoint"
},
{
"$ref": "#\/components\/schemas\/columnLine"
},
{
"$ref": "#\/components\/schemas\/columnPolygon"
},
{
"$ref": "#\/components\/schemas\/columnVarchar"
},
{
"$ref": "#\/components\/schemas\/columnText"
},
{
"$ref": "#\/components\/schemas\/columnMediumtext"
},
{
"$ref": "#\/components\/schemas\/columnLongtext"
},
{
"$ref": "#\/components\/schemas\/columnString"
}
]
},
"x-example": {}
},
"indexes": {
"type": "array",
"description": "Table indexes.",
"items": {
"$ref": "#\/components\/schemas\/columnIndex"
},
"x-example": {}
},
"bytesMax": {
"type": "integer",
"description": "Maximum row size in bytes. Returns 0 when no limit applies.",
"x-example": 65535,
"format": "int32"
},
"bytesUsed": {
"type": "integer",
"description": "Currently used row size in bytes based on defined columns.",
"x-example": 1500,
"format": "int32"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"$permissions",
"databaseId",
"name",
"enabled",
"rowSecurity",
"columns",
"indexes",
"bytesMax",
"bytesUsed"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"$permissions": [
"read(\"any\")"
],
"databaseId": "5e5ea5c16897e",
"name": "My Table",
"enabled": false,
"rowSecurity": true,
"columns": {},
"indexes": {},
"bytesMax": 65535,
"bytesUsed": 1500
}
},
"columnList": {
"description": "Columns List",
"type": "object",
"properties": {
"total": {
"type": "integer",
"description": "Total number of columns in the given table.",
"x-example": 5,
"format": "int32"
},
"columns": {
"type": "array",
"description": "List of columns.",
"items": {
"anyOf": [
{
"$ref": "#\/components\/schemas\/columnBoolean"
},
{
"$ref": "#\/components\/schemas\/columnInteger"
},
{
"$ref": "#\/components\/schemas\/columnFloat"
},
{
"$ref": "#\/components\/schemas\/columnEmail"
},
{
"$ref": "#\/components\/schemas\/columnEnum"
},
{
"$ref": "#\/components\/schemas\/columnUrl"
},
{
"$ref": "#\/components\/schemas\/columnIp"
},
{
"$ref": "#\/components\/schemas\/columnDatetime"
},
{
"$ref": "#\/components\/schemas\/columnRelationship"
},
{
"$ref": "#\/components\/schemas\/columnPoint"
},
{
"$ref": "#\/components\/schemas\/columnLine"
},
{
"$ref": "#\/components\/schemas\/columnPolygon"
},
{
"$ref": "#\/components\/schemas\/columnVarchar"
},
{
"$ref": "#\/components\/schemas\/columnText"
},
{
"$ref": "#\/components\/schemas\/columnMediumtext"
},
{
"$ref": "#\/components\/schemas\/columnLongtext"
},
{
"$ref": "#\/components\/schemas\/columnString"
}
]
},
"x-example": ""
}
},
"required": [
"total",
"columns"
],
"example": {
"total": 5,
"columns": ""
}
},
"columnString": {
"description": "ColumnString",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"size": {
"type": "integer",
"description": "Column size.",
"x-example": 128,
"format": "int32"
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "default",
"nullable": true
},
"encrypt": {
"type": "boolean",
"description": "Defines whether this column is encrypted or not.",
"x-example": false,
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"size"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"size": 128,
"default": "default",
"encrypt": false
}
},
"columnInteger": {
"description": "ColumnInteger",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "count"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "integer"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"min": {
"type": "integer",
"description": "Minimum value to enforce for new documents.",
"x-example": 1,
"format": "int64",
"nullable": true
},
"max": {
"type": "integer",
"description": "Maximum value to enforce for new documents.",
"x-example": 10,
"format": "int64",
"nullable": true
},
"default": {
"type": "integer",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": 10,
"format": "int32",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "count",
"type": "integer",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"min": 1,
"max": 10,
"default": 10
}
},
"columnFloat": {
"description": "ColumnFloat",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "percentageCompleted"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "double"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"min": {
"type": "number",
"description": "Minimum value to enforce for new documents.",
"x-example": 1.5,
"format": "double",
"nullable": true
},
"max": {
"type": "number",
"description": "Maximum value to enforce for new documents.",
"x-example": 10.5,
"format": "double",
"nullable": true
},
"default": {
"type": "number",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": 2.5,
"format": "double",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "percentageCompleted",
"type": "double",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"min": 1.5,
"max": 10.5,
"default": 2.5
}
},
"columnBoolean": {
"description": "ColumnBoolean",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "isEnabled"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "boolean"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "boolean",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": false,
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "isEnabled",
"type": "boolean",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": false
}
},
"columnEmail": {
"description": "ColumnEmail",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "userEmail"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"format": {
"type": "string",
"description": "String format.",
"x-example": "email"
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "default@example.com",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"format"
],
"example": {
"key": "userEmail",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"format": "email",
"default": "default@example.com"
}
},
"columnEnum": {
"description": "ColumnEnum",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "status"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"elements": {
"type": "array",
"description": "Array of elements in enumerated type.",
"items": {
"type": "string"
},
"x-example": "element"
},
"format": {
"type": "string",
"description": "String format.",
"x-example": "enum"
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "element",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"elements",
"format"
],
"example": {
"key": "status",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"elements": "element",
"format": "enum",
"default": "element"
}
},
"columnIp": {
"description": "ColumnIP",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "ipAddress"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"format": {
"type": "string",
"description": "String format.",
"x-example": "ip"
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "192.0.2.0",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"format"
],
"example": {
"key": "ipAddress",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"format": "ip",
"default": "192.0.2.0"
}
},
"columnUrl": {
"description": "ColumnURL",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "githubUrl"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"format": {
"type": "string",
"description": "String format.",
"x-example": "url"
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "https:\/\/example.com",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"format"
],
"example": {
"key": "githubUrl",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"format": "url",
"default": "https:\/\/example.com"
}
},
"columnDatetime": {
"description": "ColumnDatetime",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "birthDay"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "datetime"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"format": {
"type": "string",
"description": "ISO 8601 format.",
"x-example": "datetime"
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Only null is optional",
"x-example": "2020-10-15T06:38:00.000+00:00",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"format"
],
"example": {
"key": "birthDay",
"type": "datetime",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"format": "datetime",
"default": "2020-10-15T06:38:00.000+00:00"
}
},
"columnRelationship": {
"description": "ColumnRelationship",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"relatedTable": {
"type": "string",
"description": "The ID of the related table.",
"x-example": "table"
},
"relationType": {
"type": "string",
"description": "The type of the relationship.",
"x-example": "oneToOne|oneToMany|manyToOne|manyToMany"
},
"twoWay": {
"type": "boolean",
"description": "Is the relationship two-way?",
"x-example": false
},
"twoWayKey": {
"type": "string",
"description": "The key of the two-way relationship.",
"x-example": "string"
},
"onDelete": {
"type": "string",
"description": "How deleting the parent document will propagate to child documents.",
"x-example": "restrict|cascade|setNull"
},
"side": {
"type": "string",
"description": "Whether this is the parent or child side of the relationship",
"x-example": "parent|child"
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"relatedTable",
"relationType",
"twoWay",
"twoWayKey",
"onDelete",
"side"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"relatedTable": "table",
"relationType": "oneToOne|oneToMany|manyToOne|manyToMany",
"twoWay": false,
"twoWayKey": "string",
"onDelete": "restrict|cascade|setNull",
"side": "parent|child"
}
},
"columnPoint": {
"description": "ColumnPoint",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "array",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": [
0,
0
],
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": [
0,
0
]
}
},
"columnLine": {
"description": "ColumnLine",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "array",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": [
[
0,
0
],
[
1,
1
]
],
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": [
[
0,
0
],
[
1,
1
]
]
}
},
"columnPolygon": {
"description": "ColumnPolygon",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "array",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": [
[
[
0,
0
],
[
0,
10
]
],
[
[
10,
10
],
[
0,
0
]
]
],
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": [
[
[
0,
0
],
[
0,
10
]
],
[
[
10,
10
],
[
0,
0
]
]
]
}
},
"columnVarchar": {
"description": "ColumnVarchar",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"size": {
"type": "integer",
"description": "Column size.",
"x-example": 128,
"format": "int32"
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "default",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt",
"size"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"size": 128,
"default": "default"
}
},
"columnText": {
"description": "ColumnText",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "default",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": "default"
}
},
"columnMediumtext": {
"description": "ColumnMediumtext",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "default",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": "default"
}
},
"columnLongtext": {
"description": "ColumnLongtext",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Column Key.",
"x-example": "fullName"
},
"type": {
"type": "string",
"description": "Column type.",
"x-example": "string"
},
"status": {
"type": "string",
"description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
],
"x-enum-name": "ColumnStatus"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an column.",
"x-example": "string"
},
"required": {
"type": "boolean",
"description": "Is column required?",
"x-example": true
},
"array": {
"type": "boolean",
"description": "Is column an array?",
"x-example": false,
"nullable": true
},
"$createdAt": {
"type": "string",
"description": "Column creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Column update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"default": {
"type": "string",
"description": "Default value for column when not provided. Cannot be set when column is required.",
"x-example": "default",
"nullable": true
}
},
"required": [
"key",
"type",
"status",
"error",
"required",
"$createdAt",
"$updatedAt"
],
"example": {
"key": "fullName",
"type": "string",
"status": "available",
"error": "string",
"required": true,
"array": false,
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"default": "default"
}
},
"index": {
"description": "Index",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Index ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Index creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Index update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"key": {
"type": "string",
"description": "Index key.",
"x-example": "index1"
},
"type": {
"type": "string",
"description": "Index type.",
"x-example": "primary"
},
"status": {
"type": "string",
"description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available",
"enum": [
"available",
"processing",
"deleting",
"stuck",
"failed"
]
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an index.",
"x-example": "string"
},
"attributes": {
"type": "array",
"description": "Index attributes.",
"items": {
"type": "string"
},
"x-example": []
},
"lengths": {
"type": "array",
"description": "Index attributes length.",
"items": {
"type": "integer",
"format": "int32"
},
"x-example": []
},
"orders": {
"type": "array",
"description": "Index orders.",
"items": {
"type": "string"
},
"x-example": [],
"nullable": true
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"key",
"type",
"status",
"error",
"attributes",
"lengths"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"key": "index1",
"type": "primary",
"status": "available",
"error": "string",
"attributes": [],
"lengths": [],
"orders": []
}
},
"columnIndex": {
"description": "Index",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Index ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Index creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Index update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"key": {
"type": "string",
"description": "Index Key.",
"x-example": "index1"
},
"type": {
"type": "string",
"description": "Index type.",
"x-example": "primary"
},
"status": {
"type": "string",
"description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
"x-example": "available"
},
"error": {
"type": "string",
"description": "Error message. Displays error generated on failure of creating or deleting an index.",
"x-example": "string"
},
"columns": {
"type": "array",
"description": "Index columns.",
"items": {
"type": "string"
},
"x-example": []
},
"lengths": {
"type": "array",
"description": "Index columns length.",
"items": {
"type": "integer",
"format": "int32"
},
"x-example": []
},
"orders": {
"type": "array",
"description": "Index orders.",
"items": {
"type": "string"
},
"x-example": [],
"nullable": true
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"key",
"type",
"status",
"error",
"columns",
"lengths"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"key": "index1",
"type": "primary",
"status": "available",
"error": "string",
"columns": [],
"lengths": [],
"orders": []
}
},
"row": {
"description": "Row",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Row ID.",
"x-example": "5e5ea5c16897e"
},
"$sequence": {
"type": "integer",
"description": "Row automatically incrementing ID.",
"x-example": 1,
"format": "int32",
"readOnly": true
},
"$tableId": {
"type": "string",
"description": "Table ID.",
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",
"description": "Row creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Row update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$permissions": {
"type": "array",
"description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"items": {
"type": "string"
},
"x-example": [
"read(\"any\")"
]
}
},
"additionalProperties": true,
"required": [
"$id",
"$sequence",
"$tableId",
"$databaseId",
"$createdAt",
"$updatedAt",
"$permissions"
],
"example": {
"$id": "5e5ea5c16897e",
"$sequence": 1,
"$tableId": "5e5ea5c15117e",
"$databaseId": "5e5ea5c15117e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"$permissions": [
"read(\"any\")"
]
}
},
"document": {
"description": "Document",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Document ID.",
"x-example": "5e5ea5c16897e"
},
"$sequence": {
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
"format": "int32",
"readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
"x-example": "5e5ea5c15117e",
"readOnly": true
},
"$createdAt": {
"type": "string",
"description": "Document creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Document update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$permissions": {
"type": "array",
"description": "Document permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"items": {
"type": "string"
},
"x-example": [
"read(\"any\")"
]
}
},
"additionalProperties": true,
"required": [
"$id",
"$sequence",
"$collectionId",
"$databaseId",
"$createdAt",
"$updatedAt",
"$permissions"
],
"example": {
"$id": "5e5ea5c16897e",
"$sequence": 1,
"$collectionId": "5e5ea5c15117e",
"$databaseId": "5e5ea5c15117e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"$permissions": [
"read(\"any\")"
],
"username": "john.doe",
"email": "john.doe@example.com",
"fullName": "John Doe",
"age": 30,
"isAdmin": false
}
},
"log": {
"description": "Log",
"type": "object",
"properties": {
"event": {
"type": "string",
"description": "Event name.",
"x-example": "account.sessions.create"
},
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "610fc2f985ee0"
},
"userEmail": {
"type": "string",
"description": "User Email.",
"x-example": "john@appwrite.io"
},
"userName": {
"type": "string",
"description": "User Name.",
"x-example": "John Doe"
},
"mode": {
"type": "string",
"description": "API mode when event triggered.",
"x-example": "admin"
},
"ip": {
"type": "string",
"description": "IP session in use when the session was created.",
"x-example": "127.0.0.1"
},
"time": {
"type": "string",
"description": "Log creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"osCode": {
"type": "string",
"description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).",
"x-example": "Mac"
},
"osName": {
"type": "string",
"description": "Operating system name.",
"x-example": "Mac"
},
"osVersion": {
"type": "string",
"description": "Operating system version.",
"x-example": "Mac"
},
"clientType": {
"type": "string",
"description": "Client type.",
"x-example": "browser"
},
"clientCode": {
"type": "string",
"description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).",
"x-example": "CM"
},
"clientName": {
"type": "string",
"description": "Client name.",
"x-example": "Chrome Mobile iOS"
},
"clientVersion": {
"type": "string",
"description": "Client version.",
"x-example": "84.0"
},
"clientEngine": {
"type": "string",
"description": "Client engine name.",
"x-example": "WebKit"
},
"clientEngineVersion": {
"type": "string",
"description": "Client engine name.",
"x-example": "605.1.15"
},
"deviceName": {
"type": "string",
"description": "Device name.",
"x-example": "smartphone"
},
"deviceBrand": {
"type": "string",
"description": "Device brand name.",
"x-example": "Google"
},
"deviceModel": {
"type": "string",
"description": "Device model name.",
"x-example": "Nexus 5"
},
"countryCode": {
"type": "string",
"description": "Country two-character ISO 3166-1 alpha code.",
"x-example": "US"
},
"countryName": {
"type": "string",
"description": "Country name.",
"x-example": "United States"
}
},
"required": [
"event",
"userId",
"userEmail",
"userName",
"mode",
"ip",
"time",
"osCode",
"osName",
"osVersion",
"clientType",
"clientCode",
"clientName",
"clientVersion",
"clientEngine",
"clientEngineVersion",
"deviceName",
"deviceBrand",
"deviceModel",
"countryCode",
"countryName"
],
"example": {
"event": "account.sessions.create",
"userId": "610fc2f985ee0",
"userEmail": "john@appwrite.io",
"userName": "John Doe",
"mode": "admin",
"ip": "127.0.0.1",
"time": "2020-10-15T06:38:00.000+00:00",
"osCode": "Mac",
"osName": "Mac",
"osVersion": "Mac",
"clientType": "browser",
"clientCode": "CM",
"clientName": "Chrome Mobile iOS",
"clientVersion": "84.0",
"clientEngine": "WebKit",
"clientEngineVersion": "605.1.15",
"deviceName": "smartphone",
"deviceBrand": "Google",
"deviceModel": "Nexus 5",
"countryCode": "US",
"countryName": "United States"
}
},
"user": {
"description": "User",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "User ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "User creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "User update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "User name.",
"x-example": "John Doe"
},
"password": {
"type": "string",
"description": "Hashed user password.",
"x-example": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE",
"nullable": true
},
"hash": {
"type": "string",
"description": "Password hashing algorithm.",
"x-example": "argon2",
"nullable": true
},
"hashOptions": {
"type": "object",
"description": "Password hashing algorithm configuration.",
"x-example": {},
"items": {
"oneOf": [
{
"$ref": "#\/components\/schemas\/algoArgon2"
},
{
"$ref": "#\/components\/schemas\/algoScrypt"
},
{
"$ref": "#\/components\/schemas\/algoScryptModified"
},
{
"$ref": "#\/components\/schemas\/algoBcrypt"
},
{
"$ref": "#\/components\/schemas\/algoPhpass"
},
{
"$ref": "#\/components\/schemas\/algoSha"
},
{
"$ref": "#\/components\/schemas\/algoMd5"
}
]
},
"nullable": true
},
"registration": {
"type": "string",
"description": "User registration date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"status": {
"type": "boolean",
"description": "User status. Pass `true` for enabled and `false` for disabled.",
"x-example": true
},
"labels": {
"type": "array",
"description": "Labels for the user.",
"items": {
"type": "string"
},
"x-example": [
"vip"
]
},
"passwordUpdate": {
"type": "string",
"description": "Password update time in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"email": {
"type": "string",
"description": "User email address.",
"x-example": "john@appwrite.io"
},
"phone": {
"type": "string",
"description": "User phone number in E.164 format.",
"x-example": "+4930901820"
},
"emailVerification": {
"type": "boolean",
"description": "Email verification status.",
"x-example": true
},
"phoneVerification": {
"type": "boolean",
"description": "Phone verification status.",
"x-example": true
},
"mfa": {
"type": "boolean",
"description": "Multi factor authentication status.",
"x-example": true
},
"prefs": {
"type": "object",
"description": "User preferences as a key-value object",
"x-example": {
"theme": "pink",
"timezone": "UTC"
},
"items": {
"$ref": "#\/components\/schemas\/preferences"
}
},
"targets": {
"type": "array",
"description": "A user-owned message receiver. A single user may have multiple e.g. emails, phones, and a browser. Each target is registered with a single provider.",
"items": {
"$ref": "#\/components\/schemas\/target"
},
"x-example": []
},
"accessedAt": {
"type": "string",
"description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.",
"x-example": "2020-10-15T06:38:00.000+00:00"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"registration",
"status",
"labels",
"passwordUpdate",
"email",
"phone",
"emailVerification",
"phoneVerification",
"mfa",
"prefs",
"targets",
"accessedAt"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "John Doe",
"password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE",
"hash": "argon2",
"hashOptions": {},
"registration": "2020-10-15T06:38:00.000+00:00",
"status": true,
"labels": [
"vip"
],
"passwordUpdate": "2020-10-15T06:38:00.000+00:00",
"email": "john@appwrite.io",
"phone": "+4930901820",
"emailVerification": true,
"phoneVerification": true,
"mfa": true,
"prefs": {
"theme": "pink",
"timezone": "UTC"
},
"targets": [],
"accessedAt": "2020-10-15T06:38:00.000+00:00"
}
},
"algoMd5": {
"description": "AlgoMD5",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Algo type.",
"x-example": "md5"
}
},
"required": [
"type"
],
"example": {
"type": "md5"
}
},
"algoSha": {
"description": "AlgoSHA",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Algo type.",
"x-example": "sha"
}
},
"required": [
"type"
],
"example": {
"type": "sha"
}
},
"algoPhpass": {
"description": "AlgoPHPass",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Algo type.",
"x-example": "phpass"
}
},
"required": [
"type"
],
"example": {
"type": "phpass"
}
},
"algoBcrypt": {
"description": "AlgoBcrypt",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Algo type.",
"x-example": "bcrypt"
}
},
"required": [
"type"
],
"example": {
"type": "bcrypt"
}
},
"algoScrypt": {
"description": "AlgoScrypt",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Algo type.",
"x-example": "scrypt"
},
"costCpu": {
"type": "integer",
"description": "CPU complexity of computed hash.",
"x-example": 8,
"format": "int32"
},
"costMemory": {
"type": "integer",
"description": "Memory complexity of computed hash.",
"x-example": 14,
"format": "int32"
},
"costParallel": {
"type": "integer",
"description": "Parallelization of computed hash.",
"x-example": 1,
"format": "int32"
},
"length": {
"type": "integer",
"description": "Length used to compute hash.",
"x-example": 64,
"format": "int32"
}
},
"required": [
"type",
"costCpu",
"costMemory",
"costParallel",
"length"
],
"example": {
"type": "scrypt",
"costCpu": 8,
"costMemory": 14,
"costParallel": 1,
"length": 64
}
},
"algoScryptModified": {
"description": "AlgoScryptModified",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Algo type.",
"x-example": "scryptMod"
},
"salt": {
"type": "string",
"description": "Salt used to compute hash.",
"x-example": "UxLMreBr6tYyjQ=="
},
"saltSeparator": {
"type": "string",
"description": "Separator used to compute hash.",
"x-example": "Bw=="
},
"signerKey": {
"type": "string",
"description": "Key used to compute hash.",
"x-example": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="
}
},
"required": [
"type",
"salt",
"saltSeparator",
"signerKey"
],
"example": {
"type": "scryptMod",
"salt": "UxLMreBr6tYyjQ==",
"saltSeparator": "Bw==",
"signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="
}
},
"algoArgon2": {
"description": "AlgoArgon2",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Algo type.",
"x-example": "argon2"
},
"memoryCost": {
"type": "integer",
"description": "Memory used to compute hash.",
"x-example": 65536,
"format": "int32"
},
"timeCost": {
"type": "integer",
"description": "Amount of time consumed to compute hash",
"x-example": 4,
"format": "int32"
},
"threads": {
"type": "integer",
"description": "Number of threads used to compute hash.",
"x-example": 3,
"format": "int32"
}
},
"required": [
"type",
"memoryCost",
"timeCost",
"threads"
],
"example": {
"type": "argon2",
"memoryCost": 65536,
"timeCost": 4,
"threads": 3
}
},
"preferences": {
"description": "Preferences",
"type": "object",
"additionalProperties": true,
"example": {
"language": "en",
"timezone": "UTC",
"darkTheme": true
}
},
"session": {
"description": "Session",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Session ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Session creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Session update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "5e5bb8c16897e"
},
"expire": {
"type": "string",
"description": "Session expiration date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"provider": {
"type": "string",
"description": "Session Provider.",
"x-example": "email"
},
"providerUid": {
"type": "string",
"description": "Session Provider User ID.",
"x-example": "user@example.com"
},
"providerAccessToken": {
"type": "string",
"description": "Session Provider Access Token.",
"x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
},
"providerAccessTokenExpiry": {
"type": "string",
"description": "The date of when the access token expires in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"providerRefreshToken": {
"type": "string",
"description": "Session Provider Refresh Token.",
"x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
},
"ip": {
"type": "string",
"description": "IP in use when the session was created.",
"x-example": "127.0.0.1"
},
"osCode": {
"type": "string",
"description": "Operating system code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/os.json).",
"x-example": "Mac"
},
"osName": {
"type": "string",
"description": "Operating system name.",
"x-example": "Mac"
},
"osVersion": {
"type": "string",
"description": "Operating system version.",
"x-example": "Mac"
},
"clientType": {
"type": "string",
"description": "Client type.",
"x-example": "browser"
},
"clientCode": {
"type": "string",
"description": "Client code name. View list of [available options](https:\/\/github.com\/appwrite\/appwrite\/blob\/master\/docs\/lists\/clients.json).",
"x-example": "CM"
},
"clientName": {
"type": "string",
"description": "Client name.",
"x-example": "Chrome Mobile iOS"
},
"clientVersion": {
"type": "string",
"description": "Client version.",
"x-example": "84.0"
},
"clientEngine": {
"type": "string",
"description": "Client engine name.",
"x-example": "WebKit"
},
"clientEngineVersion": {
"type": "string",
"description": "Client engine name.",
"x-example": "605.1.15"
},
"deviceName": {
"type": "string",
"description": "Device name.",
"x-example": "smartphone"
},
"deviceBrand": {
"type": "string",
"description": "Device brand name.",
"x-example": "Google"
},
"deviceModel": {
"type": "string",
"description": "Device model name.",
"x-example": "Nexus 5"
},
"countryCode": {
"type": "string",
"description": "Country two-character ISO 3166-1 alpha code.",
"x-example": "US"
},
"countryName": {
"type": "string",
"description": "Country name.",
"x-example": "United States"
},
"current": {
"type": "boolean",
"description": "Returns true if this the current user session.",
"x-example": true
},
"factors": {
"type": "array",
"description": "Returns a list of active session factors.",
"items": {
"type": "string"
},
"x-example": [
"email"
]
},
"secret": {
"type": "string",
"description": "Secret used to authenticate the user. Only included if the request was made with an API key",
"x-example": "5e5bb8c16897e"
},
"mfaUpdatedAt": {
"type": "string",
"description": "Most recent date in ISO 8601 format when the session successfully passed MFA challenge.",
"x-example": "2020-10-15T06:38:00.000+00:00"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"userId",
"expire",
"provider",
"providerUid",
"providerAccessToken",
"providerAccessTokenExpiry",
"providerRefreshToken",
"ip",
"osCode",
"osName",
"osVersion",
"clientType",
"clientCode",
"clientName",
"clientVersion",
"clientEngine",
"clientEngineVersion",
"deviceName",
"deviceBrand",
"deviceModel",
"countryCode",
"countryName",
"current",
"factors",
"secret",
"mfaUpdatedAt"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"userId": "5e5bb8c16897e",
"expire": "2020-10-15T06:38:00.000+00:00",
"provider": "email",
"providerUid": "user@example.com",
"providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
"providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
"providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
"ip": "127.0.0.1",
"osCode": "Mac",
"osName": "Mac",
"osVersion": "Mac",
"clientType": "browser",
"clientCode": "CM",
"clientName": "Chrome Mobile iOS",
"clientVersion": "84.0",
"clientEngine": "WebKit",
"clientEngineVersion": "605.1.15",
"deviceName": "smartphone",
"deviceBrand": "Google",
"deviceModel": "Nexus 5",
"countryCode": "US",
"countryName": "United States",
"current": true,
"factors": [
"email"
],
"secret": "5e5bb8c16897e",
"mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00"
}
},
"identity": {
"description": "Identity",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Identity ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Identity creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Identity update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "5e5bb8c16897e"
},
"provider": {
"type": "string",
"description": "Identity Provider.",
"x-example": "email"
},
"providerUid": {
"type": "string",
"description": "ID of the User in the Identity Provider.",
"x-example": "5e5bb8c16897e"
},
"providerEmail": {
"type": "string",
"description": "Email of the User in the Identity Provider.",
"x-example": "user@example.com"
},
"providerAccessToken": {
"type": "string",
"description": "Identity Provider Access Token.",
"x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
},
"providerAccessTokenExpiry": {
"type": "string",
"description": "The date of when the access token expires in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"providerRefreshToken": {
"type": "string",
"description": "Identity Provider Refresh Token.",
"x-example": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"userId",
"provider",
"providerUid",
"providerEmail",
"providerAccessToken",
"providerAccessTokenExpiry",
"providerRefreshToken"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"userId": "5e5bb8c16897e",
"provider": "email",
"providerUid": "5e5bb8c16897e",
"providerEmail": "user@example.com",
"providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
"providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
"providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
}
},
"token": {
"description": "Token",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Token ID.",
"x-example": "bb8ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Token creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "5e5ea5c168bb8"
},
"secret": {
"type": "string",
"description": "Token secret key. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.",
"x-example": ""
},
"expire": {
"type": "string",
"description": "Token expiration date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"phrase": {
"type": "string",
"description": "Security phrase of a token. Empty if security phrase was not requested when creating a token. It includes randomly generated phrase which is also sent in the external resource such as email.",
"x-example": "Golden Fox"
}
},
"required": [
"$id",
"$createdAt",
"userId",
"secret",
"expire",
"phrase"
],
"example": {
"$id": "bb8ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"userId": "5e5ea5c168bb8",
"secret": "",
"expire": "2020-10-15T06:38:00.000+00:00",
"phrase": "Golden Fox"
}
},
"jwt": {
"description": "JWT",
"type": "object",
"properties": {
"jwt": {
"type": "string",
"description": "JWT encoded string.",
"x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
},
"required": [
"jwt"
],
"example": {
"jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}
},
"locale": {
"description": "Locale",
"type": "object",
"properties": {
"ip": {
"type": "string",
"description": "User IP address.",
"x-example": "127.0.0.1"
},
"countryCode": {
"type": "string",
"description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format",
"x-example": "US"
},
"country": {
"type": "string",
"description": "Country name. This field support localization.",
"x-example": "United States"
},
"continentCode": {
"type": "string",
"description": "Continent code. A two character continent code \"AF\" for Africa, \"AN\" for Antarctica, \"AS\" for Asia, \"EU\" for Europe, \"NA\" for North America, \"OC\" for Oceania, and \"SA\" for South America.",
"x-example": "NA"
},
"continent": {
"type": "string",
"description": "Continent name. This field support localization.",
"x-example": "North America"
},
"eu": {
"type": "boolean",
"description": "True if country is part of the European Union.",
"x-example": false
},
"currency": {
"type": "string",
"description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format",
"x-example": "USD"
}
},
"required": [
"ip",
"countryCode",
"country",
"continentCode",
"continent",
"eu",
"currency"
],
"example": {
"ip": "127.0.0.1",
"countryCode": "US",
"country": "United States",
"continentCode": "NA",
"continent": "North America",
"eu": false,
"currency": "USD"
}
},
"localeCode": {
"description": "LocaleCode",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Locale codes in [ISO 639-1](https:\/\/en.wikipedia.org\/wiki\/List_of_ISO_639-1_codes)",
"x-example": "en-us"
},
"name": {
"type": "string",
"description": "Locale name",
"x-example": "US"
}
},
"required": [
"code",
"name"
],
"example": {
"code": "en-us",
"name": "US"
}
},
"file": {
"description": "File",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "File ID.",
"x-example": "5e5ea5c16897e"
},
"bucketId": {
"type": "string",
"description": "Bucket ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "File creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "File update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$permissions": {
"type": "array",
"description": "File permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"items": {
"type": "string"
},
"x-example": [
"read(\"any\")"
]
},
"name": {
"type": "string",
"description": "File name.",
"x-example": "Pink.png"
},
"signature": {
"type": "string",
"description": "File MD5 signature.",
"x-example": "5d529fd02b544198ae075bd57c1762bb"
},
"mimeType": {
"type": "string",
"description": "File mime type.",
"x-example": "image\/png"
},
"sizeOriginal": {
"type": "integer",
"description": "File original size in bytes.",
"x-example": 17890,
"format": "int32"
},
"chunksTotal": {
"type": "integer",
"description": "Total number of chunks available",
"x-example": 17890,
"format": "int32"
},
"chunksUploaded": {
"type": "integer",
"description": "Total number of chunks uploaded",
"x-example": 17890,
"format": "int32"
},
"encryption": {
"type": "boolean",
"description": "Whether file contents are encrypted at rest.",
"x-example": true
},
"compression": {
"type": "string",
"description": "Compression algorithm used for the file. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).",
"x-example": "gzip"
}
},
"required": [
"$id",
"bucketId",
"$createdAt",
"$updatedAt",
"$permissions",
"name",
"signature",
"mimeType",
"sizeOriginal",
"chunksTotal",
"chunksUploaded",
"encryption",
"compression"
],
"example": {
"$id": "5e5ea5c16897e",
"bucketId": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"$permissions": [
"read(\"any\")"
],
"name": "Pink.png",
"signature": "5d529fd02b544198ae075bd57c1762bb",
"mimeType": "image\/png",
"sizeOriginal": 17890,
"chunksTotal": 17890,
"chunksUploaded": 17890,
"encryption": true,
"compression": "gzip"
}
},
"bucket": {
"description": "Bucket",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Bucket ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Bucket creation time in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Bucket update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$permissions": {
"type": "array",
"description": "Bucket permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"items": {
"type": "string"
},
"x-example": [
"read(\"any\")"
]
},
"fileSecurity": {
"type": "boolean",
"description": "Whether file-level security is enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
"x-example": true
},
"name": {
"type": "string",
"description": "Bucket name.",
"x-example": "Documents"
},
"enabled": {
"type": "boolean",
"description": "Bucket enabled.",
"x-example": false
},
"maximumFileSize": {
"type": "integer",
"description": "Maximum file size supported.",
"x-example": 100,
"format": "int32"
},
"allowedFileExtensions": {
"type": "array",
"description": "Allowed file extensions.",
"items": {
"type": "string"
},
"x-example": [
"jpg",
"png"
]
},
"compression": {
"type": "string",
"description": "Compression algorithm chosen for compression. Will be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd).",
"x-example": "gzip"
},
"encryption": {
"type": "boolean",
"description": "Bucket is encrypted.",
"x-example": false
},
"antivirus": {
"type": "boolean",
"description": "Virus scanning is enabled.",
"x-example": false
},
"transformations": {
"type": "boolean",
"description": "Image transformations are enabled.",
"x-example": false
},
"totalSize": {
"type": "integer",
"description": "Total size of this bucket in bytes.",
"x-example": 128,
"format": "int32"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"$permissions",
"fileSecurity",
"name",
"enabled",
"maximumFileSize",
"allowedFileExtensions",
"compression",
"encryption",
"antivirus",
"transformations",
"totalSize"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"$permissions": [
"read(\"any\")"
],
"fileSecurity": true,
"name": "Documents",
"enabled": false,
"maximumFileSize": 100,
"allowedFileExtensions": [
"jpg",
"png"
],
"compression": "gzip",
"encryption": false,
"antivirus": false,
"transformations": false,
"totalSize": 128
}
},
"resourceToken": {
"description": "ResourceToken",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Token ID.",
"x-example": "bb8ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Token creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"resourceId": {
"type": "string",
"description": "Resource ID.",
"x-example": "5e5ea5c168bb8:5e5ea5c168bb8"
},
"resourceType": {
"type": "string",
"description": "Resource type.",
"x-example": "files"
},
"expire": {
"type": "string",
"description": "Token expiration date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"secret": {
"type": "string",
"description": "JWT encoded string.",
"x-example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
},
"accessedAt": {
"type": "string",
"description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.",
"x-example": "2020-10-15T06:38:00.000+00:00"
}
},
"required": [
"$id",
"$createdAt",
"resourceId",
"resourceType",
"expire",
"secret",
"accessedAt"
],
"example": {
"$id": "bb8ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"resourceId": "5e5ea5c168bb8:5e5ea5c168bb8",
"resourceType": "files",
"expire": "2020-10-15T06:38:00.000+00:00",
"secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"accessedAt": "2020-10-15T06:38:00.000+00:00"
}
},
"team": {
"description": "Team",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Team ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Team creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Team update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "Team name.",
"x-example": "VIP"
},
"total": {
"type": "integer",
"description": "Total number of team members.",
"x-example": 7,
"format": "int32"
},
"prefs": {
"type": "object",
"description": "Team preferences as a key-value object",
"x-example": {
"theme": "pink",
"timezone": "UTC"
},
"items": {
"$ref": "#\/components\/schemas\/preferences"
}
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"total",
"prefs"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "VIP",
"total": 7,
"prefs": {
"theme": "pink",
"timezone": "UTC"
}
}
},
"membership": {
"description": "Membership",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Membership ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Membership creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Membership update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "5e5ea5c16897e"
},
"userName": {
"type": "string",
"description": "User name. Hide this attribute by toggling membership privacy in the Console.",
"x-example": "John Doe"
},
"userEmail": {
"type": "string",
"description": "User email address. Hide this attribute by toggling membership privacy in the Console.",
"x-example": "john@appwrite.io"
},
"teamId": {
"type": "string",
"description": "Team ID.",
"x-example": "5e5ea5c16897e"
},
"teamName": {
"type": "string",
"description": "Team name.",
"x-example": "VIP"
},
"invited": {
"type": "string",
"description": "Date, the user has been invited to join the team in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"joined": {
"type": "string",
"description": "Date, the user has accepted the invitation to join the team in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"confirm": {
"type": "boolean",
"description": "User confirmation status, true if the user has joined the team or false otherwise.",
"x-example": false
},
"mfa": {
"type": "boolean",
"description": "Multi factor authentication status, true if the user has MFA enabled or false otherwise. Hide this attribute by toggling membership privacy in the Console.",
"x-example": false
},
"roles": {
"type": "array",
"description": "User list of roles",
"items": {
"type": "string"
},
"x-example": [
"owner"
]
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"userId",
"userName",
"userEmail",
"teamId",
"teamName",
"invited",
"joined",
"confirm",
"mfa",
"roles"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"userId": "5e5ea5c16897e",
"userName": "John Doe",
"userEmail": "john@appwrite.io",
"teamId": "5e5ea5c16897e",
"teamName": "VIP",
"invited": "2020-10-15T06:38:00.000+00:00",
"joined": "2020-10-15T06:38:00.000+00:00",
"confirm": false,
"mfa": false,
"roles": [
"owner"
]
}
},
"site": {
"description": "Site",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Site ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Site creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Site update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "Site name.",
"x-example": "My Site"
},
"enabled": {
"type": "boolean",
"description": "Site enabled.",
"x-example": false
},
"live": {
"type": "boolean",
"description": "Is the site deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the site to update it with the latest configuration.",
"x-example": false
},
"logging": {
"type": "boolean",
"description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.",
"x-example": false
},
"framework": {
"type": "string",
"description": "Site framework.",
"x-example": "react"
},
"deploymentId": {
"type": "string",
"description": "Site's active deployment ID.",
"x-example": "5e5ea5c16897e"
},
"deploymentCreatedAt": {
"type": "string",
"description": "Active deployment creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"deploymentScreenshotLight": {
"type": "string",
"description": "Screenshot of active deployment with light theme preference file ID.",
"x-example": "5e5ea5c16897e"
},
"deploymentScreenshotDark": {
"type": "string",
"description": "Screenshot of active deployment with dark theme preference file ID.",
"x-example": "5e5ea5c16897e"
},
"latestDeploymentId": {
"type": "string",
"description": "Site's latest deployment ID.",
"x-example": "5e5ea5c16897e"
},
"latestDeploymentCreatedAt": {
"type": "string",
"description": "Latest deployment creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"latestDeploymentStatus": {
"type": "string",
"description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".",
"x-example": "ready"
},
"vars": {
"type": "array",
"description": "Site variables.",
"items": {
"$ref": "#\/components\/schemas\/variable"
},
"x-example": []
},
"timeout": {
"type": "integer",
"description": "Site request timeout in seconds.",
"x-example": 300,
"format": "int32"
},
"installCommand": {
"type": "string",
"description": "The install command used to install the site dependencies.",
"x-example": "npm install"
},
"buildCommand": {
"type": "string",
"description": "The build command used to build the site.",
"x-example": "npm run build"
},
"outputDirectory": {
"type": "string",
"description": "The directory where the site build output is located.",
"x-example": "build"
},
"installationId": {
"type": "string",
"description": "Site VCS (Version Control System) installation id.",
"x-example": "6m40at4ejk5h2u9s1hboo"
},
"providerRepositoryId": {
"type": "string",
"description": "VCS (Version Control System) Repository ID",
"x-example": "appwrite"
},
"providerBranch": {
"type": "string",
"description": "VCS (Version Control System) branch name",
"x-example": "main"
},
"providerRootDirectory": {
"type": "string",
"description": "Path to site in VCS (Version Control System) repository",
"x-example": "sites\/helloWorld"
},
"providerSilentMode": {
"type": "boolean",
"description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests",
"x-example": false
},
"specification": {
"type": "string",
"description": "Machine specification for builds and executions.",
"x-example": "s-1vcpu-512mb"
},
"buildRuntime": {
"type": "string",
"description": "Site build runtime.",
"x-example": "node-22"
},
"adapter": {
"type": "string",
"description": "Site framework adapter.",
"x-example": "static"
},
"fallbackFile": {
"type": "string",
"description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.",
"x-example": "index.html"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"enabled",
"live",
"logging",
"framework",
"deploymentId",
"deploymentCreatedAt",
"deploymentScreenshotLight",
"deploymentScreenshotDark",
"latestDeploymentId",
"latestDeploymentCreatedAt",
"latestDeploymentStatus",
"vars",
"timeout",
"installCommand",
"buildCommand",
"outputDirectory",
"installationId",
"providerRepositoryId",
"providerBranch",
"providerRootDirectory",
"providerSilentMode",
"specification",
"buildRuntime",
"adapter",
"fallbackFile"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "My Site",
"enabled": false,
"live": false,
"logging": false,
"framework": "react",
"deploymentId": "5e5ea5c16897e",
"deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
"deploymentScreenshotLight": "5e5ea5c16897e",
"deploymentScreenshotDark": "5e5ea5c16897e",
"latestDeploymentId": "5e5ea5c16897e",
"latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
"latestDeploymentStatus": "ready",
"vars": [],
"timeout": 300,
"installCommand": "npm install",
"buildCommand": "npm run build",
"outputDirectory": "build",
"installationId": "6m40at4ejk5h2u9s1hboo",
"providerRepositoryId": "appwrite",
"providerBranch": "main",
"providerRootDirectory": "sites\/helloWorld",
"providerSilentMode": false,
"specification": "s-1vcpu-512mb",
"buildRuntime": "node-22",
"adapter": "static",
"fallbackFile": "index.html"
}
},
"templateSite": {
"description": "Template Site",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Site Template ID.",
"x-example": "starter"
},
"name": {
"type": "string",
"description": "Site Template Name.",
"x-example": "Starter site"
},
"tagline": {
"type": "string",
"description": "Short description of template",
"x-example": "Minimal web app integrating with Appwrite."
},
"demoUrl": {
"type": "string",
"description": "URL hosting a template demo.",
"x-example": "https:\/\/nextjs-starter.appwrite.network\/"
},
"screenshotDark": {
"type": "string",
"description": "File URL with preview screenshot in dark theme preference.",
"x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png"
},
"screenshotLight": {
"type": "string",
"description": "File URL with preview screenshot in light theme preference.",
"x-example": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png"
},
"useCases": {
"type": "array",
"description": "Site use cases.",
"items": {
"type": "string"
},
"x-example": "Starter"
},
"frameworks": {
"type": "array",
"description": "List of frameworks that can be used with this template.",
"items": {
"$ref": "#\/components\/schemas\/templateFramework"
},
"x-example": []
},
"vcsProvider": {
"type": "string",
"description": "VCS (Version Control System) Provider.",
"x-example": "github"
},
"providerRepositoryId": {
"type": "string",
"description": "VCS (Version Control System) Repository ID",
"x-example": "templates"
},
"providerOwner": {
"type": "string",
"description": "VCS (Version Control System) Owner.",
"x-example": "appwrite"
},
"providerVersion": {
"type": "string",
"description": "VCS (Version Control System) branch version (tag).",
"x-example": "main"
},
"variables": {
"type": "array",
"description": "Site variables.",
"items": {
"$ref": "#\/components\/schemas\/templateVariable"
},
"x-example": []
}
},
"required": [
"key",
"name",
"tagline",
"demoUrl",
"screenshotDark",
"screenshotLight",
"useCases",
"frameworks",
"vcsProvider",
"providerRepositoryId",
"providerOwner",
"providerVersion",
"variables"
],
"example": {
"key": "starter",
"name": "Starter site",
"tagline": "Minimal web app integrating with Appwrite.",
"demoUrl": "https:\/\/nextjs-starter.appwrite.network\/",
"screenshotDark": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png",
"screenshotLight": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png",
"useCases": "Starter",
"frameworks": [],
"vcsProvider": "github",
"providerRepositoryId": "templates",
"providerOwner": "appwrite",
"providerVersion": "main",
"variables": []
}
},
"templateFramework": {
"description": "Template Framework",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Parent framework key.",
"x-example": "sveltekit"
},
"name": {
"type": "string",
"description": "Framework Name.",
"x-example": "SvelteKit"
},
"installCommand": {
"type": "string",
"description": "The install command used to install the dependencies.",
"x-example": "npm install"
},
"buildCommand": {
"type": "string",
"description": "The build command used to build the deployment.",
"x-example": "npm run build"
},
"outputDirectory": {
"type": "string",
"description": "The output directory to store the build output.",
"x-example": ".\/build"
},
"providerRootDirectory": {
"type": "string",
"description": "Path to site in VCS (Version Control System) repository",
"x-example": ".\/svelte-kit\/starter"
},
"buildRuntime": {
"type": "string",
"description": "Runtime used during build step of template.",
"x-example": "node-22"
},
"adapter": {
"type": "string",
"description": "Site framework runtime",
"x-example": "ssr"
},
"fallbackFile": {
"type": "string",
"description": "Fallback file for SPA. Only relevant for static serve runtime.",
"x-example": "index.html"
}
},
"required": [
"key",
"name",
"installCommand",
"buildCommand",
"outputDirectory",
"providerRootDirectory",
"buildRuntime",
"adapter",
"fallbackFile"
],
"example": {
"key": "sveltekit",
"name": "SvelteKit",
"installCommand": "npm install",
"buildCommand": "npm run build",
"outputDirectory": ".\/build",
"providerRootDirectory": ".\/svelte-kit\/starter",
"buildRuntime": "node-22",
"adapter": "ssr",
"fallbackFile": "index.html"
}
},
"function": {
"description": "Function",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Function ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Function creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Function update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"execute": {
"type": "array",
"description": "Execution permissions.",
"items": {
"type": "string"
},
"x-example": "users"
},
"name": {
"type": "string",
"description": "Function name.",
"x-example": "My Function"
},
"enabled": {
"type": "boolean",
"description": "Function enabled.",
"x-example": false
},
"live": {
"type": "boolean",
"description": "Is the function deployed with the latest configuration? This is set to false if you've changed an environment variables, entrypoint, commands, or other settings that needs redeploy to be applied. When the value is false, redeploy the function to update it with the latest configuration.",
"x-example": false
},
"logging": {
"type": "boolean",
"description": "When disabled, executions will exclude logs and errors, and will be slightly faster.",
"x-example": false
},
"runtime": {
"type": "string",
"description": "Function execution and build runtime.",
"x-example": "python-3.8"
},
"deploymentId": {
"type": "string",
"description": "Function's active deployment ID.",
"x-example": "5e5ea5c16897e"
},
"deploymentCreatedAt": {
"type": "string",
"description": "Active deployment creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"latestDeploymentId": {
"type": "string",
"description": "Function's latest deployment ID.",
"x-example": "5e5ea5c16897e"
},
"latestDeploymentCreatedAt": {
"type": "string",
"description": "Latest deployment creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"latestDeploymentStatus": {
"type": "string",
"description": "Status of latest deployment. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".",
"x-example": "ready"
},
"scopes": {
"type": "array",
"description": "Allowed permission scopes.",
"items": {
"type": "string"
},
"x-example": "users.read"
},
"vars": {
"type": "array",
"description": "Function variables.",
"items": {
"$ref": "#\/components\/schemas\/variable"
},
"x-example": []
},
"events": {
"type": "array",
"description": "Function trigger events.",
"items": {
"type": "string"
},
"x-example": "account.create"
},
"schedule": {
"type": "string",
"description": "Function execution schedule in CRON format.",
"x-example": "5 4 * * *"
},
"timeout": {
"type": "integer",
"description": "Function execution timeout in seconds.",
"x-example": 300,
"format": "int32"
},
"entrypoint": {
"type": "string",
"description": "The entrypoint file used to execute the deployment.",
"x-example": "index.js"
},
"commands": {
"type": "string",
"description": "The build command used to build the deployment.",
"x-example": "npm install"
},
"version": {
"type": "string",
"description": "Version of Open Runtimes used for the function.",
"x-example": "v2"
},
"installationId": {
"type": "string",
"description": "Function VCS (Version Control System) installation id.",
"x-example": "6m40at4ejk5h2u9s1hboo"
},
"providerRepositoryId": {
"type": "string",
"description": "VCS (Version Control System) Repository ID",
"x-example": "appwrite"
},
"providerBranch": {
"type": "string",
"description": "VCS (Version Control System) branch name",
"x-example": "main"
},
"providerRootDirectory": {
"type": "string",
"description": "Path to function in VCS (Version Control System) repository",
"x-example": "functions\/helloWorld"
},
"providerSilentMode": {
"type": "boolean",
"description": "Is VCS (Version Control System) connection is in silent mode? When in silence mode, no comments will be posted on the repository pull or merge requests",
"x-example": false
},
"specification": {
"type": "string",
"description": "Machine specification for builds and executions.",
"x-example": "s-1vcpu-512mb"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"execute",
"name",
"enabled",
"live",
"logging",
"runtime",
"deploymentId",
"deploymentCreatedAt",
"latestDeploymentId",
"latestDeploymentCreatedAt",
"latestDeploymentStatus",
"scopes",
"vars",
"events",
"schedule",
"timeout",
"entrypoint",
"commands",
"version",
"installationId",
"providerRepositoryId",
"providerBranch",
"providerRootDirectory",
"providerSilentMode",
"specification"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"execute": "users",
"name": "My Function",
"enabled": false,
"live": false,
"logging": false,
"runtime": "python-3.8",
"deploymentId": "5e5ea5c16897e",
"deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
"latestDeploymentId": "5e5ea5c16897e",
"latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
"latestDeploymentStatus": "ready",
"scopes": "users.read",
"vars": [],
"events": "account.create",
"schedule": "5 4 * * *",
"timeout": 300,
"entrypoint": "index.js",
"commands": "npm install",
"version": "v2",
"installationId": "6m40at4ejk5h2u9s1hboo",
"providerRepositoryId": "appwrite",
"providerBranch": "main",
"providerRootDirectory": "functions\/helloWorld",
"providerSilentMode": false,
"specification": "s-1vcpu-512mb"
}
},
"templateFunction": {
"description": "Template Function",
"type": "object",
"properties": {
"icon": {
"type": "string",
"description": "Function Template Icon.",
"x-example": "icon-lightning-bolt"
},
"id": {
"type": "string",
"description": "Function Template ID.",
"x-example": "starter"
},
"name": {
"type": "string",
"description": "Function Template Name.",
"x-example": "Starter function"
},
"tagline": {
"type": "string",
"description": "Function Template Tagline.",
"x-example": "A simple function to get started."
},
"permissions": {
"type": "array",
"description": "Execution permissions.",
"items": {
"type": "string"
},
"x-example": "any"
},
"events": {
"type": "array",
"description": "Function trigger events.",
"items": {
"type": "string"
},
"x-example": "account.create"
},
"cron": {
"type": "string",
"description": "Function execution schedult in CRON format.",
"x-example": "0 0 * * *"
},
"timeout": {
"type": "integer",
"description": "Function execution timeout in seconds.",
"x-example": 300,
"format": "int32"
},
"useCases": {
"type": "array",
"description": "Function use cases.",
"items": {
"type": "string"
},
"x-example": "Starter"
},
"runtimes": {
"type": "array",
"description": "List of runtimes that can be used with this template.",
"items": {
"$ref": "#\/components\/schemas\/templateRuntime"
},
"x-example": []
},
"instructions": {
"type": "string",
"description": "Function Template Instructions.",
"x-example": "For documentation and instructions check out <link>."
},
"vcsProvider": {
"type": "string",
"description": "VCS (Version Control System) Provider.",
"x-example": "github"
},
"providerRepositoryId": {
"type": "string",
"description": "VCS (Version Control System) Repository ID",
"x-example": "templates"
},
"providerOwner": {
"type": "string",
"description": "VCS (Version Control System) Owner.",
"x-example": "appwrite"
},
"providerVersion": {
"type": "string",
"description": "VCS (Version Control System) branch version (tag).",
"x-example": "main"
},
"variables": {
"type": "array",
"description": "Function variables.",
"items": {
"$ref": "#\/components\/schemas\/templateVariable"
},
"x-example": []
},
"scopes": {
"type": "array",
"description": "Function scopes.",
"items": {
"type": "string"
},
"x-example": "users.read"
}
},
"required": [
"icon",
"id",
"name",
"tagline",
"permissions",
"events",
"cron",
"timeout",
"useCases",
"runtimes",
"instructions",
"vcsProvider",
"providerRepositoryId",
"providerOwner",
"providerVersion",
"variables",
"scopes"
],
"example": {
"icon": "icon-lightning-bolt",
"id": "starter",
"name": "Starter function",
"tagline": "A simple function to get started.",
"permissions": "any",
"events": "account.create",
"cron": "0 0 * * *",
"timeout": 300,
"useCases": "Starter",
"runtimes": [],
"instructions": "For documentation and instructions check out <link>.",
"vcsProvider": "github",
"providerRepositoryId": "templates",
"providerOwner": "appwrite",
"providerVersion": "main",
"variables": [],
"scopes": "users.read"
}
},
"templateRuntime": {
"description": "Template Runtime",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Runtime Name.",
"x-example": "node-19.0"
},
"commands": {
"type": "string",
"description": "The build command used to build the deployment.",
"x-example": "npm install"
},
"entrypoint": {
"type": "string",
"description": "The entrypoint file used to execute the deployment.",
"x-example": "index.js"
},
"providerRootDirectory": {
"type": "string",
"description": "Path to function in VCS (Version Control System) repository",
"x-example": "node\/starter"
}
},
"required": [
"name",
"commands",
"entrypoint",
"providerRootDirectory"
],
"example": {
"name": "node-19.0",
"commands": "npm install",
"entrypoint": "index.js",
"providerRootDirectory": "node\/starter"
}
},
"templateVariable": {
"description": "Template Variable",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Variable Name.",
"x-example": "APPWRITE_DATABASE_ID"
},
"description": {
"type": "string",
"description": "Variable Description.",
"x-example": "The ID of the Appwrite database that contains the collection to sync."
},
"value": {
"type": "string",
"description": "Variable Value.",
"x-example": "512"
},
"secret": {
"type": "boolean",
"description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.",
"x-example": false
},
"placeholder": {
"type": "string",
"description": "Variable Placeholder.",
"x-example": "64a55...7b912"
},
"required": {
"type": "boolean",
"description": "Is the variable required?",
"x-example": false
},
"type": {
"type": "string",
"description": "Variable Type.",
"x-example": "password"
}
},
"required": [
"name",
"description",
"value",
"secret",
"placeholder",
"required",
"type"
],
"example": {
"name": "APPWRITE_DATABASE_ID",
"description": "The ID of the Appwrite database that contains the collection to sync.",
"value": "512",
"secret": false,
"placeholder": "64a55...7b912",
"required": false,
"type": "password"
}
},
"installation": {
"description": "Installation",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Function ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Function creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Function update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"provider": {
"type": "string",
"description": "VCS (Version Control System) provider name.",
"x-example": "github"
},
"organization": {
"type": "string",
"description": "VCS (Version Control System) organization name.",
"x-example": "appwrite"
},
"providerInstallationId": {
"type": "string",
"description": "VCS (Version Control System) installation ID.",
"x-example": "5322"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"provider",
"organization",
"providerInstallationId"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"provider": "github",
"organization": "appwrite",
"providerInstallationId": "5322"
}
},
"providerRepository": {
"description": "ProviderRepository",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "VCS (Version Control System) repository ID.",
"x-example": "5e5ea5c16897e"
},
"name": {
"type": "string",
"description": "VCS (Version Control System) repository name.",
"x-example": "appwrite"
},
"organization": {
"type": "string",
"description": "VCS (Version Control System) organization name",
"x-example": "appwrite"
},
"provider": {
"type": "string",
"description": "VCS (Version Control System) provider name.",
"x-example": "github"
},
"private": {
"type": "boolean",
"description": "Is VCS (Version Control System) repository private?",
"x-example": true
},
"defaultBranch": {
"type": "string",
"description": "VCS (Version Control System) repository's default branch name.",
"x-example": "main"
},
"pushedAt": {
"type": "string",
"description": "Last commit date in ISO 8601 format.",
"x-example": "datetime"
},
"variables": {
"type": "array",
"description": "Environment variables found in .env files",
"items": {
"type": "string"
},
"x-example": [
"PORT",
"NODE_ENV"
]
}
},
"required": [
"id",
"name",
"organization",
"provider",
"private",
"defaultBranch",
"pushedAt",
"variables"
],
"example": {
"id": "5e5ea5c16897e",
"name": "appwrite",
"organization": "appwrite",
"provider": "github",
"private": true,
"defaultBranch": "main",
"pushedAt": "datetime",
"variables": [
"PORT",
"NODE_ENV"
]
}
},
"providerRepositoryFramework": {
"description": "ProviderRepositoryFramework",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "VCS (Version Control System) repository ID.",
"x-example": "5e5ea5c16897e"
},
"name": {
"type": "string",
"description": "VCS (Version Control System) repository name.",
"x-example": "appwrite"
},
"organization": {
"type": "string",
"description": "VCS (Version Control System) organization name",
"x-example": "appwrite"
},
"provider": {
"type": "string",
"description": "VCS (Version Control System) provider name.",
"x-example": "github"
},
"private": {
"type": "boolean",
"description": "Is VCS (Version Control System) repository private?",
"x-example": true
},
"defaultBranch": {
"type": "string",
"description": "VCS (Version Control System) repository's default branch name.",
"x-example": "main"
},
"pushedAt": {
"type": "string",
"description": "Last commit date in ISO 8601 format.",
"x-example": "datetime"
},
"variables": {
"type": "array",
"description": "Environment variables found in .env files",
"items": {
"type": "string"
},
"x-example": [
"PORT",
"NODE_ENV"
]
},
"framework": {
"type": "string",
"description": "Auto-detected framework. Empty if type is not \"framework\".",
"x-example": "nextjs"
}
},
"required": [
"id",
"name",
"organization",
"provider",
"private",
"defaultBranch",
"pushedAt",
"variables",
"framework"
],
"example": {
"id": "5e5ea5c16897e",
"name": "appwrite",
"organization": "appwrite",
"provider": "github",
"private": true,
"defaultBranch": "main",
"pushedAt": "datetime",
"variables": [
"PORT",
"NODE_ENV"
],
"framework": "nextjs"
}
},
"providerRepositoryRuntime": {
"description": "ProviderRepositoryRuntime",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "VCS (Version Control System) repository ID.",
"x-example": "5e5ea5c16897e"
},
"name": {
"type": "string",
"description": "VCS (Version Control System) repository name.",
"x-example": "appwrite"
},
"organization": {
"type": "string",
"description": "VCS (Version Control System) organization name",
"x-example": "appwrite"
},
"provider": {
"type": "string",
"description": "VCS (Version Control System) provider name.",
"x-example": "github"
},
"private": {
"type": "boolean",
"description": "Is VCS (Version Control System) repository private?",
"x-example": true
},
"defaultBranch": {
"type": "string",
"description": "VCS (Version Control System) repository's default branch name.",
"x-example": "main"
},
"pushedAt": {
"type": "string",
"description": "Last commit date in ISO 8601 format.",
"x-example": "datetime"
},
"variables": {
"type": "array",
"description": "Environment variables found in .env files",
"items": {
"type": "string"
},
"x-example": [
"PORT",
"NODE_ENV"
]
},
"runtime": {
"type": "string",
"description": "Auto-detected runtime. Empty if type is not \"runtime\".",
"x-example": "node-22"
}
},
"required": [
"id",
"name",
"organization",
"provider",
"private",
"defaultBranch",
"pushedAt",
"variables",
"runtime"
],
"example": {
"id": "5e5ea5c16897e",
"name": "appwrite",
"organization": "appwrite",
"provider": "github",
"private": true,
"defaultBranch": "main",
"pushedAt": "datetime",
"variables": [
"PORT",
"NODE_ENV"
],
"runtime": "node-22"
}
},
"detectionFramework": {
"description": "DetectionFramework",
"type": "object",
"properties": {
"variables": {
"type": "array",
"description": "Environment variables found in .env files",
"items": {
"$ref": "#\/components\/schemas\/detectionVariable"
},
"x-example": {},
"nullable": true
},
"framework": {
"type": "string",
"description": "Framework",
"x-example": "nuxt"
},
"installCommand": {
"type": "string",
"description": "Site Install Command",
"x-example": "npm install"
},
"buildCommand": {
"type": "string",
"description": "Site Build Command",
"x-example": "npm run build"
},
"outputDirectory": {
"type": "string",
"description": "Site Output Directory",
"x-example": "dist"
}
},
"required": [
"framework",
"installCommand",
"buildCommand",
"outputDirectory"
],
"example": {
"variables": {},
"framework": "nuxt",
"installCommand": "npm install",
"buildCommand": "npm run build",
"outputDirectory": "dist"
}
},
"detectionRuntime": {
"description": "DetectionRuntime",
"type": "object",
"properties": {
"variables": {
"type": "array",
"description": "Environment variables found in .env files",
"items": {
"$ref": "#\/components\/schemas\/detectionVariable"
},
"x-example": {},
"nullable": true
},
"runtime": {
"type": "string",
"description": "Runtime",
"x-example": "node"
},
"entrypoint": {
"type": "string",
"description": "Function Entrypoint",
"x-example": "index.js"
},
"commands": {
"type": "string",
"description": "Function install and build commands",
"x-example": "npm install && npm run build"
}
},
"required": [
"runtime",
"entrypoint",
"commands"
],
"example": {
"variables": {},
"runtime": "node",
"entrypoint": "index.js",
"commands": "npm install && npm run build"
}
},
"detectionVariable": {
"description": "DetectionVariable",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of environment variable",
"x-example": "NODE_ENV"
},
"value": {
"type": "string",
"description": "Value of environment variable",
"x-example": "production"
}
},
"required": [
"name",
"value"
],
"example": {
"name": "NODE_ENV",
"value": "production"
}
},
"vcsContent": {
"description": "VcsContents",
"type": "object",
"properties": {
"size": {
"type": "integer",
"description": "Content size in bytes. Only files have size, and for directories, 0 is returned.",
"x-example": 1523,
"format": "int32",
"nullable": true
},
"isDirectory": {
"type": "boolean",
"description": "If a content is a directory. Directories can be used to check nested contents.",
"x-example": true,
"nullable": true
},
"name": {
"type": "string",
"description": "Name of directory or file.",
"x-example": "Main.java"
}
},
"required": [
"name"
],
"example": {
"size": 1523,
"isDirectory": true,
"name": "Main.java"
}
},
"branch": {
"description": "Branch",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Branch Name.",
"x-example": "main"
}
},
"required": [
"name"
],
"example": {
"name": "main"
}
},
"runtime": {
"description": "Runtime",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Runtime ID.",
"x-example": "python-3.8"
},
"key": {
"type": "string",
"description": "Parent runtime key.",
"x-example": "python"
},
"name": {
"type": "string",
"description": "Runtime Name.",
"x-example": "Python"
},
"version": {
"type": "string",
"description": "Runtime version.",
"x-example": "3.8"
},
"base": {
"type": "string",
"description": "Base Docker image used to build the runtime.",
"x-example": "python:3.8-alpine"
},
"image": {
"type": "string",
"description": "Image name of Docker Hub.",
"x-example": "appwrite\\\/runtime-for-python:3.8"
},
"logo": {
"type": "string",
"description": "Name of the logo image.",
"x-example": "python.png"
},
"supports": {
"type": "array",
"description": "List of supported architectures.",
"items": {
"type": "string"
},
"x-example": "amd64"
}
},
"required": [
"$id",
"key",
"name",
"version",
"base",
"image",
"logo",
"supports"
],
"example": {
"$id": "python-3.8",
"key": "python",
"name": "Python",
"version": "3.8",
"base": "python:3.8-alpine",
"image": "appwrite\\\/runtime-for-python:3.8",
"logo": "python.png",
"supports": "amd64"
}
},
"framework": {
"description": "Framework",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Framework key.",
"x-example": "sveltekit"
},
"name": {
"type": "string",
"description": "Framework Name.",
"x-example": "SvelteKit"
},
"buildRuntime": {
"type": "string",
"description": "Default runtime version.",
"x-example": "node-22"
},
"runtimes": {
"type": "array",
"description": "List of supported runtime versions.",
"items": {
"type": "string"
},
"x-example": [
"static-1",
"node-22"
]
},
"adapters": {
"type": "array",
"description": "List of supported adapters.",
"items": {
"$ref": "#\/components\/schemas\/frameworkAdapter"
},
"x-example": [
{
"key": "static",
"buildRuntime": "node-22",
"buildCommand": "npm run build",
"installCommand": "npm install",
"outputDirectory": ".\/dist"
}
]
}
},
"required": [
"key",
"name",
"buildRuntime",
"runtimes",
"adapters"
],
"example": {
"key": "sveltekit",
"name": "SvelteKit",
"buildRuntime": "node-22",
"runtimes": [
"static-1",
"node-22"
],
"adapters": [
{
"key": "static",
"buildRuntime": "node-22",
"buildCommand": "npm run build",
"installCommand": "npm install",
"outputDirectory": ".\/dist"
}
]
}
},
"frameworkAdapter": {
"description": "Framework Adapter",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Adapter key.",
"x-example": "static"
},
"installCommand": {
"type": "string",
"description": "Default command to download dependencies.",
"x-example": "npm install"
},
"buildCommand": {
"type": "string",
"description": "Default command to build site into output directory.",
"x-example": "npm run build"
},
"outputDirectory": {
"type": "string",
"description": "Default output directory of build.",
"x-example": ".\/dist"
},
"fallbackFile": {
"type": "string",
"description": "Name of fallback file to use instead of 404 page. If null, Appwrite 404 page will be displayed.",
"x-example": "index.html"
}
},
"required": [
"key",
"installCommand",
"buildCommand",
"outputDirectory",
"fallbackFile"
],
"example": {
"key": "static",
"installCommand": "npm install",
"buildCommand": "npm run build",
"outputDirectory": ".\/dist",
"fallbackFile": "index.html"
}
},
"deployment": {
"description": "Deployment",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Deployment ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Deployment creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Deployment update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"type": {
"type": "string",
"description": "Type of deployment.",
"x-example": "vcs"
},
"resourceId": {
"type": "string",
"description": "Resource ID.",
"x-example": "5e5ea6g16897e"
},
"resourceType": {
"type": "string",
"description": "Resource type.",
"x-example": "functions"
},
"entrypoint": {
"type": "string",
"description": "The entrypoint file to use to execute the deployment code.",
"x-example": "index.js"
},
"sourceSize": {
"type": "integer",
"description": "The code size in bytes.",
"x-example": 128,
"format": "int32"
},
"buildSize": {
"type": "integer",
"description": "The build output size in bytes.",
"x-example": 128,
"format": "int32"
},
"totalSize": {
"type": "integer",
"description": "The total size in bytes (source and build output).",
"x-example": 128,
"format": "int32"
},
"buildId": {
"type": "string",
"description": "The current build ID.",
"x-example": "5e5ea5c16897e"
},
"activate": {
"type": "boolean",
"description": "Whether the deployment should be automatically activated.",
"x-example": true
},
"screenshotLight": {
"type": "string",
"description": "Screenshot with light theme preference file ID.",
"x-example": "5e5ea5c16897e"
},
"screenshotDark": {
"type": "string",
"description": "Screenshot with dark theme preference file ID.",
"x-example": "5e5ea5c16897e"
},
"status": {
"type": "string",
"description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", \"canceled\" and \"failed\".",
"x-example": "ready",
"enum": [
"waiting",
"processing",
"building",
"ready",
"canceled",
"failed"
]
},
"buildLogs": {
"type": "string",
"description": "The build logs.",
"x-example": "Compiling source files..."
},
"buildDuration": {
"type": "integer",
"description": "The current build time in seconds.",
"x-example": 128,
"format": "int32"
},
"providerRepositoryName": {
"type": "string",
"description": "The name of the vcs provider repository",
"x-example": "database"
},
"providerRepositoryOwner": {
"type": "string",
"description": "The name of the vcs provider repository owner",
"x-example": "utopia"
},
"providerRepositoryUrl": {
"type": "string",
"description": "The url of the vcs provider repository",
"x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function"
},
"providerCommitHash": {
"type": "string",
"description": "The commit hash of the vcs commit",
"x-example": "7c3f25d"
},
"providerCommitAuthorUrl": {
"type": "string",
"description": "The url of vcs commit author",
"x-example": "https:\/\/github.com\/vermakhushboo"
},
"providerCommitAuthor": {
"type": "string",
"description": "The name of vcs commit author",
"x-example": "Khushboo Verma"
},
"providerCommitMessage": {
"type": "string",
"description": "The commit message",
"x-example": "Update index.js"
},
"providerCommitUrl": {
"type": "string",
"description": "The url of the vcs commit",
"x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"
},
"providerBranch": {
"type": "string",
"description": "The branch of the vcs repository",
"x-example": "0.7.x"
},
"providerBranchUrl": {
"type": "string",
"description": "The branch of the vcs repository",
"x-example": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"type",
"resourceId",
"resourceType",
"entrypoint",
"sourceSize",
"buildSize",
"totalSize",
"buildId",
"activate",
"screenshotLight",
"screenshotDark",
"status",
"buildLogs",
"buildDuration",
"providerRepositoryName",
"providerRepositoryOwner",
"providerRepositoryUrl",
"providerCommitHash",
"providerCommitAuthorUrl",
"providerCommitAuthor",
"providerCommitMessage",
"providerCommitUrl",
"providerBranch",
"providerBranchUrl"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"type": "vcs",
"resourceId": "5e5ea6g16897e",
"resourceType": "functions",
"entrypoint": "index.js",
"sourceSize": 128,
"buildSize": 128,
"totalSize": 128,
"buildId": "5e5ea5c16897e",
"activate": true,
"screenshotLight": "5e5ea5c16897e",
"screenshotDark": "5e5ea5c16897e",
"status": "ready",
"buildLogs": "Compiling source files...",
"buildDuration": 128,
"providerRepositoryName": "database",
"providerRepositoryOwner": "utopia",
"providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function",
"providerCommitHash": "7c3f25d",
"providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo",
"providerCommitAuthor": "Khushboo Verma",
"providerCommitMessage": "Update index.js",
"providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb",
"providerBranch": "0.7.x",
"providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"
}
},
"execution": {
"description": "Execution",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Execution ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Execution creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Execution update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$permissions": {
"type": "array",
"description": "Execution roles.",
"items": {
"type": "string"
},
"x-example": [
"any"
]
},
"functionId": {
"type": "string",
"description": "Function ID.",
"x-example": "5e5ea6g16897e"
},
"deploymentId": {
"type": "string",
"description": "Function's deployment ID used to create the execution.",
"x-example": "5e5ea5c16897e"
},
"trigger": {
"type": "string",
"description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.",
"x-example": "http",
"enum": [
"http",
"schedule",
"event"
]
},
"status": {
"type": "string",
"description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, `failed`, or `scheduled`.",
"x-example": "processing",
"enum": [
"waiting",
"processing",
"completed",
"failed",
"scheduled"
]
},
"requestMethod": {
"type": "string",
"description": "HTTP request method type.",
"x-example": "GET"
},
"requestPath": {
"type": "string",
"description": "HTTP request path and query.",
"x-example": "\/articles?id=5"
},
"requestHeaders": {
"type": "array",
"description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.",
"items": {
"$ref": "#\/components\/schemas\/headers"
},
"x-example": [
{
"Content-Type": "application\/json"
}
]
},
"responseStatusCode": {
"type": "integer",
"description": "HTTP response status code.",
"x-example": 200,
"format": "int32"
},
"responseBody": {
"type": "string",
"description": "HTTP response body. This will return empty unless execution is created as synchronous.",
"x-example": ""
},
"responseHeaders": {
"type": "array",
"description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.",
"items": {
"$ref": "#\/components\/schemas\/headers"
},
"x-example": [
{
"Content-Type": "application\/json"
}
]
},
"logs": {
"type": "string",
"description": "Function logs. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.",
"x-example": ""
},
"errors": {
"type": "string",
"description": "Function errors. Includes the last 4,000 characters. This will return an empty string unless the response is returned using an API key or as part of a webhook payload.",
"x-example": ""
},
"duration": {
"type": "number",
"description": "Resource(function\/site) execution duration in seconds.",
"x-example": 0.4,
"format": "double"
},
"scheduledAt": {
"type": "string",
"description": "The scheduled time for execution. If left empty, execution will be queued immediately.",
"x-example": "2020-10-15T06:38:00.000+00:00",
"nullable": true
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"$permissions",
"functionId",
"deploymentId",
"trigger",
"status",
"requestMethod",
"requestPath",
"requestHeaders",
"responseStatusCode",
"responseBody",
"responseHeaders",
"logs",
"errors",
"duration"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"$permissions": [
"any"
],
"functionId": "5e5ea6g16897e",
"deploymentId": "5e5ea5c16897e",
"trigger": "http",
"status": "processing",
"requestMethod": "GET",
"requestPath": "\/articles?id=5",
"requestHeaders": [
{
"Content-Type": "application\/json"
}
],
"responseStatusCode": 200,
"responseBody": "",
"responseHeaders": [
{
"Content-Type": "application\/json"
}
],
"logs": "",
"errors": "",
"duration": 0.4,
"scheduledAt": "2020-10-15T06:38:00.000+00:00"
}
},
"project": {
"description": "Project",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Project ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Project creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Project update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "Project name.",
"x-example": "New Project"
},
"description": {
"type": "string",
"description": "Project description.",
"x-example": "This is a new project."
},
"teamId": {
"type": "string",
"description": "Project team ID.",
"x-example": "1592981250"
},
"logo": {
"type": "string",
"description": "Project logo file ID.",
"x-example": "5f5c451b403cb"
},
"url": {
"type": "string",
"description": "Project website URL.",
"x-example": "5f5c451b403cb"
},
"legalName": {
"type": "string",
"description": "Company legal name.",
"x-example": "Company LTD."
},
"legalCountry": {
"type": "string",
"description": "Country code in [ISO 3166-1](http:\/\/en.wikipedia.org\/wiki\/ISO_3166-1) two-character format.",
"x-example": "US"
},
"legalState": {
"type": "string",
"description": "State name.",
"x-example": "New York"
},
"legalCity": {
"type": "string",
"description": "City name.",
"x-example": "New York City."
},
"legalAddress": {
"type": "string",
"description": "Company Address.",
"x-example": "620 Eighth Avenue, New York, NY 10018"
},
"legalTaxId": {
"type": "string",
"description": "Company Tax ID.",
"x-example": "131102020"
},
"authDuration": {
"type": "integer",
"description": "Session duration in seconds.",
"x-example": 60,
"format": "int32"
},
"authLimit": {
"type": "integer",
"description": "Max users allowed. 0 is unlimited.",
"x-example": 100,
"format": "int32"
},
"authSessionsLimit": {
"type": "integer",
"description": "Max sessions allowed per user. 100 maximum.",
"x-example": 10,
"format": "int32"
},
"authPasswordHistory": {
"type": "integer",
"description": "Max allowed passwords in the history list per user. Max passwords limit allowed in history is 20. Use 0 for disabling password history.",
"x-example": 5,
"format": "int32"
},
"authPasswordDictionary": {
"type": "boolean",
"description": "Whether or not to check user's password against most commonly used passwords.",
"x-example": true
},
"authPersonalDataCheck": {
"type": "boolean",
"description": "Whether or not to check the user password for similarity with their personal data.",
"x-example": true
},
"authMockNumbers": {
"type": "array",
"description": "An array of mock numbers and their corresponding verification codes (OTPs).",
"items": {
"$ref": "#\/components\/schemas\/mockNumber"
},
"x-example": [
{}
]
},
"authSessionAlerts": {
"type": "boolean",
"description": "Whether or not to send session alert emails to users.",
"x-example": true
},
"authMembershipsUserName": {
"type": "boolean",
"description": "Whether or not to show user names in the teams membership response.",
"x-example": true
},
"authMembershipsUserEmail": {
"type": "boolean",
"description": "Whether or not to show user emails in the teams membership response.",
"x-example": true
},
"authMembershipsMfa": {
"type": "boolean",
"description": "Whether or not to show user MFA status in the teams membership response.",
"x-example": true
},
"authInvalidateSessions": {
"type": "boolean",
"description": "Whether or not all existing sessions should be invalidated on password change",
"x-example": true
},
"oAuthProviders": {
"type": "array",
"description": "List of Auth Providers.",
"items": {
"$ref": "#\/components\/schemas\/authProvider"
},
"x-example": [
{}
]
},
"platforms": {
"type": "array",
"description": "List of Platforms.",
"items": {
"$ref": "#\/components\/schemas\/platform"
},
"x-example": {}
},
"webhooks": {
"type": "array",
"description": "List of Webhooks.",
"items": {
"$ref": "#\/components\/schemas\/webhook"
},
"x-example": {}
},
"keys": {
"type": "array",
"description": "List of API Keys.",
"items": {
"$ref": "#\/components\/schemas\/key"
},
"x-example": {}
},
"devKeys": {
"type": "array",
"description": "List of dev keys.",
"items": {
"$ref": "#\/components\/schemas\/devKey"
},
"x-example": {}
},
"smtpEnabled": {
"type": "boolean",
"description": "Status for custom SMTP",
"x-example": false
},
"smtpSenderName": {
"type": "string",
"description": "SMTP sender name",
"x-example": "John Appwrite"
},
"smtpSenderEmail": {
"type": "string",
"description": "SMTP sender email",
"x-example": "john@appwrite.io"
},
"smtpReplyTo": {
"type": "string",
"description": "SMTP reply to email",
"x-example": "support@appwrite.io"
},
"smtpHost": {
"type": "string",
"description": "SMTP server host name",
"x-example": "mail.appwrite.io"
},
"smtpPort": {
"type": "integer",
"description": "SMTP server port",
"x-example": 25,
"format": "int32"
},
"smtpUsername": {
"type": "string",
"description": "SMTP server username",
"x-example": "emailuser"
},
"smtpPassword": {
"type": "string",
"description": "SMTP server password",
"x-example": "securepassword"
},
"smtpSecure": {
"type": "string",
"description": "SMTP server secure protocol",
"x-example": "tls"
},
"pingCount": {
"type": "integer",
"description": "Number of times the ping was received for this project.",
"x-example": 1,
"format": "int32"
},
"pingedAt": {
"type": "string",
"description": "Last ping datetime in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"labels": {
"type": "array",
"description": "Labels for the project.",
"items": {
"type": "string"
},
"x-example": [
"vip"
]
},
"authEmailPassword": {
"type": "boolean",
"description": "Email\/Password auth method status",
"x-example": true
},
"authUsersAuthMagicURL": {
"type": "boolean",
"description": "Magic URL auth method status",
"x-example": true
},
"authEmailOtp": {
"type": "boolean",
"description": "Email (OTP) auth method status",
"x-example": true
},
"authAnonymous": {
"type": "boolean",
"description": "Anonymous auth method status",
"x-example": true
},
"authInvites": {
"type": "boolean",
"description": "Invites auth method status",
"x-example": true
},
"authJWT": {
"type": "boolean",
"description": "JWT auth method status",
"x-example": true
},
"authPhone": {
"type": "boolean",
"description": "Phone auth method status",
"x-example": true
},
"serviceStatusForAccount": {
"type": "boolean",
"description": "Account service status",
"x-example": true
},
"serviceStatusForAvatars": {
"type": "boolean",
"description": "Avatars service status",
"x-example": true
},
"serviceStatusForDatabases": {
"type": "boolean",
"description": "Databases (legacy) service status",
"x-example": true
},
"serviceStatusForTablesdb": {
"type": "boolean",
"description": "TablesDB service status",
"x-example": true
},
"serviceStatusForLocale": {
"type": "boolean",
"description": "Locale service status",
"x-example": true
},
"serviceStatusForHealth": {
"type": "boolean",
"description": "Health service status",
"x-example": true
},
"serviceStatusForStorage": {
"type": "boolean",
"description": "Storage service status",
"x-example": true
},
"serviceStatusForTeams": {
"type": "boolean",
"description": "Teams service status",
"x-example": true
},
"serviceStatusForUsers": {
"type": "boolean",
"description": "Users service status",
"x-example": true
},
"serviceStatusForSites": {
"type": "boolean",
"description": "Sites service status",
"x-example": true
},
"serviceStatusForFunctions": {
"type": "boolean",
"description": "Functions service status",
"x-example": true
},
"serviceStatusForGraphql": {
"type": "boolean",
"description": "GraphQL service status",
"x-example": true
},
"serviceStatusForMessaging": {
"type": "boolean",
"description": "Messaging service status",
"x-example": true
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"description",
"teamId",
"logo",
"url",
"legalName",
"legalCountry",
"legalState",
"legalCity",
"legalAddress",
"legalTaxId",
"authDuration",
"authLimit",
"authSessionsLimit",
"authPasswordHistory",
"authPasswordDictionary",
"authPersonalDataCheck",
"authMockNumbers",
"authSessionAlerts",
"authMembershipsUserName",
"authMembershipsUserEmail",
"authMembershipsMfa",
"authInvalidateSessions",
"oAuthProviders",
"platforms",
"webhooks",
"keys",
"devKeys",
"smtpEnabled",
"smtpSenderName",
"smtpSenderEmail",
"smtpReplyTo",
"smtpHost",
"smtpPort",
"smtpUsername",
"smtpPassword",
"smtpSecure",
"pingCount",
"pingedAt",
"labels",
"authEmailPassword",
"authUsersAuthMagicURL",
"authEmailOtp",
"authAnonymous",
"authInvites",
"authJWT",
"authPhone",
"serviceStatusForAccount",
"serviceStatusForAvatars",
"serviceStatusForDatabases",
"serviceStatusForTablesdb",
"serviceStatusForLocale",
"serviceStatusForHealth",
"serviceStatusForStorage",
"serviceStatusForTeams",
"serviceStatusForUsers",
"serviceStatusForSites",
"serviceStatusForFunctions",
"serviceStatusForGraphql",
"serviceStatusForMessaging"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "New Project",
"description": "This is a new project.",
"teamId": "1592981250",
"logo": "5f5c451b403cb",
"url": "5f5c451b403cb",
"legalName": "Company LTD.",
"legalCountry": "US",
"legalState": "New York",
"legalCity": "New York City.",
"legalAddress": "620 Eighth Avenue, New York, NY 10018",
"legalTaxId": "131102020",
"authDuration": 60,
"authLimit": 100,
"authSessionsLimit": 10,
"authPasswordHistory": 5,
"authPasswordDictionary": true,
"authPersonalDataCheck": true,
"authMockNumbers": [
{}
],
"authSessionAlerts": true,
"authMembershipsUserName": true,
"authMembershipsUserEmail": true,
"authMembershipsMfa": true,
"authInvalidateSessions": true,
"oAuthProviders": [
{}
],
"platforms": {},
"webhooks": {},
"keys": {},
"devKeys": {},
"smtpEnabled": false,
"smtpSenderName": "John Appwrite",
"smtpSenderEmail": "john@appwrite.io",
"smtpReplyTo": "support@appwrite.io",
"smtpHost": "mail.appwrite.io",
"smtpPort": 25,
"smtpUsername": "emailuser",
"smtpPassword": "securepassword",
"smtpSecure": "tls",
"pingCount": 1,
"pingedAt": "2020-10-15T06:38:00.000+00:00",
"labels": [
"vip"
],
"authEmailPassword": true,
"authUsersAuthMagicURL": true,
"authEmailOtp": true,
"authAnonymous": true,
"authInvites": true,
"authJWT": true,
"authPhone": true,
"serviceStatusForAccount": true,
"serviceStatusForAvatars": true,
"serviceStatusForDatabases": true,
"serviceStatusForTablesdb": true,
"serviceStatusForLocale": true,
"serviceStatusForHealth": true,
"serviceStatusForStorage": true,
"serviceStatusForTeams": true,
"serviceStatusForUsers": true,
"serviceStatusForSites": true,
"serviceStatusForFunctions": true,
"serviceStatusForGraphql": true,
"serviceStatusForMessaging": true
}
},
"webhook": {
"description": "Webhook",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Webhook ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Webhook creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Webhook update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "Webhook name.",
"x-example": "My Webhook"
},
"url": {
"type": "string",
"description": "Webhook URL endpoint.",
"x-example": "https:\/\/example.com\/webhook"
},
"events": {
"type": "array",
"description": "Webhook trigger events.",
"items": {
"type": "string"
},
"x-example": [
"databases.tables.update",
"databases.collections.update"
]
},
"security": {
"type": "boolean",
"description": "Indicated if SSL \/ TLS Certificate verification is enabled.",
"x-example": true
},
"httpUser": {
"type": "string",
"description": "HTTP basic authentication username.",
"x-example": "username"
},
"httpPass": {
"type": "string",
"description": "HTTP basic authentication password.",
"x-example": "password"
},
"signatureKey": {
"type": "string",
"description": "Signature key which can be used to validated incoming",
"x-example": "ad3d581ca230e2b7059c545e5a"
},
"enabled": {
"type": "boolean",
"description": "Indicates if this webhook is enabled.",
"x-example": true
},
"logs": {
"type": "string",
"description": "Webhook error logs from the most recent failure.",
"x-example": "Failed to connect to remote server."
},
"attempts": {
"type": "integer",
"description": "Number of consecutive failed webhook attempts.",
"x-example": 10,
"format": "int32"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"url",
"events",
"security",
"httpUser",
"httpPass",
"signatureKey",
"enabled",
"logs",
"attempts"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "My Webhook",
"url": "https:\/\/example.com\/webhook",
"events": [
"databases.tables.update",
"databases.collections.update"
],
"security": true,
"httpUser": "username",
"httpPass": "password",
"signatureKey": "ad3d581ca230e2b7059c545e5a",
"enabled": true,
"logs": "Failed to connect to remote server.",
"attempts": 10
}
},
"key": {
"description": "Key",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Key ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Key creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Key update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "Key name.",
"x-example": "My API Key"
},
"expire": {
"type": "string",
"description": "Key expiration date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"scopes": {
"type": "array",
"description": "Allowed permission scopes.",
"items": {
"type": "string"
},
"x-example": "users.read"
},
"secret": {
"type": "string",
"description": "Secret key.",
"x-example": "919c2d18fb5d4...a2ae413da83346ad2"
},
"accessedAt": {
"type": "string",
"description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"sdks": {
"type": "array",
"description": "List of SDK user agents that used this key.",
"items": {
"type": "string"
},
"x-example": "appwrite:flutter"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"expire",
"scopes",
"secret",
"accessedAt",
"sdks"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "My API Key",
"expire": "2020-10-15T06:38:00.000+00:00",
"scopes": "users.read",
"secret": "919c2d18fb5d4...a2ae413da83346ad2",
"accessedAt": "2020-10-15T06:38:00.000+00:00",
"sdks": "appwrite:flutter"
}
},
"devKey": {
"description": "DevKey",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Key ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Key creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Key update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "Key name.",
"x-example": "Dev API Key"
},
"expire": {
"type": "string",
"description": "Key expiration date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"secret": {
"type": "string",
"description": "Secret key.",
"x-example": "919c2d18fb5d4...a2ae413da83346ad2"
},
"accessedAt": {
"type": "string",
"description": "Most recent access date in ISO 8601 format. This attribute is only updated again after 24 hours.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"sdks": {
"type": "array",
"description": "List of SDK user agents that used this key.",
"items": {
"type": "string"
},
"x-example": "appwrite:flutter"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"expire",
"secret",
"accessedAt",
"sdks"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "Dev API Key",
"expire": "2020-10-15T06:38:00.000+00:00",
"secret": "919c2d18fb5d4...a2ae413da83346ad2",
"accessedAt": "2020-10-15T06:38:00.000+00:00",
"sdks": "appwrite:flutter"
}
},
"mockNumber": {
"description": "Mock Number",
"type": "object",
"properties": {
"phone": {
"type": "string",
"description": "Mock phone number for testing phone authentication. Useful for testing phone authentication without sending an SMS.",
"x-example": "+1612842323"
},
"otp": {
"type": "string",
"description": "Mock OTP for the number. ",
"x-example": "123456"
}
},
"required": [
"phone",
"otp"
],
"example": {
"phone": "+1612842323",
"otp": "123456"
}
},
"authProvider": {
"description": "AuthProvider",
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Auth Provider.",
"x-example": "github"
},
"name": {
"type": "string",
"description": "Auth Provider name.",
"x-example": "GitHub"
},
"appId": {
"type": "string",
"description": "OAuth 2.0 application ID.",
"x-example": "259125845563242502"
},
"secret": {
"type": "string",
"description": "OAuth 2.0 application secret. Might be JSON string if provider requires extra configuration.",
"x-example": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ"
},
"enabled": {
"type": "boolean",
"description": "Auth Provider is active and can be used to create session.",
"x-example": ""
}
},
"required": [
"key",
"name",
"appId",
"secret",
"enabled"
],
"example": {
"key": "github",
"name": "GitHub",
"appId": "259125845563242502",
"secret": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ",
"enabled": ""
}
},
"platform": {
"description": "Platform",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Platform ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Platform creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Platform update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "Platform name.",
"x-example": "My Web App"
},
"type": {
"type": "string",
"description": "Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, flutter-linux, flutter-macos, flutter-windows, apple-ios, apple-macos, apple-watchos, apple-tvos, android, unity, react-native-ios, react-native-android.",
"x-example": "web",
"enum": [
"web",
"flutter-web",
"flutter-ios",
"flutter-android",
"flutter-linux",
"flutter-macos",
"flutter-windows",
"apple-ios",
"apple-macos",
"apple-watchos",
"apple-tvos",
"android",
"unity",
"react-native-ios",
"react-native-android"
]
},
"key": {
"type": "string",
"description": "Platform Key. iOS bundle ID or Android package name. Empty string for other platforms.",
"x-example": "com.company.appname"
},
"store": {
"type": "string",
"description": "App store or Google Play store ID.",
"x-example": ""
},
"hostname": {
"type": "string",
"description": "Web app hostname. Empty string for other platforms.",
"x-example": "app.example.com"
},
"httpUser": {
"type": "string",
"description": "HTTP basic authentication username.",
"x-example": "username"
},
"httpPass": {
"type": "string",
"description": "HTTP basic authentication password.",
"x-example": "password"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"type",
"key",
"store",
"hostname",
"httpUser",
"httpPass"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "My Web App",
"type": "web",
"key": "com.company.appname",
"store": "",
"hostname": "app.example.com",
"httpUser": "username",
"httpPass": "password"
}
},
"variable": {
"description": "Variable",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Variable ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Variable creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Variable creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"key": {
"type": "string",
"description": "Variable key.",
"x-example": "API_KEY"
},
"value": {
"type": "string",
"description": "Variable value.",
"x-example": "myPa$$word1"
},
"secret": {
"type": "boolean",
"description": "Variable secret flag. Secret variables can only be updated or deleted, but never read.",
"x-example": false
},
"resourceType": {
"type": "string",
"description": "Service to which the variable belongs. Possible values are \"project\", \"function\"",
"x-example": "function"
},
"resourceId": {
"type": "string",
"description": "ID of resource to which the variable belongs. If resourceType is \"project\", it is empty. If resourceType is \"function\", it is ID of the function.",
"x-example": "myAwesomeFunction"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"key",
"value",
"secret",
"resourceType",
"resourceId"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"key": "API_KEY",
"value": "myPa$$word1",
"secret": false,
"resourceType": "function",
"resourceId": "myAwesomeFunction"
}
},
"country": {
"description": "Country",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Country name.",
"x-example": "United States"
},
"code": {
"type": "string",
"description": "Country two-character ISO 3166-1 alpha code.",
"x-example": "US"
}
},
"required": [
"name",
"code"
],
"example": {
"name": "United States",
"code": "US"
}
},
"continent": {
"description": "Continent",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Continent name.",
"x-example": "Europe"
},
"code": {
"type": "string",
"description": "Continent two letter code.",
"x-example": "EU"
}
},
"required": [
"name",
"code"
],
"example": {
"name": "Europe",
"code": "EU"
}
},
"language": {
"description": "Language",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Language name.",
"x-example": "Italian"
},
"code": {
"type": "string",
"description": "Language two-character ISO 639-1 codes.",
"x-example": "it"
},
"nativeName": {
"type": "string",
"description": "Language native name.",
"x-example": "Italiano"
}
},
"required": [
"name",
"code",
"nativeName"
],
"example": {
"name": "Italian",
"code": "it",
"nativeName": "Italiano"
}
},
"currency": {
"description": "Currency",
"type": "object",
"properties": {
"symbol": {
"type": "string",
"description": "Currency symbol.",
"x-example": "$"
},
"name": {
"type": "string",
"description": "Currency name.",
"x-example": "US dollar"
},
"symbolNative": {
"type": "string",
"description": "Currency native symbol.",
"x-example": "$"
},
"decimalDigits": {
"type": "integer",
"description": "Number of decimal digits.",
"x-example": 2,
"format": "int32"
},
"rounding": {
"type": "number",
"description": "Currency digit rounding.",
"x-example": 0,
"format": "double"
},
"code": {
"type": "string",
"description": "Currency code in [ISO 4217-1](http:\/\/en.wikipedia.org\/wiki\/ISO_4217) three-character format.",
"x-example": "USD"
},
"namePlural": {
"type": "string",
"description": "Currency plural name",
"x-example": "US dollars"
}
},
"required": [
"symbol",
"name",
"symbolNative",
"decimalDigits",
"rounding",
"code",
"namePlural"
],
"example": {
"symbol": "$",
"name": "US dollar",
"symbolNative": "$",
"decimalDigits": 2,
"rounding": 0,
"code": "USD",
"namePlural": "US dollars"
}
},
"phone": {
"description": "Phone",
"type": "object",
"properties": {
"code": {
"type": "string",
"description": "Phone code.",
"x-example": "+1"
},
"countryCode": {
"type": "string",
"description": "Country two-character ISO 3166-1 alpha code.",
"x-example": "US"
},
"countryName": {
"type": "string",
"description": "Country name.",
"x-example": "United States"
}
},
"required": [
"code",
"countryCode",
"countryName"
],
"example": {
"code": "+1",
"countryCode": "US",
"countryName": "United States"
}
},
"healthAntivirus": {
"description": "Health Antivirus",
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "Antivirus version.",
"x-example": "1.0.0"
},
"status": {
"type": "string",
"description": "Antivirus status. Possible values are: `disabled`, `offline`, `online`",
"x-example": "online",
"enum": [
"disabled",
"offline",
"online"
]
}
},
"required": [
"version",
"status"
],
"example": {
"version": "1.0.0",
"status": "online"
}
},
"healthQueue": {
"description": "Health Queue",
"type": "object",
"properties": {
"size": {
"type": "integer",
"description": "Amount of actions in the queue.",
"x-example": 8,
"format": "int32"
}
},
"required": [
"size"
],
"example": {
"size": 8
}
},
"healthStatus": {
"description": "Health Status",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the service.",
"x-example": "database"
},
"ping": {
"type": "integer",
"description": "Duration in milliseconds how long the health check took.",
"x-example": 128,
"format": "int32"
},
"status": {
"type": "string",
"description": "Service status. Possible values are: `pass`, `fail`",
"x-example": "pass",
"enum": [
"pass",
"fail"
],
"x-enum-name": "HealthCheckStatus"
}
},
"required": [
"name",
"ping",
"status"
],
"example": {
"name": "database",
"ping": 128,
"status": "pass"
}
},
"healthCertificate": {
"description": "Health Certificate",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Certificate name",
"x-example": "\/CN=www.google.com"
},
"subjectSN": {
"type": "string",
"description": "Subject SN",
"x-example": ""
},
"issuerOrganisation": {
"type": "string",
"description": "Issuer organisation",
"x-example": ""
},
"validFrom": {
"type": "string",
"description": "Valid from",
"x-example": "1704200998"
},
"validTo": {
"type": "string",
"description": "Valid to",
"x-example": "1711458597"
},
"signatureTypeSN": {
"type": "string",
"description": "Signature type SN",
"x-example": "RSA-SHA256"
}
},
"required": [
"name",
"subjectSN",
"issuerOrganisation",
"validFrom",
"validTo",
"signatureTypeSN"
],
"example": {
"name": "\/CN=www.google.com",
"subjectSN": "",
"issuerOrganisation": "",
"validFrom": "1704200998",
"validTo": "1711458597",
"signatureTypeSN": "RSA-SHA256"
}
},
"healthTime": {
"description": "Health Time",
"type": "object",
"properties": {
"remoteTime": {
"type": "integer",
"description": "Current unix timestamp on trustful remote server.",
"x-example": 1639490751,
"format": "int32"
},
"localTime": {
"type": "integer",
"description": "Current unix timestamp of local server where Appwrite runs.",
"x-example": 1639490844,
"format": "int32"
},
"diff": {
"type": "integer",
"description": "Difference of unix remote and local timestamps in milliseconds.",
"x-example": 93,
"format": "int32"
}
},
"required": [
"remoteTime",
"localTime",
"diff"
],
"example": {
"remoteTime": 1639490751,
"localTime": 1639490844,
"diff": 93
}
},
"metric": {
"description": "Metric",
"type": "object",
"properties": {
"value": {
"type": "integer",
"description": "The value of this metric at the timestamp.",
"x-example": 1,
"format": "int32"
},
"date": {
"type": "string",
"description": "The date at which this metric was aggregated in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
}
},
"required": [
"value",
"date"
],
"example": {
"value": 1,
"date": "2020-10-15T06:38:00.000+00:00"
}
},
"metricBreakdown": {
"description": "Metric Breakdown",
"type": "object",
"properties": {
"resourceId": {
"type": "string",
"description": "Resource ID.",
"x-example": "5e5ea5c16897e",
"nullable": true
},
"name": {
"type": "string",
"description": "Resource name.",
"x-example": "Documents"
},
"value": {
"type": "integer",
"description": "The value of this metric at the timestamp.",
"x-example": 1,
"format": "int32"
},
"estimate": {
"type": "number",
"description": "The estimated value of this metric at the end of the period.",
"x-example": 1,
"format": "double",
"nullable": true
}
},
"required": [
"name",
"value"
],
"example": {
"resourceId": "5e5ea5c16897e",
"name": "Documents",
"value": 1,
"estimate": 1
}
},
"usageDatabases": {
"description": "UsageDatabases",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "Time range of the usage stats.",
"x-example": "30d"
},
"databasesTotal": {
"type": "integer",
"description": "Total aggregated number of databases.",
"x-example": 0,
"format": "int32"
},
"collectionsTotal": {
"type": "integer",
"description": "Total aggregated number of collections.",
"x-example": 0,
"format": "int32"
},
"tablesTotal": {
"type": "integer",
"description": "Total aggregated number of tables.",
"x-example": 0,
"format": "int32"
},
"documentsTotal": {
"type": "integer",
"description": "Total aggregated number of documents.",
"x-example": 0,
"format": "int32"
},
"rowsTotal": {
"type": "integer",
"description": "Total aggregated number of rows.",
"x-example": 0,
"format": "int32"
},
"storageTotal": {
"type": "integer",
"description": "Total aggregated number of total databases storage in bytes.",
"x-example": 0,
"format": "int32"
},
"databasesReadsTotal": {
"type": "integer",
"description": "Total number of databases reads.",
"x-example": 0,
"format": "int32"
},
"databasesWritesTotal": {
"type": "integer",
"description": "Total number of databases writes.",
"x-example": 0,
"format": "int32"
},
"databases": {
"type": "array",
"description": "Aggregated number of databases per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"collections": {
"type": "array",
"description": "Aggregated number of collections per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"tables": {
"type": "array",
"description": "Aggregated number of tables per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"documents": {
"type": "array",
"description": "Aggregated number of documents per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"rows": {
"type": "array",
"description": "Aggregated number of rows per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"storage": {
"type": "array",
"description": "An array of the aggregated number of databases storage in bytes per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"databasesReads": {
"type": "array",
"description": "An array of aggregated number of database reads.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"databasesWrites": {
"type": "array",
"description": "An array of aggregated number of database writes.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
}
},
"required": [
"range",
"databasesTotal",
"collectionsTotal",
"tablesTotal",
"documentsTotal",
"rowsTotal",
"storageTotal",
"databasesReadsTotal",
"databasesWritesTotal",
"databases",
"collections",
"tables",
"documents",
"rows",
"storage",
"databasesReads",
"databasesWrites"
],
"example": {
"range": "30d",
"databasesTotal": 0,
"collectionsTotal": 0,
"tablesTotal": 0,
"documentsTotal": 0,
"rowsTotal": 0,
"storageTotal": 0,
"databasesReadsTotal": 0,
"databasesWritesTotal": 0,
"databases": [],
"collections": [],
"tables": [],
"documents": [],
"rows": [],
"storage": [],
"databasesReads": [],
"databasesWrites": []
}
},
"usageDatabase": {
"description": "UsageDatabase",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "Time range of the usage stats.",
"x-example": "30d"
},
"collectionsTotal": {
"type": "integer",
"description": "Total aggregated number of collections.",
"x-example": 0,
"format": "int32"
},
"tablesTotal": {
"type": "integer",
"description": "Total aggregated number of tables.",
"x-example": 0,
"format": "int32"
},
"documentsTotal": {
"type": "integer",
"description": "Total aggregated number of documents.",
"x-example": 0,
"format": "int32"
},
"rowsTotal": {
"type": "integer",
"description": "Total aggregated number of rows.",
"x-example": 0,
"format": "int32"
},
"storageTotal": {
"type": "integer",
"description": "Total aggregated number of total storage used in bytes.",
"x-example": 0,
"format": "int32"
},
"databaseReadsTotal": {
"type": "integer",
"description": "Total number of databases reads.",
"x-example": 0,
"format": "int32"
},
"databaseWritesTotal": {
"type": "integer",
"description": "Total number of databases writes.",
"x-example": 0,
"format": "int32"
},
"collections": {
"type": "array",
"description": "Aggregated number of collections per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"tables": {
"type": "array",
"description": "Aggregated number of tables per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"documents": {
"type": "array",
"description": "Aggregated number of documents per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"rows": {
"type": "array",
"description": "Aggregated number of rows per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"storage": {
"type": "array",
"description": "Aggregated storage used in bytes per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"databaseReads": {
"type": "array",
"description": "An array of aggregated number of database reads.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"databaseWrites": {
"type": "array",
"description": "An array of aggregated number of database writes.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
}
},
"required": [
"range",
"collectionsTotal",
"tablesTotal",
"documentsTotal",
"rowsTotal",
"storageTotal",
"databaseReadsTotal",
"databaseWritesTotal",
"collections",
"tables",
"documents",
"rows",
"storage",
"databaseReads",
"databaseWrites"
],
"example": {
"range": "30d",
"collectionsTotal": 0,
"tablesTotal": 0,
"documentsTotal": 0,
"rowsTotal": 0,
"storageTotal": 0,
"databaseReadsTotal": 0,
"databaseWritesTotal": 0,
"collections": [],
"tables": [],
"documents": [],
"rows": [],
"storage": [],
"databaseReads": [],
"databaseWrites": []
}
},
"usageTable": {
"description": "UsageTable",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "Time range of the usage stats.",
"x-example": "30d"
},
"rowsTotal": {
"type": "integer",
"description": "Total aggregated number of of rows.",
"x-example": 0,
"format": "int32"
},
"rows": {
"type": "array",
"description": "Aggregated number of rows per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
}
},
"required": [
"range",
"rowsTotal",
"rows"
],
"example": {
"range": "30d",
"rowsTotal": 0,
"rows": []
}
},
"usageCollection": {
"description": "UsageCollection",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "Time range of the usage stats.",
"x-example": "30d"
},
"documentsTotal": {
"type": "integer",
"description": "Total aggregated number of of documents.",
"x-example": 0,
"format": "int32"
},
"documents": {
"type": "array",
"description": "Aggregated number of documents per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
}
},
"required": [
"range",
"documentsTotal",
"documents"
],
"example": {
"range": "30d",
"documentsTotal": 0,
"documents": []
}
},
"usageUsers": {
"description": "UsageUsers",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "Time range of the usage stats.",
"x-example": "30d"
},
"usersTotal": {
"type": "integer",
"description": "Total aggregated number of statistics of users.",
"x-example": 0,
"format": "int32"
},
"sessionsTotal": {
"type": "integer",
"description": "Total aggregated number of active sessions.",
"x-example": 0,
"format": "int32"
},
"users": {
"type": "array",
"description": "Aggregated number of users per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"sessions": {
"type": "array",
"description": "Aggregated number of active sessions per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
}
},
"required": [
"range",
"usersTotal",
"sessionsTotal",
"users",
"sessions"
],
"example": {
"range": "30d",
"usersTotal": 0,
"sessionsTotal": 0,
"users": [],
"sessions": []
}
},
"usageStorage": {
"description": "StorageUsage",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "Time range of the usage stats.",
"x-example": "30d"
},
"bucketsTotal": {
"type": "integer",
"description": "Total aggregated number of buckets",
"x-example": 0,
"format": "int32"
},
"filesTotal": {
"type": "integer",
"description": "Total aggregated number of files.",
"x-example": 0,
"format": "int32"
},
"filesStorageTotal": {
"type": "integer",
"description": "Total aggregated number of files storage (in bytes).",
"x-example": 0,
"format": "int32"
},
"buckets": {
"type": "array",
"description": "Aggregated number of buckets per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"files": {
"type": "array",
"description": "Aggregated number of files per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"storage": {
"type": "array",
"description": "Aggregated number of files storage (in bytes) per period .",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
}
},
"required": [
"range",
"bucketsTotal",
"filesTotal",
"filesStorageTotal",
"buckets",
"files",
"storage"
],
"example": {
"range": "30d",
"bucketsTotal": 0,
"filesTotal": 0,
"filesStorageTotal": 0,
"buckets": [],
"files": [],
"storage": []
}
},
"usageBuckets": {
"description": "UsageBuckets",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "Time range of the usage stats.",
"x-example": "30d"
},
"filesTotal": {
"type": "integer",
"description": "Total aggregated number of bucket files.",
"x-example": 0,
"format": "int32"
},
"filesStorageTotal": {
"type": "integer",
"description": "Total aggregated number of bucket files storage (in bytes).",
"x-example": 0,
"format": "int32"
},
"files": {
"type": "array",
"description": "Aggregated number of bucket files per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"storage": {
"type": "array",
"description": "Aggregated number of bucket storage files (in bytes) per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"imageTransformations": {
"type": "array",
"description": "Aggregated number of files transformations per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"imageTransformationsTotal": {
"type": "integer",
"description": "Total aggregated number of files transformations.",
"x-example": 0,
"format": "int32"
}
},
"required": [
"range",
"filesTotal",
"filesStorageTotal",
"files",
"storage",
"imageTransformations",
"imageTransformationsTotal"
],
"example": {
"range": "30d",
"filesTotal": 0,
"filesStorageTotal": 0,
"files": [],
"storage": [],
"imageTransformations": [],
"imageTransformationsTotal": 0
}
},
"usageFunctions": {
"description": "UsageFunctions",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "Time range of the usage stats.",
"x-example": "30d"
},
"functionsTotal": {
"type": "integer",
"description": "Total aggregated number of functions.",
"x-example": 0,
"format": "int32"
},
"deploymentsTotal": {
"type": "integer",
"description": "Total aggregated number of functions deployments.",
"x-example": 0,
"format": "int32"
},
"deploymentsStorageTotal": {
"type": "integer",
"description": "Total aggregated sum of functions deployment storage.",
"x-example": 0,
"format": "int32"
},
"buildsTotal": {
"type": "integer",
"description": "Total aggregated number of functions build.",
"x-example": 0,
"format": "int32"
},
"buildsStorageTotal": {
"type": "integer",
"description": "total aggregated sum of functions build storage.",
"x-example": 0,
"format": "int32"
},
"buildsTimeTotal": {
"type": "integer",
"description": "Total aggregated sum of functions build compute time.",
"x-example": 0,
"format": "int32"
},
"buildsMbSecondsTotal": {
"type": "integer",
"description": "Total aggregated sum of functions build mbSeconds.",
"x-example": 0,
"format": "int32"
},
"executionsTotal": {
"type": "integer",
"description": "Total aggregated number of functions execution.",
"x-example": 0,
"format": "int32"
},
"executionsTimeTotal": {
"type": "integer",
"description": "Total aggregated sum of functions execution compute time.",
"x-example": 0,
"format": "int32"
},
"executionsMbSecondsTotal": {
"type": "integer",
"description": "Total aggregated sum of functions execution mbSeconds.",
"x-example": 0,
"format": "int32"
},
"functions": {
"type": "array",
"description": "Aggregated number of functions per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": 0
},
"deployments": {
"type": "array",
"description": "Aggregated number of functions deployment per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"deploymentsStorage": {
"type": "array",
"description": "Aggregated number of functions deployment storage per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsSuccessTotal": {
"type": "integer",
"description": "Total aggregated number of successful function builds.",
"x-example": 0,
"format": "int32"
},
"buildsFailedTotal": {
"type": "integer",
"description": "Total aggregated number of failed function builds.",
"x-example": 0,
"format": "int32"
},
"builds": {
"type": "array",
"description": "Aggregated number of functions build per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsStorage": {
"type": "array",
"description": "Aggregated sum of functions build storage per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsTime": {
"type": "array",
"description": "Aggregated sum of functions build compute time per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsMbSeconds": {
"type": "array",
"description": "Aggregated sum of functions build mbSeconds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executions": {
"type": "array",
"description": "Aggregated number of functions execution per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executionsTime": {
"type": "array",
"description": "Aggregated number of functions execution compute time per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executionsMbSeconds": {
"type": "array",
"description": "Aggregated number of functions mbSeconds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsSuccess": {
"type": "array",
"description": "Aggregated number of successful function builds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsFailed": {
"type": "array",
"description": "Aggregated number of failed function builds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
}
},
"required": [
"range",
"functionsTotal",
"deploymentsTotal",
"deploymentsStorageTotal",
"buildsTotal",
"buildsStorageTotal",
"buildsTimeTotal",
"buildsMbSecondsTotal",
"executionsTotal",
"executionsTimeTotal",
"executionsMbSecondsTotal",
"functions",
"deployments",
"deploymentsStorage",
"buildsSuccessTotal",
"buildsFailedTotal",
"builds",
"buildsStorage",
"buildsTime",
"buildsMbSeconds",
"executions",
"executionsTime",
"executionsMbSeconds",
"buildsSuccess",
"buildsFailed"
],
"example": {
"range": "30d",
"functionsTotal": 0,
"deploymentsTotal": 0,
"deploymentsStorageTotal": 0,
"buildsTotal": 0,
"buildsStorageTotal": 0,
"buildsTimeTotal": 0,
"buildsMbSecondsTotal": 0,
"executionsTotal": 0,
"executionsTimeTotal": 0,
"executionsMbSecondsTotal": 0,
"functions": 0,
"deployments": [],
"deploymentsStorage": [],
"buildsSuccessTotal": 0,
"buildsFailedTotal": 0,
"builds": [],
"buildsStorage": [],
"buildsTime": [],
"buildsMbSeconds": [],
"executions": [],
"executionsTime": [],
"executionsMbSeconds": [],
"buildsSuccess": [],
"buildsFailed": []
}
},
"usageFunction": {
"description": "UsageFunction",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "The time range of the usage stats.",
"x-example": "30d"
},
"deploymentsTotal": {
"type": "integer",
"description": "Total aggregated number of function deployments.",
"x-example": 0,
"format": "int32"
},
"deploymentsStorageTotal": {
"type": "integer",
"description": "Total aggregated sum of function deployments storage.",
"x-example": 0,
"format": "int32"
},
"buildsTotal": {
"type": "integer",
"description": "Total aggregated number of function builds.",
"x-example": 0,
"format": "int32"
},
"buildsSuccessTotal": {
"type": "integer",
"description": "Total aggregated number of successful function builds.",
"x-example": 0,
"format": "int32"
},
"buildsFailedTotal": {
"type": "integer",
"description": "Total aggregated number of failed function builds.",
"x-example": 0,
"format": "int32"
},
"buildsStorageTotal": {
"type": "integer",
"description": "total aggregated sum of function builds storage.",
"x-example": 0,
"format": "int32"
},
"buildsTimeTotal": {
"type": "integer",
"description": "Total aggregated sum of function builds compute time.",
"x-example": 0,
"format": "int32"
},
"buildsTimeAverage": {
"type": "integer",
"description": "Average builds compute time.",
"x-example": 0,
"format": "int32"
},
"buildsMbSecondsTotal": {
"type": "integer",
"description": "Total aggregated sum of function builds mbSeconds.",
"x-example": 0,
"format": "int32"
},
"executionsTotal": {
"type": "integer",
"description": "Total aggregated number of function executions.",
"x-example": 0,
"format": "int32"
},
"executionsTimeTotal": {
"type": "integer",
"description": "Total aggregated sum of function executions compute time.",
"x-example": 0,
"format": "int32"
},
"executionsMbSecondsTotal": {
"type": "integer",
"description": "Total aggregated sum of function executions mbSeconds.",
"x-example": 0,
"format": "int32"
},
"deployments": {
"type": "array",
"description": "Aggregated number of function deployments per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"deploymentsStorage": {
"type": "array",
"description": "Aggregated number of function deployments storage per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"builds": {
"type": "array",
"description": "Aggregated number of function builds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsStorage": {
"type": "array",
"description": "Aggregated sum of function builds storage per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsTime": {
"type": "array",
"description": "Aggregated sum of function builds compute time per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsMbSeconds": {
"type": "array",
"description": "Aggregated number of function builds mbSeconds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executions": {
"type": "array",
"description": "Aggregated number of function executions per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executionsTime": {
"type": "array",
"description": "Aggregated number of function executions compute time per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executionsMbSeconds": {
"type": "array",
"description": "Aggregated number of function mbSeconds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsSuccess": {
"type": "array",
"description": "Aggregated number of successful builds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsFailed": {
"type": "array",
"description": "Aggregated number of failed builds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
}
},
"required": [
"range",
"deploymentsTotal",
"deploymentsStorageTotal",
"buildsTotal",
"buildsSuccessTotal",
"buildsFailedTotal",
"buildsStorageTotal",
"buildsTimeTotal",
"buildsTimeAverage",
"buildsMbSecondsTotal",
"executionsTotal",
"executionsTimeTotal",
"executionsMbSecondsTotal",
"deployments",
"deploymentsStorage",
"builds",
"buildsStorage",
"buildsTime",
"buildsMbSeconds",
"executions",
"executionsTime",
"executionsMbSeconds",
"buildsSuccess",
"buildsFailed"
],
"example": {
"range": "30d",
"deploymentsTotal": 0,
"deploymentsStorageTotal": 0,
"buildsTotal": 0,
"buildsSuccessTotal": 0,
"buildsFailedTotal": 0,
"buildsStorageTotal": 0,
"buildsTimeTotal": 0,
"buildsTimeAverage": 0,
"buildsMbSecondsTotal": 0,
"executionsTotal": 0,
"executionsTimeTotal": 0,
"executionsMbSecondsTotal": 0,
"deployments": [],
"deploymentsStorage": [],
"builds": [],
"buildsStorage": [],
"buildsTime": [],
"buildsMbSeconds": [],
"executions": [],
"executionsTime": [],
"executionsMbSeconds": [],
"buildsSuccess": [],
"buildsFailed": []
}
},
"usageSites": {
"description": "UsageSites",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "Time range of the usage stats.",
"x-example": "30d"
},
"sitesTotal": {
"type": "integer",
"description": "Total aggregated number of sites.",
"x-example": 0,
"format": "int32"
},
"sites": {
"type": "array",
"description": "Aggregated number of sites per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"deploymentsTotal": {
"type": "integer",
"description": "Total aggregated number of sites deployments.",
"x-example": 0,
"format": "int32"
},
"deploymentsStorageTotal": {
"type": "integer",
"description": "Total aggregated sum of sites deployment storage.",
"x-example": 0,
"format": "int32"
},
"buildsTotal": {
"type": "integer",
"description": "Total aggregated number of sites build.",
"x-example": 0,
"format": "int32"
},
"buildsStorageTotal": {
"type": "integer",
"description": "total aggregated sum of sites build storage.",
"x-example": 0,
"format": "int32"
},
"buildsTimeTotal": {
"type": "integer",
"description": "Total aggregated sum of sites build compute time.",
"x-example": 0,
"format": "int32"
},
"buildsMbSecondsTotal": {
"type": "integer",
"description": "Total aggregated sum of sites build mbSeconds.",
"x-example": 0,
"format": "int32"
},
"executionsTotal": {
"type": "integer",
"description": "Total aggregated number of sites execution.",
"x-example": 0,
"format": "int32"
},
"executionsTimeTotal": {
"type": "integer",
"description": "Total aggregated sum of sites execution compute time.",
"x-example": 0,
"format": "int32"
},
"executionsMbSecondsTotal": {
"type": "integer",
"description": "Total aggregated sum of sites execution mbSeconds.",
"x-example": 0,
"format": "int32"
},
"requestsTotal": {
"type": "integer",
"description": "Total aggregated number of requests.",
"x-example": 0,
"format": "int32"
},
"requests": {
"type": "array",
"description": "Aggregated number of requests per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"inboundTotal": {
"type": "integer",
"description": "Total aggregated inbound bandwidth.",
"x-example": 0,
"format": "int32"
},
"inbound": {
"type": "array",
"description": "Aggregated number of inbound bandwidth per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"outboundTotal": {
"type": "integer",
"description": "Total aggregated outbound bandwidth.",
"x-example": 0,
"format": "int32"
},
"outbound": {
"type": "array",
"description": "Aggregated number of outbound bandwidth per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"deployments": {
"type": "array",
"description": "Aggregated number of sites deployment per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"deploymentsStorage": {
"type": "array",
"description": "Aggregated number of sites deployment storage per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsSuccessTotal": {
"type": "integer",
"description": "Total aggregated number of successful site builds.",
"x-example": 0,
"format": "int32"
},
"buildsFailedTotal": {
"type": "integer",
"description": "Total aggregated number of failed site builds.",
"x-example": 0,
"format": "int32"
},
"builds": {
"type": "array",
"description": "Aggregated number of sites build per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsStorage": {
"type": "array",
"description": "Aggregated sum of sites build storage per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsTime": {
"type": "array",
"description": "Aggregated sum of sites build compute time per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsMbSeconds": {
"type": "array",
"description": "Aggregated sum of sites build mbSeconds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executions": {
"type": "array",
"description": "Aggregated number of sites execution per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executionsTime": {
"type": "array",
"description": "Aggregated number of sites execution compute time per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executionsMbSeconds": {
"type": "array",
"description": "Aggregated number of sites mbSeconds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsSuccess": {
"type": "array",
"description": "Aggregated number of successful site builds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsFailed": {
"type": "array",
"description": "Aggregated number of failed site builds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
}
},
"required": [
"range",
"sitesTotal",
"sites",
"deploymentsTotal",
"deploymentsStorageTotal",
"buildsTotal",
"buildsStorageTotal",
"buildsTimeTotal",
"buildsMbSecondsTotal",
"executionsTotal",
"executionsTimeTotal",
"executionsMbSecondsTotal",
"requestsTotal",
"requests",
"inboundTotal",
"inbound",
"outboundTotal",
"outbound",
"deployments",
"deploymentsStorage",
"buildsSuccessTotal",
"buildsFailedTotal",
"builds",
"buildsStorage",
"buildsTime",
"buildsMbSeconds",
"executions",
"executionsTime",
"executionsMbSeconds",
"buildsSuccess",
"buildsFailed"
],
"example": {
"range": "30d",
"sitesTotal": 0,
"sites": [],
"deploymentsTotal": 0,
"deploymentsStorageTotal": 0,
"buildsTotal": 0,
"buildsStorageTotal": 0,
"buildsTimeTotal": 0,
"buildsMbSecondsTotal": 0,
"executionsTotal": 0,
"executionsTimeTotal": 0,
"executionsMbSecondsTotal": 0,
"requestsTotal": 0,
"requests": [],
"inboundTotal": 0,
"inbound": [],
"outboundTotal": 0,
"outbound": [],
"deployments": [],
"deploymentsStorage": [],
"buildsSuccessTotal": 0,
"buildsFailedTotal": 0,
"builds": [],
"buildsStorage": [],
"buildsTime": [],
"buildsMbSeconds": [],
"executions": [],
"executionsTime": [],
"executionsMbSeconds": [],
"buildsSuccess": [],
"buildsFailed": []
}
},
"usageSite": {
"description": "UsageSite",
"type": "object",
"properties": {
"range": {
"type": "string",
"description": "The time range of the usage stats.",
"x-example": "30d"
},
"deploymentsTotal": {
"type": "integer",
"description": "Total aggregated number of function deployments.",
"x-example": 0,
"format": "int32"
},
"deploymentsStorageTotal": {
"type": "integer",
"description": "Total aggregated sum of function deployments storage.",
"x-example": 0,
"format": "int32"
},
"buildsTotal": {
"type": "integer",
"description": "Total aggregated number of function builds.",
"x-example": 0,
"format": "int32"
},
"buildsSuccessTotal": {
"type": "integer",
"description": "Total aggregated number of successful function builds.",
"x-example": 0,
"format": "int32"
},
"buildsFailedTotal": {
"type": "integer",
"description": "Total aggregated number of failed function builds.",
"x-example": 0,
"format": "int32"
},
"buildsStorageTotal": {
"type": "integer",
"description": "total aggregated sum of function builds storage.",
"x-example": 0,
"format": "int32"
},
"buildsTimeTotal": {
"type": "integer",
"description": "Total aggregated sum of function builds compute time.",
"x-example": 0,
"format": "int32"
},
"buildsTimeAverage": {
"type": "integer",
"description": "Average builds compute time.",
"x-example": 0,
"format": "int32"
},
"buildsMbSecondsTotal": {
"type": "integer",
"description": "Total aggregated sum of function builds mbSeconds.",
"x-example": 0,
"format": "int32"
},
"executionsTotal": {
"type": "integer",
"description": "Total aggregated number of function executions.",
"x-example": 0,
"format": "int32"
},
"executionsTimeTotal": {
"type": "integer",
"description": "Total aggregated sum of function executions compute time.",
"x-example": 0,
"format": "int32"
},
"executionsMbSecondsTotal": {
"type": "integer",
"description": "Total aggregated sum of function executions mbSeconds.",
"x-example": 0,
"format": "int32"
},
"deployments": {
"type": "array",
"description": "Aggregated number of function deployments per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"deploymentsStorage": {
"type": "array",
"description": "Aggregated number of function deployments storage per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"builds": {
"type": "array",
"description": "Aggregated number of function builds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsStorage": {
"type": "array",
"description": "Aggregated sum of function builds storage per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsTime": {
"type": "array",
"description": "Aggregated sum of function builds compute time per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsMbSeconds": {
"type": "array",
"description": "Aggregated number of function builds mbSeconds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executions": {
"type": "array",
"description": "Aggregated number of function executions per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executionsTime": {
"type": "array",
"description": "Aggregated number of function executions compute time per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executionsMbSeconds": {
"type": "array",
"description": "Aggregated number of function mbSeconds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsSuccess": {
"type": "array",
"description": "Aggregated number of successful builds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"buildsFailed": {
"type": "array",
"description": "Aggregated number of failed builds per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"requestsTotal": {
"type": "integer",
"description": "Total aggregated number of requests.",
"x-example": 0,
"format": "int32"
},
"requests": {
"type": "array",
"description": "Aggregated number of requests per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"inboundTotal": {
"type": "integer",
"description": "Total aggregated inbound bandwidth.",
"x-example": 0,
"format": "int32"
},
"inbound": {
"type": "array",
"description": "Aggregated number of inbound bandwidth per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"outboundTotal": {
"type": "integer",
"description": "Total aggregated outbound bandwidth.",
"x-example": 0,
"format": "int32"
},
"outbound": {
"type": "array",
"description": "Aggregated number of outbound bandwidth per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
}
},
"required": [
"range",
"deploymentsTotal",
"deploymentsStorageTotal",
"buildsTotal",
"buildsSuccessTotal",
"buildsFailedTotal",
"buildsStorageTotal",
"buildsTimeTotal",
"buildsTimeAverage",
"buildsMbSecondsTotal",
"executionsTotal",
"executionsTimeTotal",
"executionsMbSecondsTotal",
"deployments",
"deploymentsStorage",
"builds",
"buildsStorage",
"buildsTime",
"buildsMbSeconds",
"executions",
"executionsTime",
"executionsMbSeconds",
"buildsSuccess",
"buildsFailed",
"requestsTotal",
"requests",
"inboundTotal",
"inbound",
"outboundTotal",
"outbound"
],
"example": {
"range": "30d",
"deploymentsTotal": 0,
"deploymentsStorageTotal": 0,
"buildsTotal": 0,
"buildsSuccessTotal": 0,
"buildsFailedTotal": 0,
"buildsStorageTotal": 0,
"buildsTimeTotal": 0,
"buildsTimeAverage": 0,
"buildsMbSecondsTotal": 0,
"executionsTotal": 0,
"executionsTimeTotal": 0,
"executionsMbSecondsTotal": 0,
"deployments": [],
"deploymentsStorage": [],
"builds": [],
"buildsStorage": [],
"buildsTime": [],
"buildsMbSeconds": [],
"executions": [],
"executionsTime": [],
"executionsMbSeconds": [],
"buildsSuccess": [],
"buildsFailed": [],
"requestsTotal": 0,
"requests": [],
"inboundTotal": 0,
"inbound": [],
"outboundTotal": 0,
"outbound": []
}
},
"usageProject": {
"description": "UsageProject",
"type": "object",
"properties": {
"executionsTotal": {
"type": "integer",
"description": "Total aggregated number of function executions.",
"x-example": 0,
"format": "int32"
},
"documentsTotal": {
"type": "integer",
"description": "Total aggregated number of documents.",
"x-example": 0,
"format": "int32"
},
"rowsTotal": {
"type": "integer",
"description": "Total aggregated number of rows.",
"x-example": 0,
"format": "int32"
},
"databasesTotal": {
"type": "integer",
"description": "Total aggregated number of databases.",
"x-example": 0,
"format": "int32"
},
"databasesStorageTotal": {
"type": "integer",
"description": "Total aggregated sum of databases storage size (in bytes).",
"x-example": 0,
"format": "int32"
},
"usersTotal": {
"type": "integer",
"description": "Total aggregated number of users.",
"x-example": 0,
"format": "int32"
},
"filesStorageTotal": {
"type": "integer",
"description": "Total aggregated sum of files storage size (in bytes).",
"x-example": 0,
"format": "int32"
},
"functionsStorageTotal": {
"type": "integer",
"description": "Total aggregated sum of functions storage size (in bytes).",
"x-example": 0,
"format": "int32"
},
"buildsStorageTotal": {
"type": "integer",
"description": "Total aggregated sum of builds storage size (in bytes).",
"x-example": 0,
"format": "int32"
},
"deploymentsStorageTotal": {
"type": "integer",
"description": "Total aggregated sum of deployments storage size (in bytes).",
"x-example": 0,
"format": "int32"
},
"bucketsTotal": {
"type": "integer",
"description": "Total aggregated number of buckets.",
"x-example": 0,
"format": "int32"
},
"executionsMbSecondsTotal": {
"type": "integer",
"description": "Total aggregated number of function executions mbSeconds.",
"x-example": 0,
"format": "int32"
},
"buildsMbSecondsTotal": {
"type": "integer",
"description": "Total aggregated number of function builds mbSeconds.",
"x-example": 0,
"format": "int32"
},
"databasesReadsTotal": {
"type": "integer",
"description": "Total number of databases reads.",
"x-example": 0,
"format": "int32"
},
"databasesWritesTotal": {
"type": "integer",
"description": "Total number of databases writes.",
"x-example": 0,
"format": "int32"
},
"requests": {
"type": "array",
"description": "Aggregated number of requests per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"network": {
"type": "array",
"description": "Aggregated number of consumed bandwidth per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"users": {
"type": "array",
"description": "Aggregated number of users per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executions": {
"type": "array",
"description": "Aggregated number of executions per period.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"executionsBreakdown": {
"type": "array",
"description": "Aggregated breakdown in totals of executions by functions.",
"items": {
"$ref": "#\/components\/schemas\/metricBreakdown"
},
"x-example": []
},
"bucketsBreakdown": {
"type": "array",
"description": "Aggregated breakdown in totals of usage by buckets.",
"items": {
"$ref": "#\/components\/schemas\/metricBreakdown"
},
"x-example": []
},
"databasesStorageBreakdown": {
"type": "array",
"description": "An array of the aggregated breakdown of storage usage by databases.",
"items": {
"$ref": "#\/components\/schemas\/metricBreakdown"
},
"x-example": []
},
"executionsMbSecondsBreakdown": {
"type": "array",
"description": "Aggregated breakdown in totals of execution mbSeconds by functions.",
"items": {
"$ref": "#\/components\/schemas\/metricBreakdown"
},
"x-example": []
},
"buildsMbSecondsBreakdown": {
"type": "array",
"description": "Aggregated breakdown in totals of build mbSeconds by functions.",
"items": {
"$ref": "#\/components\/schemas\/metricBreakdown"
},
"x-example": []
},
"functionsStorageBreakdown": {
"type": "array",
"description": "Aggregated breakdown in totals of functions storage size (in bytes).",
"items": {
"$ref": "#\/components\/schemas\/metricBreakdown"
},
"x-example": []
},
"authPhoneTotal": {
"type": "integer",
"description": "Total aggregated number of phone auth.",
"x-example": 0,
"format": "int32"
},
"authPhoneEstimate": {
"type": "number",
"description": "Estimated total aggregated cost of phone auth.",
"x-example": 0,
"format": "double"
},
"authPhoneCountryBreakdown": {
"type": "array",
"description": "Aggregated breakdown in totals of phone auth by country.",
"items": {
"$ref": "#\/components\/schemas\/metricBreakdown"
},
"x-example": []
},
"databasesReads": {
"type": "array",
"description": "An array of aggregated number of database reads.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"databasesWrites": {
"type": "array",
"description": "An array of aggregated number of database writes.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"imageTransformations": {
"type": "array",
"description": "An array of aggregated number of image transformations.",
"items": {
"$ref": "#\/components\/schemas\/metric"
},
"x-example": []
},
"imageTransformationsTotal": {
"type": "integer",
"description": "Total aggregated number of image transformations.",
"x-example": 0,
"format": "int32"
}
},
"required": [
"executionsTotal",
"documentsTotal",
"rowsTotal",
"databasesTotal",
"databasesStorageTotal",
"usersTotal",
"filesStorageTotal",
"functionsStorageTotal",
"buildsStorageTotal",
"deploymentsStorageTotal",
"bucketsTotal",
"executionsMbSecondsTotal",
"buildsMbSecondsTotal",
"databasesReadsTotal",
"databasesWritesTotal",
"requests",
"network",
"users",
"executions",
"executionsBreakdown",
"bucketsBreakdown",
"databasesStorageBreakdown",
"executionsMbSecondsBreakdown",
"buildsMbSecondsBreakdown",
"functionsStorageBreakdown",
"authPhoneTotal",
"authPhoneEstimate",
"authPhoneCountryBreakdown",
"databasesReads",
"databasesWrites",
"imageTransformations",
"imageTransformationsTotal"
],
"example": {
"executionsTotal": 0,
"documentsTotal": 0,
"rowsTotal": 0,
"databasesTotal": 0,
"databasesStorageTotal": 0,
"usersTotal": 0,
"filesStorageTotal": 0,
"functionsStorageTotal": 0,
"buildsStorageTotal": 0,
"deploymentsStorageTotal": 0,
"bucketsTotal": 0,
"executionsMbSecondsTotal": 0,
"buildsMbSecondsTotal": 0,
"databasesReadsTotal": 0,
"databasesWritesTotal": 0,
"requests": [],
"network": [],
"users": [],
"executions": [],
"executionsBreakdown": [],
"bucketsBreakdown": [],
"databasesStorageBreakdown": [],
"executionsMbSecondsBreakdown": [],
"buildsMbSecondsBreakdown": [],
"functionsStorageBreakdown": [],
"authPhoneTotal": 0,
"authPhoneEstimate": 0,
"authPhoneCountryBreakdown": [],
"databasesReads": [],
"databasesWrites": [],
"imageTransformations": [],
"imageTransformationsTotal": 0
}
},
"headers": {
"description": "Headers",
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Header name.",
"x-example": "Content-Type"
},
"value": {
"type": "string",
"description": "Header value.",
"x-example": "application\/json"
}
},
"required": [
"name",
"value"
],
"example": {
"name": "Content-Type",
"value": "application\/json"
}
},
"specification": {
"description": "Specification",
"type": "object",
"properties": {
"memory": {
"type": "integer",
"description": "Memory size in MB.",
"x-example": 512,
"format": "int32"
},
"cpus": {
"type": "number",
"description": "Number of CPUs.",
"x-example": 1,
"format": "double"
},
"enabled": {
"type": "boolean",
"description": "Is size enabled.",
"x-example": true
},
"slug": {
"type": "string",
"description": "Size slug.",
"x-example": "s-1vcpu-512mb"
}
},
"required": [
"memory",
"cpus",
"enabled",
"slug"
],
"example": {
"memory": 512,
"cpus": 1,
"enabled": true,
"slug": "s-1vcpu-512mb"
}
},
"proxyRule": {
"description": "Rule",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Rule ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Rule creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Rule update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"domain": {
"type": "string",
"description": "Domain name.",
"x-example": "appwrite.company.com"
},
"type": {
"type": "string",
"description": "Action definition for the rule. Possible values are \"api\", \"deployment\", or \"redirect\"",
"x-example": "deployment"
},
"trigger": {
"type": "string",
"description": "Defines how the rule was created. Possible values are \"manual\" or \"deployment\"",
"x-example": "manual"
},
"redirectUrl": {
"type": "string",
"description": "URL to redirect to. Used if type is \"redirect\"",
"x-example": "https:\/\/appwrite.io\/docs"
},
"redirectStatusCode": {
"type": "integer",
"description": "Status code to apply during redirect. Used if type is \"redirect\"",
"x-example": 301,
"format": "int32"
},
"deploymentId": {
"type": "string",
"description": "ID of deployment. Used if type is \"deployment\"",
"x-example": "n3u9feiwmf"
},
"deploymentResourceType": {
"type": "string",
"description": "Type of deployment. Possible values are \"function\", \"site\". Used if rule's type is \"deployment\".",
"x-example": "function",
"enum": [
"function",
"site"
]
},
"deploymentResourceId": {
"type": "string",
"description": "ID deployment's resource. Used if type is \"deployment\"",
"x-example": "n3u9feiwmf"
},
"deploymentVcsProviderBranch": {
"type": "string",
"description": "Name of Git branch that updates rule. Used if type is \"deployment\"",
"x-example": "main"
},
"status": {
"type": "string",
"description": "Domain verification status. Possible values are \"created\", \"verifying\", \"verified\" and \"unverified\"",
"x-example": "verified",
"enum": [
"created",
"verifying",
"verified",
"unverified"
]
},
"logs": {
"type": "string",
"description": "Logs from rule verification or certificate generation. Certificate generation logs are prioritized if both are available.",
"x-example": "Verification of DNS records failed with DNS resolver 8.8.8.8. Domain stage.myapp.com does not have DNS record."
},
"renewAt": {
"type": "string",
"description": "Certificate auto-renewal date in ISO 8601 format.",
"x-example": "datetime"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"domain",
"type",
"trigger",
"redirectUrl",
"redirectStatusCode",
"deploymentId",
"deploymentResourceType",
"deploymentResourceId",
"deploymentVcsProviderBranch",
"status",
"logs",
"renewAt"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"domain": "appwrite.company.com",
"type": "deployment",
"trigger": "manual",
"redirectUrl": "https:\/\/appwrite.io\/docs",
"redirectStatusCode": 301,
"deploymentId": "n3u9feiwmf",
"deploymentResourceType": "function",
"deploymentResourceId": "n3u9feiwmf",
"deploymentVcsProviderBranch": "main",
"status": "verified",
"logs": "Verification of DNS records failed with DNS resolver 8.8.8.8. Domain stage.myapp.com does not have DNS record.",
"renewAt": "datetime"
}
},
"smsTemplate": {
"description": "SmsTemplate",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Template type",
"x-example": "verification"
},
"locale": {
"type": "string",
"description": "Template locale",
"x-example": "en_us"
},
"message": {
"type": "string",
"description": "Template message",
"x-example": "Click on the link to verify your account."
}
},
"required": [
"type",
"locale",
"message"
],
"example": {
"type": "verification",
"locale": "en_us",
"message": "Click on the link to verify your account."
}
},
"emailTemplate": {
"description": "EmailTemplate",
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "Template type",
"x-example": "verification"
},
"locale": {
"type": "string",
"description": "Template locale",
"x-example": "en_us"
},
"message": {
"type": "string",
"description": "Template message",
"x-example": "Click on the link to verify your account."
},
"senderName": {
"type": "string",
"description": "Name of the sender",
"x-example": "My User"
},
"senderEmail": {
"type": "string",
"description": "Email of the sender",
"x-example": "mail@appwrite.io"
},
"replyTo": {
"type": "string",
"description": "Reply to email address",
"x-example": "emails@appwrite.io"
},
"subject": {
"type": "string",
"description": "Email subject",
"x-example": "Please verify your email address"
}
},
"required": [
"type",
"locale",
"message",
"senderName",
"senderEmail",
"replyTo",
"subject"
],
"example": {
"type": "verification",
"locale": "en_us",
"message": "Click on the link to verify your account.",
"senderName": "My User",
"senderEmail": "mail@appwrite.io",
"replyTo": "emails@appwrite.io",
"subject": "Please verify your email address"
}
},
"consoleVariables": {
"description": "Console Variables",
"type": "object",
"properties": {
"_APP_DOMAIN_TARGET_CNAME": {
"type": "string",
"description": "CNAME target for your Appwrite custom domains.",
"x-example": "appwrite.io"
},
"_APP_DOMAIN_TARGET_A": {
"type": "string",
"description": "A target for your Appwrite custom domains.",
"x-example": "127.0.0.1"
},
"_APP_COMPUTE_BUILD_TIMEOUT": {
"type": "integer",
"description": "Maximum build timeout in seconds.",
"x-example": 900,
"format": "int32"
},
"_APP_DOMAIN_TARGET_AAAA": {
"type": "string",
"description": "AAAA target for your Appwrite custom domains.",
"x-example": "::1"
},
"_APP_DOMAIN_TARGET_CAA": {
"type": "string",
"description": "CAA target for your Appwrite custom domains.",
"x-example": "digicert.com"
},
"_APP_STORAGE_LIMIT": {
"type": "integer",
"description": "Maximum file size allowed for file upload in bytes.",
"x-example": "30000000",
"format": "int32"
},
"_APP_COMPUTE_SIZE_LIMIT": {
"type": "integer",
"description": "Maximum file size allowed for deployment in bytes.",
"x-example": "30000000",
"format": "int32"
},
"_APP_USAGE_STATS": {
"type": "string",
"description": "Defines if usage stats are enabled. This value is set to 'enabled' by default, to disable the usage stats set the value to 'disabled'.",
"x-example": "enabled"
},
"_APP_VCS_ENABLED": {
"type": "boolean",
"description": "Defines if VCS (Version Control System) is enabled.",
"x-example": true
},
"_APP_DOMAIN_ENABLED": {
"type": "boolean",
"description": "Defines if main domain is configured. If so, custom domains can be created.",
"x-example": true
},
"_APP_ASSISTANT_ENABLED": {
"type": "boolean",
"description": "Defines if AI assistant is enabled.",
"x-example": true
},
"_APP_DOMAIN_SITES": {
"type": "string",
"description": "A comma separated list of domains to use for site URLs.",
"x-example": "sites.localhost,sites.example.com"
},
"_APP_DOMAIN_FUNCTIONS": {
"type": "string",
"description": "A domain to use for function URLs.",
"x-example": "functions.localhost"
},
"_APP_OPTIONS_FORCE_HTTPS": {
"type": "string",
"description": "Defines if HTTPS is enforced for all requests.",
"x-example": "enabled"
},
"_APP_DOMAINS_NAMESERVERS": {
"type": "string",
"description": "Comma-separated list of nameservers.",
"x-example": "ns1.example.com,ns2.example.com"
}
},
"required": [
"_APP_DOMAIN_TARGET_CNAME",
"_APP_DOMAIN_TARGET_A",
"_APP_COMPUTE_BUILD_TIMEOUT",
"_APP_DOMAIN_TARGET_AAAA",
"_APP_DOMAIN_TARGET_CAA",
"_APP_STORAGE_LIMIT",
"_APP_COMPUTE_SIZE_LIMIT",
"_APP_USAGE_STATS",
"_APP_VCS_ENABLED",
"_APP_DOMAIN_ENABLED",
"_APP_ASSISTANT_ENABLED",
"_APP_DOMAIN_SITES",
"_APP_DOMAIN_FUNCTIONS",
"_APP_OPTIONS_FORCE_HTTPS",
"_APP_DOMAINS_NAMESERVERS"
],
"example": {
"_APP_DOMAIN_TARGET_CNAME": "appwrite.io",
"_APP_DOMAIN_TARGET_A": "127.0.0.1",
"_APP_COMPUTE_BUILD_TIMEOUT": 900,
"_APP_DOMAIN_TARGET_AAAA": "::1",
"_APP_DOMAIN_TARGET_CAA": "digicert.com",
"_APP_STORAGE_LIMIT": "30000000",
"_APP_COMPUTE_SIZE_LIMIT": "30000000",
"_APP_USAGE_STATS": "enabled",
"_APP_VCS_ENABLED": true,
"_APP_DOMAIN_ENABLED": true,
"_APP_ASSISTANT_ENABLED": true,
"_APP_DOMAIN_SITES": "sites.localhost,sites.example.com",
"_APP_DOMAIN_FUNCTIONS": "functions.localhost",
"_APP_OPTIONS_FORCE_HTTPS": "enabled",
"_APP_DOMAINS_NAMESERVERS": "ns1.example.com,ns2.example.com"
}
},
"mfaChallenge": {
"description": "MFA Challenge",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Token ID.",
"x-example": "bb8ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Token creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "5e5ea5c168bb8"
},
"expire": {
"type": "string",
"description": "Token expiration date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
}
},
"required": [
"$id",
"$createdAt",
"userId",
"expire"
],
"example": {
"$id": "bb8ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"userId": "5e5ea5c168bb8",
"expire": "2020-10-15T06:38:00.000+00:00"
}
},
"mfaRecoveryCodes": {
"description": "MFA Recovery Codes",
"type": "object",
"properties": {
"recoveryCodes": {
"type": "array",
"description": "Recovery codes.",
"items": {
"type": "string"
},
"x-example": [
"a3kf0-s0cl2",
"s0co1-as98s"
]
}
},
"required": [
"recoveryCodes"
],
"example": {
"recoveryCodes": [
"a3kf0-s0cl2",
"s0co1-as98s"
]
}
},
"mfaType": {
"description": "MFAType",
"type": "object",
"properties": {
"secret": {
"type": "string",
"description": "Secret token used for TOTP factor.",
"x-example": true
},
"uri": {
"type": "string",
"description": "URI for authenticator apps.",
"x-example": true
}
},
"required": [
"secret",
"uri"
],
"example": {
"secret": true,
"uri": true
}
},
"mfaFactors": {
"description": "MFAFactors",
"type": "object",
"properties": {
"totp": {
"type": "boolean",
"description": "Can TOTP be used for MFA challenge for this account.",
"x-example": true
},
"phone": {
"type": "boolean",
"description": "Can phone (SMS) be used for MFA challenge for this account.",
"x-example": true
},
"email": {
"type": "boolean",
"description": "Can email be used for MFA challenge for this account.",
"x-example": true
},
"recoveryCode": {
"type": "boolean",
"description": "Can recovery code be used for MFA challenge for this account.",
"x-example": true
}
},
"required": [
"totp",
"phone",
"email",
"recoveryCode"
],
"example": {
"totp": true,
"phone": true,
"email": true,
"recoveryCode": true
}
},
"provider": {
"description": "Provider",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Provider ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Provider creation time in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Provider update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "The name for the provider instance.",
"x-example": "Mailgun"
},
"provider": {
"type": "string",
"description": "The name of the provider service.",
"x-example": "mailgun"
},
"enabled": {
"type": "boolean",
"description": "Is provider enabled?",
"x-example": true
},
"type": {
"type": "string",
"description": "Type of provider.",
"x-example": "sms"
},
"credentials": {
"type": "object",
"description": "Provider credentials.",
"x-example": {
"key": "123456789"
}
},
"options": {
"type": "object",
"description": "Provider options.",
"x-example": {
"from": "sender-email@mydomain"
},
"nullable": true
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"provider",
"enabled",
"type",
"credentials"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "Mailgun",
"provider": "mailgun",
"enabled": true,
"type": "sms",
"credentials": {
"key": "123456789"
},
"options": {
"from": "sender-email@mydomain"
}
}
},
"message": {
"description": "Message",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Message ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Message creation time in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Message update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"providerType": {
"type": "string",
"description": "Message provider type.",
"x-example": "email"
},
"topics": {
"type": "array",
"description": "Topic IDs set as recipients.",
"items": {
"type": "string"
},
"x-example": [
"5e5ea5c16897e"
]
},
"users": {
"type": "array",
"description": "User IDs set as recipients.",
"items": {
"type": "string"
},
"x-example": [
"5e5ea5c16897e"
]
},
"targets": {
"type": "array",
"description": "Target IDs set as recipients.",
"items": {
"type": "string"
},
"x-example": [
"5e5ea5c16897e"
]
},
"scheduledAt": {
"type": "string",
"description": "The scheduled time for message.",
"x-example": "2020-10-15T06:38:00.000+00:00",
"nullable": true
},
"deliveredAt": {
"type": "string",
"description": "The time when the message was delivered.",
"x-example": "2020-10-15T06:38:00.000+00:00",
"nullable": true
},
"deliveryErrors": {
"type": "array",
"description": "Delivery errors if any.",
"items": {
"type": "string"
},
"x-example": [
"Failed to send message to target 5e5ea5c16897e: Credentials not valid."
],
"nullable": true
},
"deliveredTotal": {
"type": "integer",
"description": "Number of recipients the message was delivered to.",
"x-example": 1,
"format": "int32"
},
"data": {
"type": "object",
"description": "Data of the message.",
"x-example": {
"subject": "Welcome to Appwrite",
"content": "Hi there, welcome to Appwrite family."
}
},
"status": {
"type": "string",
"description": "Status of delivery.",
"x-example": "processing",
"enum": [
"draft",
"processing",
"scheduled",
"sent",
"failed"
]
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"providerType",
"topics",
"users",
"targets",
"deliveredTotal",
"data",
"status"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"providerType": "email",
"topics": [
"5e5ea5c16897e"
],
"users": [
"5e5ea5c16897e"
],
"targets": [
"5e5ea5c16897e"
],
"scheduledAt": "2020-10-15T06:38:00.000+00:00",
"deliveredAt": "2020-10-15T06:38:00.000+00:00",
"deliveryErrors": [
"Failed to send message to target 5e5ea5c16897e: Credentials not valid."
],
"deliveredTotal": 1,
"data": {
"subject": "Welcome to Appwrite",
"content": "Hi there, welcome to Appwrite family."
},
"status": "processing"
}
},
"topic": {
"description": "Topic",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Topic ID.",
"x-example": "259125845563242502"
},
"$createdAt": {
"type": "string",
"description": "Topic creation time in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Topic update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "The name of the topic.",
"x-example": "events"
},
"emailTotal": {
"type": "integer",
"description": "Total count of email subscribers subscribed to the topic.",
"x-example": 100,
"format": "int32"
},
"smsTotal": {
"type": "integer",
"description": "Total count of SMS subscribers subscribed to the topic.",
"x-example": 100,
"format": "int32"
},
"pushTotal": {
"type": "integer",
"description": "Total count of push subscribers subscribed to the topic.",
"x-example": 100,
"format": "int32"
},
"subscribe": {
"type": "array",
"description": "Subscribe permissions.",
"items": {
"type": "string"
},
"x-example": "users"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"emailTotal",
"smsTotal",
"pushTotal",
"subscribe"
],
"example": {
"$id": "259125845563242502",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "events",
"emailTotal": 100,
"smsTotal": 100,
"pushTotal": 100,
"subscribe": "users"
}
},
"transaction": {
"description": "Transaction",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Transaction ID.",
"x-example": "259125845563242502"
},
"$createdAt": {
"type": "string",
"description": "Transaction creation time in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Transaction update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"status": {
"type": "string",
"description": "Current status of the transaction. One of: pending, committing, committed, rolled_back, failed.",
"x-example": "pending"
},
"operations": {
"type": "integer",
"description": "Number of operations in the transaction.",
"x-example": 5,
"format": "int32"
},
"expiresAt": {
"type": "string",
"description": "Expiration time in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"status",
"operations",
"expiresAt"
],
"example": {
"$id": "259125845563242502",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"status": "pending",
"operations": 5,
"expiresAt": "2020-10-15T06:38:00.000+00:00"
}
},
"subscriber": {
"description": "Subscriber",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Subscriber ID.",
"x-example": "259125845563242502"
},
"$createdAt": {
"type": "string",
"description": "Subscriber creation time in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Subscriber update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"targetId": {
"type": "string",
"description": "Target ID.",
"x-example": "259125845563242502"
},
"target": {
"type": "object",
"description": "Target.",
"x-example": {
"$id": "259125845563242502",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"providerType": "email",
"providerId": "259125845563242502",
"name": "ageon-app-email",
"identifier": "random-mail@email.org",
"userId": "5e5ea5c16897e"
},
"items": {
"$ref": "#\/components\/schemas\/target"
}
},
"userId": {
"type": "string",
"description": "Topic ID.",
"x-example": "5e5ea5c16897e"
},
"userName": {
"type": "string",
"description": "User Name.",
"x-example": "Aegon Targaryen"
},
"topicId": {
"type": "string",
"description": "Topic ID.",
"x-example": "259125845563242502"
},
"providerType": {
"type": "string",
"description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.",
"x-example": "email"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"targetId",
"target",
"userId",
"userName",
"topicId",
"providerType"
],
"example": {
"$id": "259125845563242502",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"targetId": "259125845563242502",
"target": {
"$id": "259125845563242502",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"providerType": "email",
"providerId": "259125845563242502",
"name": "ageon-app-email",
"identifier": "random-mail@email.org",
"userId": "5e5ea5c16897e"
},
"userId": "5e5ea5c16897e",
"userName": "Aegon Targaryen",
"topicId": "259125845563242502",
"providerType": "email"
}
},
"target": {
"description": "Target",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Target ID.",
"x-example": "259125845563242502"
},
"$createdAt": {
"type": "string",
"description": "Target creation time in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Target update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"name": {
"type": "string",
"description": "Target Name.",
"x-example": "Apple iPhone 12"
},
"userId": {
"type": "string",
"description": "User ID.",
"x-example": "259125845563242502"
},
"providerId": {
"type": "string",
"description": "Provider ID.",
"x-example": "259125845563242502",
"nullable": true
},
"providerType": {
"type": "string",
"description": "The target provider type. Can be one of the following: `email`, `sms` or `push`.",
"x-example": "email"
},
"identifier": {
"type": "string",
"description": "The target identifier.",
"x-example": "token"
},
"expired": {
"type": "boolean",
"description": "Is the target expired.",
"x-example": false
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"name",
"userId",
"providerType",
"identifier",
"expired"
],
"example": {
"$id": "259125845563242502",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"name": "Apple iPhone 12",
"userId": "259125845563242502",
"providerId": "259125845563242502",
"providerType": "email",
"identifier": "token",
"expired": false
}
},
"migration": {
"description": "Migration",
"type": "object",
"properties": {
"$id": {
"type": "string",
"description": "Migration ID.",
"x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
"description": "Migration creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$updatedAt": {
"type": "string",
"description": "Variable creation date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"status": {
"type": "string",
"description": "Migration status ( pending, processing, failed, completed ) ",
"x-example": "pending"
},
"stage": {
"type": "string",
"description": "Migration stage ( init, processing, source-check, destination-check, migrating, finished )",
"x-example": "init"
},
"source": {
"type": "string",
"description": "A string containing the type of source of the migration.",
"x-example": "Appwrite"
},
"destination": {
"type": "string",
"description": "A string containing the type of destination of the migration.",
"x-example": "Appwrite"
},
"resources": {
"type": "array",
"description": "Resources to migrate.",
"items": {
"type": "string"
},
"x-example": [
"user"
]
},
"resourceId": {
"type": "string",
"description": "Id of the resource to migrate.",
"x-example": "databaseId:collectionId"
},
"statusCounters": {
"type": "object",
"description": "A group of counters that represent the total progress of the migration.",
"x-example": "{\"Database\": {\"PENDING\": 0, \"SUCCESS\": 1, \"ERROR\": 0, \"SKIP\": 0, \"PROCESSING\": 0, \"WARNING\": 0}}"
},
"resourceData": {
"type": "object",
"description": "An array of objects containing the report data of the resources that were migrated.",
"x-example": "[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]"
},
"errors": {
"type": "array",
"description": "All errors that occurred during the migration process.",
"items": {
"type": "string"
},
"x-example": []
},
"options": {
"type": "object",
"description": "Migration options used during the migration process.",
"x-example": "{\"bucketId\": \"exports\", \"notify\": false}"
}
},
"required": [
"$id",
"$createdAt",
"$updatedAt",
"status",
"stage",
"source",
"destination",
"resources",
"resourceId",
"statusCounters",
"resourceData",
"errors",
"options"
],
"example": {
"$id": "5e5ea5c16897e",
"$createdAt": "2020-10-15T06:38:00.000+00:00",
"$updatedAt": "2020-10-15T06:38:00.000+00:00",
"status": "pending",
"stage": "init",
"source": "Appwrite",
"destination": "Appwrite",
"resources": [
"user"
],
"resourceId": "databaseId:collectionId",
"statusCounters": "{\"Database\": {\"PENDING\": 0, \"SUCCESS\": 1, \"ERROR\": 0, \"SKIP\": 0, \"PROCESSING\": 0, \"WARNING\": 0}}",
"resourceData": "[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]",
"errors": [],
"options": "{\"bucketId\": \"exports\", \"notify\": false}"
}
},
"migrationReport": {
"description": "Migration Report",
"type": "object",
"properties": {
"user": {
"type": "integer",
"description": "Number of users to be migrated.",
"x-example": 20,
"format": "int32"
},
"team": {
"type": "integer",
"description": "Number of teams to be migrated.",
"x-example": 20,
"format": "int32"
},
"database": {
"type": "integer",
"description": "Number of databases to be migrated.",
"x-example": 20,
"format": "int32"
},
"row": {
"type": "integer",
"description": "Number of rows to be migrated.",
"x-example": 20,
"format": "int32"
},
"file": {
"type": "integer",
"description": "Number of files to be migrated.",
"x-example": 20,
"format": "int32"
},
"bucket": {
"type": "integer",
"description": "Number of buckets to be migrated.",
"x-example": 20,
"format": "int32"
},
"function": {
"type": "integer",
"description": "Number of functions to be migrated.",
"x-example": 20,
"format": "int32"
},
"size": {
"type": "integer",
"description": "Size of files to be migrated in mb.",
"x-example": 30000,
"format": "int32"
},
"version": {
"type": "string",
"description": "Version of the Appwrite instance to be migrated.",
"x-example": "1.4.0"
}
},
"required": [
"user",
"team",
"database",
"row",
"file",
"bucket",
"function",
"size",
"version"
],
"example": {
"user": 20,
"team": 20,
"database": 20,
"row": 20,
"file": 20,
"bucket": 20,
"function": 20,
"size": 30000,
"version": "1.4.0"
}
}
},
"securitySchemes": {
"Project": {
"type": "apiKey",
"name": "X-Appwrite-Project",
"description": "Your project ID",
"in": "header",
"x-appwrite": {
"demo": "<YOUR_PROJECT_ID>"
}
},
"Key": {
"type": "apiKey",
"name": "X-Appwrite-Key",
"description": "Your secret API key",
"in": "header",
"x-appwrite": {
"demo": "<YOUR_API_KEY>"
}
},
"JWT": {
"type": "apiKey",
"name": "X-Appwrite-JWT",
"description": "Your secret JSON Web Token",
"in": "header"
},
"Locale": {
"type": "apiKey",
"name": "X-Appwrite-Locale",
"description": "",
"in": "header",
"x-appwrite": {
"demo": "en"
}
},
"Mode": {
"type": "apiKey",
"name": "X-Appwrite-Mode",
"description": "",
"in": "header",
"x-appwrite": {
"demo": ""
}
},
"Cookie": {
"type": "apiKey",
"name": "Cookie",
"description": "The user cookie to authenticate with",
"in": "header"
}
}
},
"externalDocs": {
"description": "Full API docs, specs and tutorials",
"url": "https:\/\/appwrite.io\/docs"
}
}
Reference in a new issue View git blame Copy permalink