- [BREAKING] Renamed Webhook model fields:
security→tls,httpUser→authUsername,httpPass→authPassword,signatureKey→secret - [BREAKING] Renamed Webhook service parameters to match:
security→tls,httpUser→authUsername,httpPass→authPassword - Added
secretparameter to Webhook create and update methods - Added
xOAuth provider toOAuthProviderenum - Added
userTypefield toLogmodel - Added
purgeparameter toupdateCollectionandupdateTablefor cache invalidation - Added Project service: platform CRUD, key CRUD, protocol/service status management
- Added new models:
Key,KeyList,PlatformAndroid,PlatformApple,PlatformLinux,PlatformList, and others - Added new enums:
PlatformType,ProtocolId,ServiceId - Updated
BuildRuntime,Runtime,Scopesenums with new values - Updated
X-Appwrite-Response-Formatheader to1.9.1 - Updated TTL description for list caching in Databases and TablesDB
- Added: Added
getHeaders()method toClientto expose current request headers - Added: Added
package-lock.jsonto track dependency lockfile in version control - Updated: Improved MFA authenticator test data with realistic TOTP secret and URI values
- [BREAKING] Changed
$sequencetype fromnumbertostringforRowandDocumentmodels - [BREAKING] Renamed
IndexTypeenum: split intoDatabasesIndexType(with newSpatialvalue) andTablesDBIndexType - [BREAKING] Replaced
specificationparameter withbuildSpecificationandruntimeSpecificationinFunctions.create(),Functions.update(),Sites.create(),Sites.update() - Added new
Projectservice with full CRUD for project-level environment variables - Added new
Webhooksservice with full CRUD for project webhooks (includingupdateSignature) - Added
Users.updateImpersonator()method for enabling/disabling user impersonation - Added impersonation support:
setImpersonateUserId(),setImpersonateUserEmail(),setImpersonateUserPhone()onClient - Added
impersonatorandimpersonatorUserIdoptional fields toUsermodel - Added
deploymentRetentionparameter to Functions and Sites create/update - Added
startCommandparameter to Sites create/update - Added
WebhookandWebhookListmodels - Added
Documentsdb,Vectorsdbvalues toBackupServicesandDatabaseTypeenums - Added
WebhooksRead,WebhooksWrite,ProjectRead,ProjectWritescopes - Added custom
toString()on response data usingJSONbig.stringifyfor BigInt support - Removed
getQueueBillingProjectAggregation,getQueueBillingTeamAggregation,getQueuePriorityBuilds,getQueueRegionManager,getQueueThreatsfromHealthservice - Updated
Logmodel field descriptions to clarify impersonation behavior - Updated
X-Appwrite-Response-Formatheader to1.9.0
- Fix very large double values (for example 1.7976931348623157e+308) from being expanded into giant integer literals
- Removed unused BigNumber import from src/client.ts to clean up dependencies
- Updated documentation examples to include the new encrypt option for text-like attributes (encrypt: false) across multiple examples
- Updated README to specify Appwrite server compatibility with 1.8.x
- Repo cleanup: removed obsolete GitHub workflow and issue template files as part of repository cleanup (non-breaking)
- Fix doc examples with proper formatting
- Add support for the new
Backupsservice
- Add array-based enum parameters (e.g.,
permissions: BrowserPermission[]). - Breaking change:
Outputenum has been removed; useImageFormatinstead. - Add
getQueueAuditssupport toHealthservice. - Add longtext/mediumtext/text/varchar attribute and column helpers to
DatabasesandTablesDBservices.
- Added ability to create columns and indexes synchronously while creating a table
- Rename
VCSDeploymentTypeenum toVCSReferenceType - Change
createTemplateDeploymentmethod signature: replaceversionparameter withtype(TemplateReferenceType) andreferenceparameters - Add
getScreenshotmethod toAvatarsservice - Add
Theme,TimezoneandOutputenums
- Add
totalparameter to list queries allowing skipping counting rows in a table for improved performance - Add
Operatorclass for atomic modification of rows via update, bulk update, upsert, and bulk upsert operations - Add
createResendProviderandupdateResendProvidermethods toMessagingservice
- Add transaction support for Databases and TablesDB
- Deprecate
createVerificationmethod inAccountservice - Add
createEmailVerificationmethod inAccountservice
- Add
incrementDocumentAttributeanddecrementDocumentAttributesupport toDatabasesservice - Fix autocompletion not working for
Documentmodel even when generic is passed
- Add
upsertDocumentmethod - Add
dart-3.8andflutter-3.32runtimes - Add
gifimage format - Update bulk operation methods to reflect warning message
- Fix file parameter handling in chunked upload method
- Add
REGIONto doc examples due to the new multi region endpoints - Add doc examples and methods for bulk api transactions:
createDocuments,deleteDocumentsetc. - Add doc examples, class and methods for new
Sitesservice - Add doc examples, class and methods for new
Tokensservice - Add enums for
BuildRuntime,Adapter,Framework,DeploymentDownloadTypeandVCSDeploymentType - Updates enum for
runtimeswith Pythonml312, Dart219, Flutter327 and Flutter329 - Add
tokenparam togetFilePreviewandgetFileViewfor File tokens usage - Add
queriesandsearchparams tolistMembershipsmethod - Removes
searchparam fromlistExecutionsmethod
- Fix: remove content-type from GET requests
- Update (breaking): min and max params are now optional in
updateFloatAttributeandupdateIntegerAttributemethods (changes their positioning in method definition)
- Remove titles from all function descriptions
- Fix typing for collection "attribute" key
- Remove unnecessary awaits and asyncs
- Ensure
AppwriteExceptionresponse is always string
- Fix: pong response & chunked upload
- Add new push message parameters
- Support updating attribute name and size
- Support for Appwrite 1.6
- Add
keyattribute toRuntimeresponse model. - Add
buildSizeattribute toDeploymentsresponse model - Add
scheduledAtattribute toExecutionsresponse model - Add
scopesattribute toFunctionsresponse model - Add
specificationsattribute toFunctionsresponse model - Add new response model for
Specifications - Add new response model for
Builds - Add
createJWT(): Enables creating a JWT using theuserId - Add
listSpecifications(): Enables listing available runtime specifications - Add
deleteExecution(): Enables deleting executions - Add
updateDeploymentBuild(): Enables cancelling a deployment - Add
scheduledAtparameter tocreateExecution(): Enables creating a delayed execution - Breaking changes
- Remove
otpparameter fromdeleteMFAAuthenticator. - Add
scopesparameter for create/update function. - Rename
templateBranchtotemplateVersionincreateFunction(). - Rename
downloadDeployment()togetDeploymentDownload()
- Remove
You can find the new syntax for breaking changes in the Appwrite API references. Select version
1.6.x.