Appwrite

Appwrite: Server

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…

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 95

account

  • GETGet Account/accountGet currently logged in user data as JSON object.
  • DELETEDelete Account/accountDelete 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…
  • PATCHUpdate Account Email/account/emailUpdate currently logged in user account email address. After changing user address, user confirmation status is being reset and a new confirmation mail is…
  • GETGet Account Logs/account/logsGet currently logged in user list of latest security activity logs. Each log returns user IP address, location and date and time of log.
  • PATCHUpdate Account Name/account/nameUpdate currently logged in user account name.
  • PATCHUpdate Account Password/account/passwordUpdate 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…
  • GETGet Account Preferences/account/prefsGet currently logged in user preferences as a key-value object.
  • PATCHUpdate Account Preferences/account/prefsUpdate currently logged in user account preferences. You can pass only the specific settings you wish to update.
  • PUTComplete Password Recovery/account/recoveryUse 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…
  • POSTCreate Password Recovery/account/recoverySends 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…
  • GETGet Account Sessions/account/sessionsGet currently logged in user list of active sessions across different devices.
  • DELETEDelete All Account Sessions/account/sessionsDelete all sessions from the user account and remove any sessions cookies from the end client.
  • GETGet Session By ID/account/sessions/:sessionIdUse this endpoint to get a logged in user's session using a Session ID. Inputting 'current' will return the current session being used.
  • DELETEDelete Account Session/account/sessions/:sessionIdUse 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…
  • PUTComplete Email Verification/account/verificationUse 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…
  • POSTCreate Email Verification/account/verificationUse 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…

avatars

  • GETGet Browser Icon/avatars/browsers/:code?width=100&height=100&quality=100You 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…
  • GETGet Credit Card Icon/avatars/credit-cards/:code?width=100&height=100&quality=100The 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.
  • GETGet Favicon/avatars/favicon?url=https://example.comUse this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL.
  • GETGet Country Flag/avatars/flags/:code?width=100&height=100&quality=100You 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…
  • GETGet Image from URL/avatars/image?url=https://example.com&width=400&height=400Use 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…
  • GETGet User Initials/avatars/initials?name=&width=500&height=500&color=&background=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…
  • GETGet QR Code/avatars/qr?text=string&size=400&margin=1&download=falseConverts 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

  • GETList Collections/database/collections?search=&limit=25&offset=0&orderType=ASCGet 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…
  • POSTCreate Collection/database/collectionsCreate a new Collection.
  • GETGet Collection/database/collections/:collectionIdGet a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.
  • PUTUpdate Collection/database/collections/:collectionIdUpdate a collection by its unique ID.
  • DELETEDelete Collection/database/collections/:collectionIdDelete a collection by its unique ID. Only users with write permissions have access to delete this resource.
  • GETList Documents/database/collections/:collectionId/documents?filters=&limit=25&offset=0&orderField=&orderType=ASC&orderCast=string&search=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…
  • POSTCreate Document/database/collections/:collectionId/documentsCreate a new Document. Before using this route, you should create a new collection resource using either a server integration API or directly from your…
  • GETGet Document/database/collections/:collectionId/documents/:documentIdGet a document by its unique ID. This endpoint response returns a JSON object with the document data.
  • DELETEDelete Document/database/collections/:collectionId/documents/:documentIdDelete a document by its unique ID. This endpoint deletes only the parent documents, its attributes and relations to other documents. Child documents will not…
  • PATCHUpdate Document/database/collections/:collectionId/documents/:documentIdUpdate a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.

locale

  • GETGet User Locale/localeGet the current user location based on IP. Returns an object with user country code, country name, continent name, continent code, ip address and suggested…
  • GETList Continents/locale/continentsList of all continents. You can use the locale header to get the data in a supported language.
  • GETList Countries/locale/countriesList of all countries. You can use the locale header to get the data in a supported language.
  • GETList EU Countries/locale/countries/euList of all countries that are currently members of the EU. You can use the locale header to get the data in a supported language.
  • GETList Countries Phone Codes/locale/countries/phonesList of all countries phone codes. You can use the locale header to get the data in a supported language.
  • GETList Currencies/locale/currenciesList 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…
  • GETList Languages/locale/languagesList of all languages classified by ISO 639-1 including 2-letter code, name in English, and name in the respective language.

health

  • GETGet HTTP/healthCheck the Appwrite HTTP server is up and responsive.
  • GETGet Anti virus/health/anti-virusCheck the Appwrite Anti Virus server is up and connection is successful.
  • GETGet Cache/health/cacheCheck the Appwrite in-memory cache server is up and connection is successful.
  • GETGet DB/health/dbCheck the Appwrite database server is up and connection is successful.
  • GETGet Certificate Queue/health/queue/certificatesGet the number of certificates that are waiting to be issued against Letsencrypt in the Appwrite internal queue server.
  • GETGet Functions Queue/health/queue/functions
  • GETGet Logs Queue/health/queue/logsGet the number of logs that are waiting to be processed in the Appwrite internal queue server.
  • GETGet Tasks Queue/health/queue/tasksGet the number of tasks that are waiting to be processed in the Appwrite internal queue server.
  • GETGet Usage Queue/health/queue/usageGet the number of usage stats that are waiting to be processed in the Appwrite internal queue server.
  • GETGet Webhooks Queue/health/queue/webhooksGet the number of webhooks that are waiting to be processed in the Appwrite internal queue server.
  • GETGet Local Storage/health/storage/localCheck the Appwrite local storage device is up and connection is successful.
  • GETGet Time/health/timeCheck 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…

