appwrite.io – server

Tools (97)

Extracted live via the executor SDK.

• account.accountCreateRecovery

  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 endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.

• account.accountCreateVerification

  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. The verification link sent to the user's email address is valid for 7 days.

  Please note that in order to avoid a Redirect Attack, the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.

• account.accountDelete

  Delete a currently logged in user account. Behind the scene, the user record is not deleted but permanently blocked from any access. This is done to avoid deleted accounts being overtaken by new users with the same email address. Any user-related resources like documents or storage files should be deleted separately.

• account.accountDeleteSession

  Use this endpoint to log out the currently logged in user from all their account sessions across all of their different devices. When using the option id argument, only the session unique ID provider will be deleted.

• account.accountDeleteSessions

  Delete all sessions from the user account and remove any sessions cookies from the end client.

• account.accountGet

  Get currently logged in user data as JSON object.

• account.accountGetLogs

  Get currently logged in user list of latest security activity logs. Each log returns user IP address, location and date and time of log.

• account.accountGetPrefs

  Get currently logged in user preferences as a key-value object.

• account.accountGetSession

  Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.

• account.accountGetSessions

  Get currently logged in user list of active sessions across different devices.

• account.accountUpdateEmail

  Update currently logged in user account email address. After changing user address, user confirmation status is being reset and a new confirmation mail is sent. For security measures, user password is required to complete this request. This endpoint can also be used to convert an anonymous account to a normal one, by passing an email address and a new password.

• account.accountUpdateName

  Update currently logged in user account name.

• account.accountUpdatePassword

  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 and Team Invites, oldPassword is optional.

• account.accountUpdatePrefs

  Update currently logged in user account preferences. You can pass only the specific settings you wish to update.

• account.accountUpdateRecovery

  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 endpoint.

  Please note that in order to avoid a Redirect Attack the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface.

• account.accountUpdateVerification

  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.

• avatars.avatarsGetBrowser

  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 /account/sessions endpoint. Use width, height and quality arguments to change the output settings.

• avatars.avatarsGetCreditCard

  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.

• avatars.avatarsGetFavicon

  Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.

• avatars.avatarsGetFlag

  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.

• avatars.avatarsGetImage

  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.

• avatars.avatarsGetInitials

  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.

  You 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.

• avatars.avatarsGetQr

  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.

• database.databaseCreateCollection

  Create a new Collection.

• database.databaseCreateDocument

  Create a new Document. Before using this route, you should create a new collection resource using either a server integration API or directly from your database console.

• database.databaseDeleteCollection

  Delete a collection by its unique ID. Only users with write permissions have access to delete this resource.

• database.databaseDeleteDocument

  Delete a document by its unique ID. This endpoint deletes only the parent documents, its attributes and relations to other documents. Child documents will not be deleted.

• database.databaseGetCollection

  Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.

• database.databaseGetDocument

  Get a document by its unique ID. This endpoint response returns a JSON object with the document data.

• database.databaseListCollections

  Get a list of all the user collections. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's collections. Learn more about different API modes.

• database.databaseListDocuments

  Get a list of all the user documents. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's documents. Learn more about different API modes.

• database.databaseUpdateCollection

  Update a collection by its unique ID.

• database.databaseUpdateDocument

  Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.

• functions.functionsCreate

  Create a new function. You can pass a list of permissions to allow different project users or team with access to execute the function using the client API.

• functions.functionsCreateExecution

  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.

• functions.functionsCreateTag

  Create a new function code tag. 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 tag to use your new tag UID.

  This 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.

  Use the "command" param to set the entry point used to execute your code.

• functions.functionsDelete

  Delete a function by its unique ID.

• functions.functionsDeleteTag

  Delete a code tag by its unique ID.

• functions.functionsGet

  Get a function by its unique ID.

• functions.functionsGetExecution

  Get a function execution log by its unique ID.

• functions.functionsGetTag

  Get a code tag by its unique ID.

• functions.functionsList

  Get a list of all the project's functions. You can use the query params to filter your results.

• functions.functionsListExecutions

  Get a list of all the current user function execution logs. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's executions. Learn more about different API modes.

• functions.functionsListTags

  Get a list of all the project's code tags. You can use the query params to filter your results.

• functions.functionsUpdate

  Update function by its unique ID.

• functions.functionsUpdateTag

  Update the function code tag ID using the unique function ID. Use this endpoint to switch the code tag that should be executed by the execution endpoint.

• health.healthGet

  Check the Appwrite HTTP server is up and responsive.

• health.healthGetAntiVirus

  Check the Appwrite Anti Virus server is up and connection is successful.

