API Reference appwrite v#1.0.0
View SourceModules
Valid MFA authentication factor identifiers.
Valid MFA authenticator types.
Behaviour that every Appwrite constant/enum module implements.
Browser type codes used by the Appwrite Avatars service.
Credit card type codes used by the Appwrite Avatars service.
HTTP methods accepted by the Appwrite Functions execution endpoint.
ISO 3166-1 alpha-2 country codes used by the Appwrite Avatars flag endpoint.
Image output formats supported by the Appwrite Storage preview endpoint.
Image crop/positioning gravity values for the Appwrite Storage preview endpoint.
OAuth2 provider identifiers supported by Appwrite.
Represents an error returned by the Appwrite API or the HTTP layer.
Raised when :project_id is not set in the application config.
Raised when :root_uri is not set in the application config.
Raised when :secret (API key) is not set in the application config.
The Account service allows you to authenticate and manage a user account.
The Avatars service aims to help you complete everyday tasks related to your app image, icons, and avatars.
The Database service allows you to create structured collections of documents, query and filter lists of documents, and manage an advanced set of read and write access permissions.
The Functions service allows you to create custom behaviour that can be triggered by any supported Appwrite system events or by a predefined schedule.
The GraphQL service allows you to query and mutate your Appwrite server using the GraphQL protocol.
The Health service is designed to allow you to both validate and monitor that your Appwrite instance and all of its internal components are up and responsive.
The Locale service allows you to customize your app based on your users' location.
The Messaging service allows you to send messages to any provider type (SMTP, push notification, SMS, etc.).
The Sites service allows you to deploy and manage static or server-rendered web applications hosted on Appwrite Cloud.
The Storage service allows you to manage your project files.
The TablesDB service provides a structured, SQL-like data storage layer on
top of Appwrite — separate from the document-oriented Database service.
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.
The Tokens service allows you to create short-lived, scoped file access tokens that grant unauthenticated (or differently-authenticated) access to individual Storage files.
Parameters for the Argon2id password hashing algorithm.
Parameters for the Bcrypt password hashing algorithm.
Parameters for the MD5 hashing algorithm.
Parameters for the PHPass (Portable PHP password hashing) algorithm.
Parameters for the standard Scrypt password hashing algorithm.
Parameters for the modified Scrypt algorithm used by Firebase.
Parameters for the SHA-family hashing algorithms.
Type alias for the Appwrite client configuration map.
Type alias for an HTTP headers map used by the Appwrite client.
Type alias for a generic API request or event payload map.
Struct representing the state of an Appwrite Realtime WebSocket connection.
A message sent by the client to the Appwrite Realtime WebSocket server.
Payload for a Realtime authentication request.
A message received from the Appwrite Realtime WebSocket server.
Data payload for a Realtime "response" (authentication result) message.
Data payload for a Realtime "connected" message.
Data payload for a Realtime "error" message.
Data payload for a Realtime "event" message.
Represents the progress of a chunked file upload.
A continent record returned by GET /v1/locale/continents.
Paginated list of Appwrite.Types.Continent records.
A country record returned by GET /v1/locale/countries.
Paginated list of Appwrite.Types.Country records.
A currency record returned by GET /v1/locale/currencies.
Paginated list of Appwrite.Types.Currency records.
A document stored in an Appwrite Database collection.
Paginated list of Appwrite.Types.Document records.
A record of a single Appwrite Function execution.
Paginated list of Appwrite.Types.Execution records.
A file stored in an Appwrite Storage bucket.
Paginated list of Appwrite.Types.File records.
Represents the health status of the Appwrite antivirus service.
Represents an SSL certificate health check result.
Represents the size of an Appwrite internal queue.
Represents the health status of an Appwrite service component.
Represents the result of a server time check against Google's NTP server.
Represents an OAuth2 identity linked to an Appwrite user account.
Represents a list of identities.
Represents a JWT token.
Represents a language with its ISO code and native name.
Represents a list of languages.
Represents locale information for a user based on their IP address.
Represents a locale code and its display name.
Represents a list of locale codes.
Represents a user activity log entry in the Appwrite system.
Represents a list of logs.
Represents a user's membership in an Appwrite team.
Represents a list of memberships.
Represents an MFA challenge token.
Represents the MFA factors available for a user.
Represents a set of MFA recovery codes.
Represents an MFA type with its TOTP secret and provisioning URI.
Represents a phone dialling code associated with a country.
Represents a list of phone dialling codes.
Type alias for a user or team preferences map.
Represents an authenticated user session in Appwrite.
Represents a list of sessions.
Represents a subscriber to an Appwrite Messaging topic.
Represents a messaging target owned by a user.
Represents a team in Appwrite.
Represents a list of teams.
Represents a verification or magic-link token in Appwrite.
Represents an Appwrite user account.
HTTP client for the Appwrite SDK.
General-purpose utilities used across the Appwrite SDK.
Helpers for generating resource ID strings compatible with Appwrite's ID format.
Helpers for generating Appwrite permission strings.
Builds Appwrite query strings for filtering, sorting, selecting, and paginating database documents.
Helpers for generating Appwrite role strings to use with Appwrite.Utils.Permission.
Utility functions shared across Appwrite service modules.