storage

  • GETList Files/storage/files?search=&limit=25&offset=0&orderType=ASCGet 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…
  • POSTCreate File/storage/filesCreate 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…
  • GETGet File/storage/files/:fileIdGet a file by its unique ID. This endpoint response returns a JSON object with the file metadata.
  • PUTUpdate File/storage/files/:fileIdUpdate a file by its unique ID. Only users with write permissions have access to update this resource.
  • DELETEDelete File/storage/files/:fileIdDelete a file by its unique ID. Only users with write permissions have access to delete this resource.
  • GETGet File for Download/storage/files/:fileId/downloadGet a file content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading…
  • GETGet File Preview/storage/files/:fileId/preview?width=0&height=0&gravity=center&quality=100&borderWidth=0&borderColor=&borderRadius=0&opacity=1&rotation=0&background=&output=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…
  • GETGet File for View/storage/files/:fileId/viewGet a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.

teams

  • GETList Teams/teams?search=&limit=25&offset=0&orderType=ASCGet 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…
  • POSTCreate Team/teamsCreate 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…
  • GETGet Team/teams/:teamIdGet a team by its unique ID. All team members have read access for this resource.
  • PUTUpdate Team/teams/:teamIdUpdate a team by its unique ID. Only team owners have write access for this resource.
  • DELETEDelete Team/teams/:teamIdDelete a team by its unique ID. Only team owners have write access for this resource.
  • GETGet Team Memberships/teams/:teamId/memberships?search=&limit=25&offset=0&orderType=ASCGet a team members by the team unique ID. All team members have read access for this list of resources.
  • POSTCreate Team Membership/teams/:teamId/membershipsUse 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…
  • DELETEDelete Team Membership/teams/:teamId/memberships/:membershipIdThis 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…
  • PATCHUpdate Membership Roles/teams/:teamId/memberships/:membershipId
  • PATCHUpdate Team Membership Status/teams/:teamId/memberships/:membershipId/statusUse 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

  • GETList Users/users?search=&limit=25&offset=0&orderType=ASCGet a list of all the project's users. You can use the query params to filter your results.
  • POSTCreate User/usersCreate a new user.
  • GETGet User/users/:userIdGet a user by its unique ID.
  • DELETEDelete User/users/:userIdDelete a user by its unique ID.
  • GETGet User Logs/users/:userId/logsGet a user activity logs list by its unique ID.
  • GETGet User Preferences/users/:userId/prefsGet the user preferences by its unique ID.
  • PATCHUpdate User Preferences/users/:userId/prefsUpdate the user preferences by its unique ID. You can pass only the specific settings you wish to update.
  • GETGet User Sessions/users/:userId/sessionsGet the user sessions list by its unique ID.
  • DELETEDelete User Sessions/users/:userId/sessionsDelete all user's sessions by using the user's unique ID.
  • DELETEDelete User Session/users/:userId/sessions/:sessionIdDelete a user sessions by its unique ID.
  • PATCHUpdate User Status/users/:userId/statusUpdate the user status by its unique ID.
  • PATCHUpdate Email Verification/users/:userId/verificationUpdate the user email verification status by its unique ID.

functions

  • GETList Functions/functions?search=&limit=25&offset=0&orderType=ASCGet a list of all the project's functions. You can use the query params to filter your results.
  • POSTCreate Function/functionsCreate 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.
  • GETGet Function/functions/:functionIdGet a function by its unique ID.
  • PUTUpdate Function/functions/:functionIdUpdate function by its unique ID.
  • DELETEDelete Function/functions/:functionIdDelete a function by its unique ID.
  • GETList Executions/functions/:functionId/executions?search=&limit=25&offset=0&orderType=ASCGet 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…
  • POSTCreate Execution/functions/:functionId/executionsTrigger 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…
  • GETGet Execution/functions/:functionId/executions/:executionIdGet a function execution log by its unique ID.
  • PATCHUpdate Function Tag/functions/:functionId/tagUpdate 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.
  • GETList Tags/functions/:functionId/tags?search=&limit=25&offset=0&orderType=ASCGet a list of all the project's code tags. You can use the query params to filter your results.
  • POSTCreate Tag/functions/:functionId/tagsCreate 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…
  • GETGet Tag/functions/:functionId/tags/:tagIdGet a code tag by its unique ID.
  • DELETEDelete Tag/functions/:functionId/tags/:tagIdDelete a code tag by its unique ID.

API details

Base URL
https://appwrite.io/v1
Authentication
An API key in the X-Appwrite-JWT header
An API key in the X-Appwrite-Key header
An API key in the X-Appwrite-Locale header
An API key in the X-Appwrite-Project header
Operations
95 operations on 65 pathsGET 54DELETE 13POST 11PATCH 11PUT 6
Main resources
account 16functions 13health 12users 12database 10teams 10storage 8avatars 7locale 7
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 0.9.3
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the Appwrite: Server in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Appwrite: Server collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-Appwrite-JWT header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Get Account” (GET /account), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Appwrite: Server?

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… It is listed under Developer tools and has 95 endpoints.

Who publishes the Appwrite: Server?

It is listed from Appwrite's public API description (an OpenAPI document), not published by Appwrite on Swastik Codes. Anyone who controls appwrite.io can claim the profile by adding a DNS TXT record.

What is the base URL of the Appwrite: Server?

Requests go to https://appwrite.io/v1. Endpoint paths are added to this base URL.

How do I authenticate with the Appwrite: Server?

It accepts 4 methods: an API key in the X-Appwrite-JWT header; an API key in the X-Appwrite-Key header; an API key in the X-Appwrite-Locale header; an API key in the X-Appwrite-Project header.

How many endpoints does the Appwrite: Server have?

95 operations on 65 paths (54 GET, 13 DELETE, 11 POST, 11 PATCH, 6 PUT). The largest groups are account, functions, health, users.

Is forking the Appwrite: Server free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.