Appwrite

Create Password Recovery 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](/docs/client/account#accountUpdateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour.

Create Email Verification 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](/docs/client/account#accountUpdateVerification). 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](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.

Delete Account 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.

Delete Account Session 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.

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

Get Account Get currently logged in user data as JSON object.

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

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

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

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

Update Account Email 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.

Update Account Name Update currently logged in user account name.

Update Account Password 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.

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

Complete Password Recovery 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](/docs/client/account#accountCreateRecovery) endpoint. Please 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.

Complete Email Verification 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.

Get Browser Icon 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.

Get Credit Card Icon 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.

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

Get Country Flag 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.

Get Image from URL 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.

Get User Initials 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.

Get QR Code 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.

Create Collection Create a new Collection.

Create Document Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](/docs/server/database#databaseCreateCollection) API or directly from your database console.

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

Delete Document 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.

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

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

List Collections 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](/docs/admin).

List Documents 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](/docs/admin).

Update Collection Update a collection by its unique ID.

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

Create Function Create a new function. You can pass a list of [permissions](/docs/permissions) to allow different project users or team with access to execute the function using the client API.

Create Execution 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.

Create Tag 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](/docs/functions). Use the "command" param to set the entry point used to execute your code.

Delete Function Delete a function by its unique ID.

Delete Tag Delete a code tag by its unique ID.

Get Function Get a function by its unique ID.

Get Execution Get a function execution log by its unique ID.

Get Tag Get a code tag by its unique ID.

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

List Executions 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](/docs/admin).

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

Update Function Update function by its unique ID.

Update Function Tag 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.

Get HTTP Check the Appwrite HTTP server is up and responsive.

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

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

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