Docs

API Keys

Using your API Keys, you can access Appwrite services using the SDK of your choice. To create a new API key, go to your API keys tab in your project setting using your Appwrite console and click the 'Add API Key' button.

When adding a new API Key, you can choose which permission scope to grant your application. It is a best practice to allow only the permissions you need to meet your project goals.

If you need to replace your API Key, create a new key, update your app credentials and, once ready, delete your old key.

Scopes

Name Description
users.read Access to read your project's users
users.write Access to create, update, and delete your project's users
teams.read Access to read your project's teams
teams.write Access to create, update, and delete your project's teams
collections.read Access to read your project's database collections
collections.write Access to create, update, and delete your project's database collections
documents.read Access to read your project's database documents
documents.write Access to create, update, and delete your project's database documents
files.read Access to read your project's storage files and preview images
files.write Access to create, update, and delete your project's storage files
functions.read Access to read your project's functions and code tags
functions.write Access to create, update, and delete your project's functions and code tags
execution.read Access to read your project's execution logs
execution.write Access to execute your project's functions
locale.read Access to access your project's Locale service
avatars.read Access to access your project's Avatars service
health.read Access to read your project's health status