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
Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.
Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.
base URLs: https://appwrite.io/v1
auth: a p i k e y
find it by capability: POST /search {"query":{"text":"..."}} returns these
operations with their invocation detail. Connect any agent client.
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](https://appwrite.io/docs)
| method | path | what the vendor says it does |
|---|---|---|
GET | /account | Get Account Get currently logged in user data as JSON object. account |
DELETE | /account | Delete Account Delete a currently logged in user account. Behind the scene, the user record is not deleted but |
PATCH | /account/email | Update Account Email Update currently logged in user account email address. After changing user address, user |
GET | /account/logs | Get Account Logs Get currently logged in user list of latest security activity logs. Each log returns user IP |
PATCH | /account/name | Update Account Name Update currently logged in user account name. account |
PATCH | /account/password | Update Account Password Update currently logged in user password. For validation, user is required to pass in |
GET | /account/prefs | Get Account Preferences Get currently logged in user preferences as a key-value object. account |
PATCH | /account/prefs | Update Account Preferences Update currently logged in user account preferences. You can pass only the specific |
POST | /account/recovery | Create Password Recovery Sends the user an email with a temporary secret key for password reset. When the user |
PUT | /account/recovery | Complete Password Recovery Use this endpoint to complete the user account password reset. Both the **userId** |
GET | /account/sessions | Get Account Sessions Get currently logged in user list of active sessions across different devices. account |
DELETE | /account/sessions | Delete All Account Sessions Delete all sessions from the user account and remove any sessions cookies from the |
GET | /account/sessions/{sessionId} | Get Session By ID Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' |
DELETE | /account/sessions/{sessionId} | Delete Account Session Use this endpoint to log out the currently logged in user from all their account sessio |
POST | /account/verification | Create Email Verification Use this endpoint to send a verification message to your user email address to confi |
PUT | /account/verification | Complete Email Verification Use this endpoint to complete the user email verification process. Use both the ** |
GET | /avatars/browsers/{code} | Get Browser Icon You can use this endpoint to show different browser icons to your users. The code argument re |
GET | /avatars/credit-cards/{code} | Get Credit Card Icon The credit card endpoint will return you the icon of the credit card provider you need. U |
GET | /avatars/favicon | Get Favicon Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL. avatars |
GET | /avatars/flags/{code} | Get Country Flag You can use this endpoint to show different country flags icons to your users. The code argum |
GET | /avatars/image | Get Image from URL Use this endpoint to fetch a remote image URL and crop it to any image size you want. This |
GET | /avatars/initials | Get User Initials Use this endpoint to show your user initials avatar icon on your website or app. By default, |
GET | /avatars/qr | Get QR Code Converts a given plain text to a QR code image. You can use the query parameters to change the siz |
GET | /database/collections | List Collections Get a list of all the user collections. You can use the query params to filter your results. |
POST | /database/collections | Create Collection Create a new Collection. database |
GET | /database/collections/{collectionId} | Get Collection Get a collection by its unique ID. This endpoint response returns a JSON object with the collec |
PUT | /database/collections/{collectionId} | Update Collection Update a collection by its unique ID. database |
DELETE | /database/collections/{collectionId} | Delete Collection Delete a collection by its unique ID. Only users with write permissions have access to delet |
GET | /database/collections/{collectionId}/documents | List Documents Get a list of all the user documents. You can use the query params to filter your results. On a |
POST | /database/collections/{collectionId}/documents | Create Document Create a new Document. Before using this route, you should create a new collection resource us |
GET | /database/collections/{collectionId}/documents/{documentId} | Get Document Get a document by its unique ID. This endpoint response returns a JSON object with the document d |
PATCH | /database/collections/{collectionId}/documents/{documentId} | Update Document Update a document by its unique ID. Using the patch method you can pass only specific fields t |
DELETE | /database/collections/{collectionId}/documents/{documentId} | Delete Document Delete a document by its unique ID. This endpoint deletes only the parent documents, its attri |
GET | /functions | List Functions Get a list of all the project's functions. You can use the query params to filter your results. |
POST | /functions | Create Function Create a new function. You can pass a list of [permissions](/docs/permissions) to allow differ |
GET | /functions/{functionId} | Get Function Get a function by its unique ID. functions |
PUT | /functions/{functionId} | Update Function Update function by its unique ID. functions |
DELETE | /functions/{functionId} | Delete Function Delete a function by its unique ID. functions |
GET | /functions/{functionId}/executions | List Executions Get a list of all the current user function execution logs. You can use the query params to fi |
POST | /functions/{functionId}/executions | Create Execution Trigger a function execution. The returned object will return you the current execution statu |
and 55 more operation(s) in this specification, all searchable.
specification origin: https://appwrite.io/specs/open-api3?platform=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 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](https://appwrite.io/docs)
| method | path | what the vendor says it does |
|---|---|---|
GET | /account | Get Account Get currently logged in user data as JSON object. account |
POST | /account | Create Account Use this endpoint to allow a new user to register a new account in your project. After the user |
DELETE | /account | Delete Account Delete a currently logged in user account. Behind the scene, the user record is not deleted but |
PATCH | /account/email | Update Account Email Update currently logged in user account email address. After changing user address, user |
POST | /account/jwt | Create Account JWT Use this endpoint to create a JSON Web Token. You can use the resulting JWT to authenticate |
GET | /account/logs | Get Account Logs Get currently logged in user list of latest security activity logs. Each log returns user IP |
PATCH | /account/name | Update Account Name Update currently logged in user account name. account |
PATCH | /account/password | Update Account Password Update currently logged in user password. For validation, user is required to pass in |
GET | /account/prefs | Get Account Preferences Get currently logged in user preferences as a key-value object. account |
PATCH | /account/prefs | Update Account Preferences Update currently logged in user account preferences. You can pass only the specific |
POST | /account/recovery | Create Password Recovery Sends the user an email with a temporary secret key for password reset. When the user |
PUT | /account/recovery | Complete Password Recovery Use this endpoint to complete the user account password reset. Both the **userId** |
GET | /account/sessions | Get Account Sessions Get currently logged in user list of active sessions across different devices. account |
POST | /account/sessions | Create Account Session Allow the user to login into their account by providing a valid email and password comb |
DELETE | /account/sessions | Delete All Account Sessions Delete all sessions from the user account and remove any sessions cookies from the |
POST | /account/sessions/anonymous | Create Anonymous Session Use this endpoint to allow a new user to register an anonymous account in your projec |
GET | /account/sessions/oauth2/{provider} | Create Account Session with OAuth2 Allow the user to login to their account using the OAuth2 provider of their |
GET | /account/sessions/{sessionId} | Get Session By ID Use this endpoint to get a logged in user's session using a Session ID. Inputting 'current' |
DELETE | /account/sessions/{sessionId} | Delete Account Session Use this endpoint to log out the currently logged in user from all their account sessio |
POST | /account/verification | Create Email Verification Use this endpoint to send a verification message to your user email address to confi |
PUT | /account/verification | Complete Email Verification Use this endpoint to complete the user email verification process. Use both the ** |
GET | /avatars/browsers/{code} | Get Browser Icon You can use this endpoint to show different browser icons to your users. The code argument re |
GET | /avatars/credit-cards/{code} | Get Credit Card Icon The credit card endpoint will return you the icon of the credit card provider you need. U |
GET | /avatars/favicon | Get Favicon Use this endpoint to fetch the favorite icon (AKA favicon) of any remote website URL. avatars |
GET | /avatars/flags/{code} | Get Country Flag You can use this endpoint to show different country flags icons to your users. The code argum |
GET | /avatars/image | Get Image from URL Use this endpoint to fetch a remote image URL and crop it to any image size you want. This |
GET | /avatars/initials | Get User Initials Use this endpoint to show your user initials avatar icon on your website or app. By default, |
GET | /avatars/qr | Get QR Code Converts a given plain text to a QR code image. You can use the query parameters to change the siz |
GET | /database/collections/{collectionId}/documents | List Documents Get a list of all the user documents. You can use the query params to filter your results. On a |
POST | /database/collections/{collectionId}/documents | Create Document Create a new Document. Before using this route, you should create a new collection resource us |
GET | /database/collections/{collectionId}/documents/{documentId} | Get Document Get a document by its unique ID. This endpoint response returns a JSON object with the document d |
PATCH | /database/collections/{collectionId}/documents/{documentId} | Update Document Update a document by its unique ID. Using the patch method you can pass only specific fields t |
DELETE | /database/collections/{collectionId}/documents/{documentId} | Delete Document Delete a document by its unique ID. This endpoint deletes only the parent documents, its attri |
GET | /functions/{functionId}/executions | List Executions Get a list of all the current user function execution logs. You can use the query params to fi |
POST | /functions/{functionId}/executions | Create Execution Trigger a function execution. The returned object will return you the current execution statu |
GET | /functions/{functionId}/executions/{executionId} | Get Execution Get a function execution log by its unique ID. functions |
GET | /locale | Get User Locale Get the current user location based on IP. Returns an object with user country code, country n |
GET | /locale/continents | List Continents List of all continents. You can use the locale header to get the data in a supported language. |
GET | /locale/countries | List Countries List of all countries. You can use the locale header to get the data in a supported language. l |
GET | /locale/countries/eu | List EU Countries List of all countries that are currently members of the EU. You can use the locale header to |
and 21 more operation(s) in this specification, all searchable.
specification origin: https://appwrite.io/specs/open-api3?platform=client
nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.