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 grant only the permissions you need in order to meed your project goals.

If you need to replace your API Key, just 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 users
users.write Access to create, update, and delete your project users
teams.read Access to read your project teams
teams.write Access to create, update, and delete your project teams
database.read Access to read your project database collections and documents
database.write Access to create, update, and delete your project database collections and documents
storage.files.read Access to read your project storage files data, meta data and preview images
storage.files.write Access to create, update, and delete your project storage files