Skip to content

Commit 5a310b3

Browse files
atharvadeosthaleatharvadeosthale
committed
improvements to current api keys page
1 parent 30dc6d3 commit 5a310b3

5 files changed

Lines changed: 72 additions & 24 deletions

File tree

‎.optimize-cache.json‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1401,9 +1401,9 @@
14011401
"images/docs/network/pops-map.png": "205ead599703cf47d0df316db8fcc4f48d5eed01508109fc740d17914275e9ab",
14021402
"images/docs/network/regions-map.png": "c65f1423ab19c3048bf8bf93117e8f2e1d13a2bc705c00307de7ee821e5668a1",
14031403
"images/docs/platform/add-platform.png": "5a05bb9d75a8d5270bfa5e67df7e6de20a9fad174476a112b5bdab72e7bdad30",
1404-
"images/docs/platform/create-api-key.png": "36a80b363e6ba8ebd271e830a3b2d0bc766b2ec3e7d46ff481516f1e50ea5b7d",
1404+
"images/docs/platform/create-api-key.png": "7661b3845e13704643f8ff4f763faa8e61efb90878c3ffa7466ece0910b8ecab",
14051405
"images/docs/platform/dark/add-platform.png": "1bb0e7dba22556e64064951882d625532285fa80bed43fd77774f31545a15b0f",
1406-
"images/docs/platform/dark/create-api-key.png": "dbc3ce919f849d09ef7789676d00e954bf364b9b23126b551767b86891c83fb2",
1406+
"images/docs/platform/dark/create-api-key.png": "f15696f0b28dfc46813d7185be11da8be89da72be66b1894cfcc7227036e4afa",
14071407
"images/docs/platform/dark/execution-details.png": "c0481ddc206447460f9d317ba8d421615066f67a50bc9ef41a8f71766ecffb14",
14081408
"images/docs/platform/execution-details.png": "ece1364b8b00254bbd982421b6eed6d7f519d34c4e80377fcaaa4cb5d5dd3f89",
14091409
"images/docs/quick-starts/add-platform.png": "3b13ba983ea1d2529a1f34a719acef903ec0b58879ed511012280a28ccbde17e",

‎src/lib/generated/github-stars.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"stars": 55439,
3-
"fetchedAt": "2026-03-31T17:11:12.839Z"
4-
}
2+
"stars": 55642,
3+
"fetchedAt": "2026-04-09T19:45:59.241Z"
4+
}

‎src/routes/docs/advanced/platform/api-keys/+page.markdoc‎

Lines changed: 67 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -153,38 +153,60 @@ If you need to replace your API Key, create a new key, update your app credentia
153153

154154
# Scopes {% #scopes %}
155155

156+
When adding a new API key, you choose which scopes to grant. Scopes are grouped by service, matching the categories shown in the Appwrite Console.
157+
158+
{% accordion %}
159+
{% accordion_item title="Auth" %}
160+
156161
| Name | Description |
157162
|-----------------------|---------------------------------------------------------------------------------|
158163
| `sessions.write` | Access to create, update, and delete user sessions |
159164
| `users.read` | Access to read your project's users |
160165
| `users.write` | Access to create, update, and delete your project's users |
161166
| `teams.read` | Access to read your project's teams |
162167
| `teams.write` | Access to create, update, and delete your project's teams |
168+
169+
{% /accordion_item %}
170+
{% accordion_item title="Database" %}
171+
172+
| Name | Description |
173+
|-----------------------|---------------------------------------------------------------------------------|
163174
| `databases.read` | Access to read your project's databases |
164175
| `databases.write` | Access to create, update, and delete your project's databases |
165176
| `tables.read` | Access to read your project's database tables |
166177
| `tables.write` | Access to create, update, and delete your project's database tables |
167-
| `columns.read` | Access to read your project's database table's columns |
168-
| `columns.write` | Access to create, update, and delete your project's database table's columns |
169-
| `indexes.read` | Access to read your project's database table's indexes |
170-
| `indexes.write` | Access to create, update, and delete your project's database table's indexes |
178+
| `columns.read` | Access to read your project's database table columns |
179+
| `columns.write` | Access to create, update, and delete your project's database table columns |
180+
| `indexes.read` | Access to read your project's database table indexes |
181+
| `indexes.write` | Access to create, update, and delete your project's database table indexes |
171182
| `rows.read` | Access to read your project's database rows |
172183
| `rows.write` | Access to create, update, and delete your project's database rows |
173-
| `files.read` | Access to read your project's storage files and preview images |
174-
| `files.write` | Access to create, update, and delete your project's storage files |
175-
| `buckets.read` | Access to read your project's storage buckets |
176-
| `buckets.write` | Access to create, update, and delete your project's storage buckets |
184+
185+
{% /accordion_item %}
186+
{% accordion_item title="Functions" %}
187+
188+
| Name | Description |
189+
|-----------------------|---------------------------------------------------------------------------------|
177190
| `functions.read` | Access to read your project's functions and code deployments |
178191
| `functions.write` | Access to create, update, and delete your project's functions and code deployments|
179-
| `sites.read` | Access to read your project's sites and deployments |
180-
| `sites.write` | Access to create, update, and delete your project's sites and deployments |
181-
| `log.read` | Access to read your site's logs |
182-
| `log.write` | Access to update, and delete your site's logs |
183192
| `execution.read` | Access to read your project's execution logs |
184193
| `execution.write` | Access to execute your project's functions |
185-
| `locale.read` | Access to access your project's Locale service |
186-
| `avatars.read` | Access to access your project's Avatars service |
187-
| `health.read` | Access to read your project's health status |
194+
195+
{% /accordion_item %}
196+
{% accordion_item title="Storage" %}
197+
198+
| Name | Description |
199+
|-----------------------|---------------------------------------------------------------------------------|
200+
| `files.read` | Access to read your project's storage files and preview images |
201+
| `files.write` | Access to create, update, and delete your project's storage files |
202+
| `buckets.read` | Access to read your project's storage buckets |
203+
| `buckets.write` | Access to create, update, and delete your project's storage buckets |
204+
205+
{% /accordion_item %}
206+
{% accordion_item title="Messaging" %}
207+
208+
| Name | Description |
209+
|-----------------------|---------------------------------------------------------------------------------|
188210
| `providers.read` | Access to read your project's providers |
189211
| `providers.write` | Access to create, update, and delete your project's providers |
190212
| `messages.read` | Access to read your project's messages |
@@ -195,12 +217,38 @@ If you need to replace your API Key, create a new key, update your app credentia
195217
| `subscribers.write` | Access to create, update, and delete your project's subscribers |
196218
| `targets.read` | Access to read your project's targets |
197219
| `targets.write` | Access to create, update, and delete your project's targets |
220+
221+
{% /accordion_item %}
222+
{% accordion_item title="Sites" %}
223+
224+
| Name | Description |
225+
|-----------------------|---------------------------------------------------------------------------------|
226+
| `sites.read` | Access to read your project's sites and deployments |
227+
| `sites.write` | Access to create, update, and delete your project's sites and deployments |
228+
| `log.read` | Access to read your site's logs |
229+
| `log.write` | Access to update and delete your site's logs |
230+
231+
{% /accordion_item %}
232+
{% accordion_item title="Other" %}
233+
234+
| Name | Description |
235+
|-----------------------|---------------------------------------------------------------------------------|
236+
| `locale.read` | Access to access your project's Locale service |
237+
| `avatars.read` | Access to access your project's Avatars service |
238+
| `health.read` | Access to read your project's health status |
239+
| `migrations.read` | Access to read your project's migrations |
240+
| `migrations.write` | Access to create, update, and delete your project's migrations |
241+
| `tokens.read` | Access to read your project's tokens |
242+
| `tokens.write` | Access to create, update, and delete your project's tokens |
243+
| `webhooks.read` | Access to read your project's webhooks |
244+
| `webhooks.write` | Access to create, update, and delete your project's webhooks |
245+
| `keys.read` | Access to read your project's API keys |
246+
| `keys.write` | Access to create, update, and delete your project's API keys |
198247
| `rules.read` | Access to read your project's proxy rules |
199248
| `rules.write` | Access to create, update, and delete your project's proxy rules |
200-
| `migrations.read` | Access to read your project's migrations |
201-
| `migrations.write` | Access to create, update, and delete your project's migrations. |
202249
| `vcs.read` | Access to read your project's VCS repositories |
203250
| `vcs.write` | Access to create, update, and delete your project's VCS repositories |
204251
| `assistant.read` | Access to read the Assistant service |
205-
| `tokens.read` | Access to read your project's tokens |
206-
| `tokens.write` | Access to create, update, and delete your project's tokens |
252+
253+
{% /accordion_item %}
254+
{% /accordion %}

‎static/images/docs/platform/create-api-key.png‎

-9.19 KB
Loading

‎static/images/docs/platform/dark/create-api-key.png‎

-9.46 KB
Loading

0 commit comments

Comments
 (0)