• health.healthGetCache

  Check the Appwrite in-memory cache server is up and connection is successful.

• health.healthGetDb

  Check the Appwrite database server is up and connection is successful.

• health.healthGetQueueCertificates

  Get the number of certificates that are waiting to be issued against Letsencrypt in the Appwrite internal queue server.

• health.healthGetQueueFunctions
• health.healthGetQueueLogs

  Get the number of logs that are waiting to be processed in the Appwrite internal queue server.

• health.healthGetQueueTasks

  Get the number of tasks that are waiting to be processed in the Appwrite internal queue server.

• health.healthGetQueueUsage

  Get the number of usage stats that are waiting to be processed in the Appwrite internal queue server.

• health.healthGetQueueWebhooks

  Get the number of webhooks that are waiting to be processed in the Appwrite internal queue server.

• health.healthGetStorageLocal

  Check the Appwrite local storage device is up and connection is successful.

• health.healthGetTime

  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 (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.

• locale.localeGet

  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.

  (IP Geolocation by DB-IP)

• locale.localeGetContinents

  List of all continents. You can use the locale header to get the data in a supported language.

• locale.localeGetCountries

  List of all countries. You can use the locale header to get the data in a supported language.

• locale.localeGetCountriesEu

  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.

• locale.localeGetCountriesPhones

  List of all countries phone codes. You can use the locale header to get the data in a supported language.

• locale.localeGetCurrencies

  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.

• locale.localeGetLanguages

  List of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.

• storage.storageCreateFile

  Create a new file. The user who creates the file will automatically be assigned to read and write access unless he has passed custom values for read and write arguments.

• storage.storageDeleteFile

  Delete a file by its unique ID. Only users with write permissions have access to delete this resource.

• storage.storageGetFile

  Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.

• storage.storageGetFileDownload

  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.

• storage.storageGetFilePreview

  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.

• storage.storageGetFileView

  Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.

• storage.storageListFiles

  Get a list of all the user files. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's files. Learn more about different API modes.

• storage.storageUpdateFile

  Update a file by its unique ID. Only users with write permissions have access to update this resource.

• teams.teamsCreate

  Create a new team. The user who creates the team will automatically be assigned as the owner of the team. The team owner can invite new members, who will be able add new owners and update or delete the team from your project.

• teams.teamsCreateMembership

  Use this endpoint to invite a new member to join your team. If initiated from Client SDK, an email with a link to join the team will be sent to the new member's email address if the member doesn't exist in the project it will be created automatically. If initiated from server side SDKs, new member will automatically be added to the team.

  Use the 'URL' parameter to redirect the user from the invitation email back to your app. When the user is redirected, use the Update Team Membership Status endpoint to allow the user to accept the invitation to the team. While calling from side SDKs the redirect url can be empty string.

  Please note that in order to avoid a Redirect Attacks the only valid redirect URL's are the once from domains you have set when added your platforms in the console interface.

• teams.teamsDelete

  Delete a team by its unique ID. Only team owners have write access for this resource.

• teams.teamsDeleteMembership

  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.

• teams.teamsGet

  Get a team by its unique ID. All team members have read access for this resource.

• teams.teamsGetMemberships

  Get a team members by the team unique ID. All team members have read access for this list of resources.

• teams.teamsList

  Get a list of all the current user teams. You can use the query params to filter your results. On admin mode, this endpoint will return a list of all of the project's teams. Learn more about different API modes.

• teams.teamsUpdate

  Update a team by its unique ID. Only team owners have write access for this resource.

• teams.teamsUpdateMembershipRoles
• teams.teamsUpdateMembershipStatus

  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 recieved by the user.

• users.usersCreate

  Create a new user.

• users.usersDelete

  Delete a user by its unique ID.

• users.usersDeleteSession

  Delete a user sessions by its unique ID.

• users.usersDeleteSessions

  Delete all user's sessions by using the user's unique ID.

• users.usersGet

  Get a user by its unique ID.

• users.usersGetLogs

  Get a user activity logs list by its unique ID.

• users.usersGetPrefs

  Get the user preferences by its unique ID.

• users.usersGetSessions

  Get the user sessions list by its unique ID.

• users.usersList

  Get a list of all the project's users. You can use the query params to filter your results.

• users.usersUpdatePrefs

  Update the user preferences by its unique ID. You can pass only the specific settings you wish to update.

• users.usersUpdateStatus

  Update the user status by its unique ID.

• users.usersUpdateVerification

  Update the user email verification status by its unique ID.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools