diff --git a/.optimize-cache.json b/.optimize-cache.json index 6457794265..fb21e2257e 100644 --- a/.optimize-cache.json +++ b/.optimize-cache.json @@ -1401,9 +1401,9 @@ "images/docs/network/pops-map.png": "205ead599703cf47d0df316db8fcc4f48d5eed01508109fc740d17914275e9ab", "images/docs/network/regions-map.png": "c65f1423ab19c3048bf8bf93117e8f2e1d13a2bc705c00307de7ee821e5668a1", "images/docs/platform/add-platform.png": "5a05bb9d75a8d5270bfa5e67df7e6de20a9fad174476a112b5bdab72e7bdad30", - "images/docs/platform/create-api-key.png": "36a80b363e6ba8ebd271e830a3b2d0bc766b2ec3e7d46ff481516f1e50ea5b7d", + "images/docs/platform/create-api-key.png": "7661b3845e13704643f8ff4f763faa8e61efb90878c3ffa7466ece0910b8ecab", "images/docs/platform/dark/add-platform.png": "1bb0e7dba22556e64064951882d625532285fa80bed43fd77774f31545a15b0f", - "images/docs/platform/dark/create-api-key.png": "dbc3ce919f849d09ef7789676d00e954bf364b9b23126b551767b86891c83fb2", + "images/docs/platform/dark/create-api-key.png": "f15696f0b28dfc46813d7185be11da8be89da72be66b1894cfcc7227036e4afa", "images/docs/platform/dark/execution-details.png": "c0481ddc206447460f9d317ba8d421615066f67a50bc9ef41a8f71766ecffb14", "images/docs/platform/execution-details.png": "ece1364b8b00254bbd982421b6eed6d7f519d34c4e80377fcaaa4cb5d5dd3f89", "images/docs/quick-starts/add-platform.png": "3b13ba983ea1d2529a1f34a719acef903ec0b58879ed511012280a28ccbde17e", diff --git a/src/lib/generated/github-stars.json b/src/lib/generated/github-stars.json index bdb7027566..120ba095ee 100644 --- a/src/lib/generated/github-stars.json +++ b/src/lib/generated/github-stars.json @@ -1,4 +1,4 @@ { - "stars": 55439, - "fetchedAt": "2026-03-31T17:11:12.839Z" + "stars": 55642, + "fetchedAt": "2026-04-09T19:45:59.241Z" } diff --git a/src/routes/blog/post/announcing-api-keys-api/+page.markdoc b/src/routes/blog/post/announcing-api-keys-api/+page.markdoc new file mode 100644 index 0000000000..32beaeeec1 --- /dev/null +++ b/src/routes/blog/post/announcing-api-keys-api/+page.markdoc @@ -0,0 +1,103 @@ +--- +layout: post +title: "Announcing the Keys API: Create and manage API keys with Server SDKs" +description: API keys can now be created, updated, and deleted programmatically using Appwrite Server SDKs. Automate key provisioning for CI/CD, multi-tenant setups, and team onboarding workflows. +date: 2026-04-14 +cover: /images/blog/improve-devex-dev-keys/cover.png +timeToRead: 4 +author: matej-baco +category: announcement +featured: false +callToAction: true +--- + +Managing API keys has always required navigating to the Appwrite Console, selecting scopes, and manually creating each key. For a single project, that works. For teams managing multiple environments, onboarding new services, or provisioning keys as part of automated pipelines, it becomes a bottleneck. + +Today, we are announcing the **Keys API**, allowing you to create, update, and delete API keys programmatically through the Appwrite server SDKs. + +# Why this matters + +API keys are the foundation of server-side authentication in Appwrite. Every server SDK call, every CLI operation, and every backend integration depends on them. Being able to manage keys from code opens up workflows that were previously manual: + +- **CI/CD pipelines** that provision scoped keys for each deployment environment +- **Multi-tenant platforms** that create isolated keys per customer with only the scopes they need +- **Team onboarding** where new services get their own keys automatically +- **Key rotation workflows** that create a new key, update credentials, and retire the old one without downtime + +# How it works + +The Keys API introduces two new [API key scopes](/docs/advanced/platform/api-keys#scopes): + +- **`keys.read`** for listing and retrieving API keys +- **`keys.write`** for creating, updating, and deleting API keys + +The methods live on the `Project` service, alongside existing project-level operations like environment variables. + +## Create an API key + +```server-nodejs +import { Client, Project, ID } from 'node-appwrite'; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject('') + .setKey(''); + +const project = new Project(client); + +const key = await project.createKey({ + keyId: ID.unique(), + name: 'Deployment Key', + scopes: ['databases.read', 'databases.write', 'users.read'], + expire: '2026-12-31T23:59:59.000+00:00' +}); +``` + +Each key is created with a specific set of scopes and an optional expiration date. When no expiration is set, the key remains valid indefinitely. + +## Update an API key + +```server-nodejs +const updated = await project.updateKey({ + keyId: '', + name: 'Deployment Key (updated)', + scopes: ['databases.read', 'users.read'], + expire: '2027-06-30T23:59:59.000+00:00' +}); +``` + +Use this to adjust scopes as requirements change, or to extend or shorten a key's expiration window. + +## Delete an API key + +```server-nodejs +await project.deleteKey({ + keyId: '' +}); +``` + +Once deleted, the key immediately stops authenticating API calls. + +# Bootstrap requirement + +To use the Keys API, you need an existing API key with the `keys.read` and `keys.write` scopes. This initial key must be created through the Appwrite Console. Once you have it, all subsequent key management can be done programmatically. + +# Full SDK support + +The Keys API is available across all Appwrite Server SDKs. Complete code examples for every supported language are available in the [API keys documentation](/docs/advanced/platform/api-keys#manage-api-keys-with-a-server-sdk). + +# Get started + +The Keys API is available on **Appwrite Cloud** today. + +1. Navigate to **Overview** > **Integration** > **API keys** and create an API key with the `keys.read` and `keys.write` scopes. +2. Initialize a Server SDK with your API key. +3. Use the `Project` service to manage keys from code. + +Full documentation is available on the [API keys documentation page](/docs/advanced/platform/api-keys). + +# Resources + +- [API keys documentation](/docs/advanced/platform/api-keys) +- [API key scopes reference](/docs/advanced/platform/api-keys#scopes) +- [How to leverage dynamic API keys for better security](/blog/post/how-to-leverage-dynamic-api-keys-for-better-security) diff --git a/src/routes/changelog/(entries)/2026-04-14.markdoc b/src/routes/changelog/(entries)/2026-04-14.markdoc new file mode 100644 index 0000000000..c0908e8d6d --- /dev/null +++ b/src/routes/changelog/(entries)/2026-04-14.markdoc @@ -0,0 +1,14 @@ +--- +layout: changelog +title: "Keys API: manage API keys with Server SDKs" +date: 2026-04-14 +cover: /images/blog/improve-devex-dev-keys/cover.png +--- + +API keys can now be created, updated, and deleted programmatically using the Appwrite server SDKs. Two new API key scopes, `keys.read` and `keys.write`, control access to the new endpoints. + +This enables automated key provisioning for CI/CD pipelines, multi-tenant platforms, key rotation workflows, and any scenario where managing keys through the Console is not practical. + +{% arrow_link href="/blog/post/announcing-api-keys-api" %} +Read the announcement +{% /arrow_link %} diff --git a/src/routes/docs/advanced/platform/api-keys/+page.markdoc b/src/routes/docs/advanced/platform/api-keys/+page.markdoc index 5faf72dbd4..fe464f5762 100644 --- a/src/routes/docs/advanced/platform/api-keys/+page.markdoc +++ b/src/routes/docs/advanced/platform/api-keys/+page.markdoc @@ -85,7 +85,7 @@ client.set_key('') # Your API key ``` ```server-deno -import { Client } from 'npm:appwrite'; +import { Client } from 'npm:node-appwrite'; const client = new Client() .setEndpoint('https://.cloud.appwrite.io/v1') @@ -148,11 +148,735 @@ let client = Client::new() ``` {% /multicode %} -When adding a new API Key, you can choose which [scopes](#scopes) to grant your application. +When adding a new API Key, you can choose which [scopes](#scopes) to grant your application. If you need to replace your API Key, create a new key, update your app credentials and, once ready, delete your old key. +# Manage API keys with a Server SDK {% #manage-api-keys-with-a-server-sdk %} + +You can also manage API keys programmatically using a Server SDK. This requires an API key with the `keys.read` and `keys.write` [scopes](#scopes). + +## Create an API key {% #create-an-api-key %} + +{% multicode %} +```server-nodejs +import { Client, Project, ID } from 'node-appwrite'; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject('') + .setKey(''); + +const project = new Project(client); + +const result = await project.createKey({ + keyId: ID.unique(), + name: 'My API Key', + scopes: ['databases.read', 'databases.write'], + expire: '2026-12-31T23:59:59.000+00:00' +}); +``` +```server-deno +import { Client, Project, ID } from "npm:node-appwrite"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject('') + .setKey(''); + +const project = new Project(client); + +const result = await project.createKey({ + keyId: ID.unique(), + name: 'My API Key', + scopes: ['databases.read', 'databases.write'], + expire: '2026-12-31T23:59:59.000+00:00' +}); +``` +```server-php +setEndpoint('https://.cloud.appwrite.io/v1') + ->setProject('') + ->setKey(''); + +$project = new Project($client); + +$result = $project->createKey( + keyId: ID::unique(), + name: 'My API Key', + scopes: ['databases.read', 'databases.write'], + expire: '2026-12-31T23:59:59.000+00:00' +); +``` +```server-python +from appwrite.client import Client +from appwrite.id import ID +from appwrite.services.project import Project + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') +client.set_project('') +client.set_key('') + +project = Project(client) + +result = project.create_key( + key_id=ID.unique(), + name='My API Key', + scopes=['databases.read', 'databases.write'], + expire='2026-12-31T23:59:59.000+00:00' +) +``` +```server-ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') + .set_project('') + .set_key('') + +project = Project.new(client) + +response = project.create_key( + key_id: ID.unique(), + name: 'My API Key', + scopes: ['databases.read', 'databases.write'], + expire: '2026-12-31T23:59:59.000+00:00' +) +``` +```server-dotnet +using Appwrite; +using Appwrite.Services; +using Appwrite.Models; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") + .SetProject("") + .SetKey(""); + +Project project = new Project(client); + +var result = await project.CreateKey( + keyId: ID.Unique(), + name: "My API Key", + scopes: new List {"databases.read", "databases.write"}, + expire: "2026-12-31T23:59:59.000+00:00" +); +``` +```server-dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject('') + .setKey(''); + +Project project = Project(client); + +final result = await project.createKey( + keyId: ID.unique(), + name: 'My API Key', + scopes: ['databases.read', 'databases.write'], + expire: '2026-12-31T23:59:59.000+00:00', +); +``` +```server-kotlin +import io.appwrite.Client +import io.appwrite.ID +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") + .setProject("") + .setKey("") + +val project = Project(client) + +val result = project.createKey( + keyId = ID.unique(), + name = "My API Key", + scopes = listOf("databases.read", "databases.write"), + expire = "2026-12-31T23:59:59.000+00:00" +) +``` +```server-java +import io.appwrite.Client; +import io.appwrite.ID; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") + .setProject("") + .setKey(""); + +Project project = new Project(client); + +project.createKey( + ID.unique(), // keyId + "My API Key", // name + List.of("databases.read", "databases.write"), // scopes + "2026-12-31T23:59:59.000+00:00", // expire + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + System.out.println(result); + }) +); +``` +```server-swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") + .setProject("") + .setKey("") + +let project = Project(client) + +let result = try await project.createKey( + keyId: ID.unique(), + name: "My API Key", + scopes: ["databases.read", "databases.write"], + expire: "2026-12-31T23:59:59.000+00:00" +) +``` +```server-go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/appwrite" + "github.com/appwrite/sdk-for-go/id" +) + +func main() { + client := appwrite.NewClient( + appwrite.WithEndpoint("https://.cloud.appwrite.io/v1"), + appwrite.WithProject(""), + appwrite.WithKey(""), + ) + + project := appwrite.NewProject(client) + result, err := project.CreateKey( + id.Unique(), + "My API Key", + []string{"databases.read", "databases.write"}, + project.WithCreateKeyExpire("2026-12-31T23:59:59.000+00:00"), + ) + + if err != nil { + panic(err) + } + + fmt.Println(result) +} +``` +```server-rust +use appwrite::Client; +use appwrite::id::ID; +use appwrite::services::project::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new() + .set_endpoint("https://.cloud.appwrite.io/v1") + .set_project("") + .set_key(""); + + let project = Project::new(&client); + + let result = project.create_key( + ID::unique(), // key_id + "My API Key", // name + Some(vec!["databases.read".to_string(), "databases.write".to_string()]), // scopes + Some("2026-12-31T23:59:59.000+00:00"), // expire + ).await?; + + println!("{:?}", result); + Ok(()) +} +``` +{% /multicode %} + +## Update an API key {% #update-an-api-key %} + +{% multicode %} +```server-nodejs +import { Client, Project } from 'node-appwrite'; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject('') + .setKey(''); + +const project = new Project(client); + +const result = await project.updateKey({ + keyId: '', + name: 'Updated Key', + scopes: ['databases.read', 'databases.write', 'users.read'], + expire: '2027-06-30T23:59:59.000+00:00' +}); +``` +```server-deno +import { Client, Project } from "npm:node-appwrite"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject('') + .setKey(''); + +const project = new Project(client); + +const result = await project.updateKey({ + keyId: '', + name: 'Updated Key', + scopes: ['databases.read', 'databases.write', 'users.read'], + expire: '2027-06-30T23:59:59.000+00:00' +}); +``` +```server-php +setEndpoint('https://.cloud.appwrite.io/v1') + ->setProject('') + ->setKey(''); + +$project = new Project($client); + +$result = $project->updateKey( + keyId: '', + name: 'Updated Key', + scopes: ['databases.read', 'databases.write', 'users.read'], + expire: '2027-06-30T23:59:59.000+00:00' +); +``` +```server-python +from appwrite.client import Client +from appwrite.services.project import Project + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') +client.set_project('') +client.set_key('') + +project = Project(client) + +result = project.update_key( + key_id='', + name='Updated Key', + scopes=['databases.read', 'databases.write', 'users.read'], + expire='2027-06-30T23:59:59.000+00:00' +) +``` +```server-ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') + .set_project('') + .set_key('') + +project = Project.new(client) + +response = project.update_key( + key_id: '', + name: 'Updated Key', + scopes: ['databases.read', 'databases.write', 'users.read'], + expire: '2027-06-30T23:59:59.000+00:00' +) +``` +```server-dotnet +using Appwrite; +using Appwrite.Services; +using Appwrite.Models; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") + .SetProject("") + .SetKey(""); + +Project project = new Project(client); + +var result = await project.UpdateKey( + keyId: "", + name: "Updated Key", + scopes: new List {"databases.read", "databases.write", "users.read"}, + expire: "2027-06-30T23:59:59.000+00:00" +); +``` +```server-dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject('') + .setKey(''); + +Project project = Project(client); + +final result = await project.updateKey( + keyId: '', + name: 'Updated Key', + scopes: ['databases.read', 'databases.write', 'users.read'], + expire: '2027-06-30T23:59:59.000+00:00', +); +``` +```server-kotlin +import io.appwrite.Client +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") + .setProject("") + .setKey("") + +val project = Project(client) + +val result = project.updateKey( + keyId = "", + name = "Updated Key", + scopes = listOf("databases.read", "databases.write", "users.read"), + expire = "2027-06-30T23:59:59.000+00:00" +) +``` +```server-java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") + .setProject("") + .setKey(""); + +Project project = new Project(client); + +project.updateKey( + "", // keyId + "Updated Key", // name + List.of("databases.read", "databases.write", "users.read"), // scopes + "2027-06-30T23:59:59.000+00:00", // expire + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + System.out.println(result); + }) +); +``` +```server-swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") + .setProject("") + .setKey("") + +let project = Project(client) + +let result = try await project.updateKey( + keyId: "", + name: "Updated Key", + scopes: ["databases.read", "databases.write", "users.read"], + expire: "2027-06-30T23:59:59.000+00:00" +) +``` +```server-go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/appwrite" +) + +func main() { + client := appwrite.NewClient( + appwrite.WithEndpoint("https://.cloud.appwrite.io/v1"), + appwrite.WithProject(""), + appwrite.WithKey(""), + ) + + project := appwrite.NewProject(client) + result, err := project.UpdateKey( + "", + "Updated Key", + []string{"databases.read", "databases.write", "users.read"}, + project.WithUpdateKeyExpire("2027-06-30T23:59:59.000+00:00"), + ) + + if err != nil { + panic(err) + } + + fmt.Println(result) +} +``` +```server-rust +use appwrite::Client; +use appwrite::services::project::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new() + .set_endpoint("https://.cloud.appwrite.io/v1") + .set_project("") + .set_key(""); + + let project = Project::new(&client); + + let result = project.update_key( + "", // key_id + "Updated Key", // name + Some(vec!["databases.read".to_string(), "databases.write".to_string(), "users.read".to_string()]), // scopes + Some("2027-06-30T23:59:59.000+00:00"), // expire + ).await?; + + println!("{:?}", result); + Ok(()) +} +``` +{% /multicode %} + +## Delete an API key {% #delete-an-api-key %} + +{% multicode %} +```server-nodejs +import { Client, Project } from 'node-appwrite'; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject('') + .setKey(''); + +const project = new Project(client); + +await project.deleteKey({ + keyId: '' +}); +``` +```server-deno +import { Client, Project } from "npm:node-appwrite"; + +const client = new Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject('') + .setKey(''); + +const project = new Project(client); + +await project.deleteKey({ + keyId: '' +}); +``` +```server-php +setEndpoint('https://.cloud.appwrite.io/v1') + ->setProject('') + ->setKey(''); + +$project = new Project($client); + +$project->deleteKey( + keyId: '' +); +``` +```server-python +from appwrite.client import Client +from appwrite.services.project import Project + +client = Client() +client.set_endpoint('https://.cloud.appwrite.io/v1') +client.set_project('') +client.set_key('') + +project = Project(client) + +project.delete_key( + key_id='' +) +``` +```server-ruby +require 'appwrite' + +include Appwrite + +client = Client.new + .set_endpoint('https://.cloud.appwrite.io/v1') + .set_project('') + .set_key('') + +project = Project.new(client) + +project.delete_key( + key_id: '' +) +``` +```server-dotnet +using Appwrite; +using Appwrite.Services; + +Client client = new Client() + .SetEndPoint("https://.cloud.appwrite.io/v1") + .SetProject("") + .SetKey(""); + +Project project = new Project(client); + +await project.DeleteKey( + keyId: "" +); +``` +```server-dart +import 'package:dart_appwrite/dart_appwrite.dart'; + +Client client = Client() + .setEndpoint('https://.cloud.appwrite.io/v1') + .setProject('') + .setKey(''); + +Project project = Project(client); + +await project.deleteKey( + keyId: '', +); +``` +```server-kotlin +import io.appwrite.Client +import io.appwrite.services.Project + +val client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") + .setProject("") + .setKey("") + +val project = Project(client) + +project.deleteKey( + keyId = "" +) +``` +```server-java +import io.appwrite.Client; +import io.appwrite.coroutines.CoroutineCallback; +import io.appwrite.services.Project; + +Client client = new Client() + .setEndpoint("https://.cloud.appwrite.io/v1") + .setProject("") + .setKey(""); + +Project project = new Project(client); + +project.deleteKey( + "", // keyId + new CoroutineCallback<>((result, error) -> { + if (error != null) { + error.printStackTrace(); + return; + } + System.out.println(result); + }) +); +``` +```server-swift +import Appwrite + +let client = Client() + .setEndpoint("https://.cloud.appwrite.io/v1") + .setProject("") + .setKey("") + +let project = Project(client) + +try await project.deleteKey( + keyId: "" +) +``` +```server-go +package main + +import ( + "fmt" + "github.com/appwrite/sdk-for-go/appwrite" +) + +func main() { + client := appwrite.NewClient( + appwrite.WithEndpoint("https://.cloud.appwrite.io/v1"), + appwrite.WithProject(""), + appwrite.WithKey(""), + ) + + project := appwrite.NewProject(client) + _, err := project.DeleteKey( + "", + ) + + if err != nil { + panic(err) + } + + fmt.Println("API key deleted") +} +``` +```server-rust +use appwrite::Client; +use appwrite::services::project::Project; + +#[tokio::main] +async fn main() -> Result<(), Box> { + let client = Client::new() + .set_endpoint("https://.cloud.appwrite.io/v1") + .set_project("") + .set_key(""); + + let project = Project::new(&client); + + project.delete_key( + "", + ).await?; + + Ok(()) +} +``` +{% /multicode %} + # Scopes {% #scopes %} +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. + +{% accordion %} +{% accordion_item title="Auth" %} + | Name | Description | |-----------------------|---------------------------------------------------------------------------------| | `sessions.write` | Access to create, update, and delete user sessions | @@ -160,31 +884,48 @@ If you need to replace your API Key, create a new key, update your app credentia | `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 | + +{% /accordion_item %} +{% accordion_item title="Database" %} + +| Name | Description | +|-----------------------|---------------------------------------------------------------------------------| | `databases.read` | Access to read your project's databases | | `databases.write` | Access to create, update, and delete your project's databases | | `tables.read` | Access to read your project's database tables | | `tables.write` | Access to create, update, and delete your project's database tables | -| `columns.read` | Access to read your project's database table's columns | -| `columns.write` | Access to create, update, and delete your project's database table's columns | -| `indexes.read` | Access to read your project's database table's indexes | -| `indexes.write` | Access to create, update, and delete your project's database table's indexes | +| `columns.read` | Access to read your project's database table columns | +| `columns.write` | Access to create, update, and delete your project's database table columns | +| `indexes.read` | Access to read your project's database table indexes | +| `indexes.write` | Access to create, update, and delete your project's database table indexes | | `rows.read` | Access to read your project's database rows | | `rows.write` | Access to create, update, and delete your project's database rows | -| `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 | -| `buckets.read` | Access to read your project's storage buckets | -| `buckets.write` | Access to create, update, and delete your project's storage buckets | + +{% /accordion_item %} +{% accordion_item title="Functions" %} + +| Name | Description | +|-----------------------|---------------------------------------------------------------------------------| | `functions.read` | Access to read your project's functions and code deployments | | `functions.write` | Access to create, update, and delete your project's functions and code deployments| -| `sites.read` | Access to read your project's sites and deployments | -| `sites.write` | Access to create, update, and delete your project's sites and deployments | -| `log.read` | Access to read your site's logs | -| `log.write` | Access to update, and delete your site's logs | | `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 | + +{% /accordion_item %} +{% accordion_item title="Storage" %} + +| Name | Description | +|-----------------------|---------------------------------------------------------------------------------| +| `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 | +| `buckets.read` | Access to read your project's storage buckets | +| `buckets.write` | Access to create, update, and delete your project's storage buckets | + +{% /accordion_item %} +{% accordion_item title="Messaging" %} + +| Name | Description | +|-----------------------|---------------------------------------------------------------------------------| | `providers.read` | Access to read your project's providers | | `providers.write` | Access to create, update, and delete your project's providers | | `messages.read` | Access to read your project's messages | @@ -195,12 +936,38 @@ If you need to replace your API Key, create a new key, update your app credentia | `subscribers.write` | Access to create, update, and delete your project's subscribers | | `targets.read` | Access to read your project's targets | | `targets.write` | Access to create, update, and delete your project's targets | + +{% /accordion_item %} +{% accordion_item title="Sites" %} + +| Name | Description | +|-----------------------|---------------------------------------------------------------------------------| +| `sites.read` | Access to read your project's sites and deployments | +| `sites.write` | Access to create, update, and delete your project's sites and deployments | +| `log.read` | Access to read your site's logs | +| `log.write` | Access to update and delete your site's logs | + +{% /accordion_item %} +{% accordion_item title="Other" %} + +| Name | Description | +|-----------------------|---------------------------------------------------------------------------------| +| `locale.read` | Access to your project's Locale service | +| `avatars.read` | Access to your project's Avatars service | +| `health.read` | Access to read your project's health status | +| `migrations.read` | Access to read your project's migrations | +| `migrations.write` | Access to create, update, and delete your project's migrations | +| `tokens.read` | Access to read your project's tokens | +| `tokens.write` | Access to create, update, and delete your project's tokens | +| `webhooks.read` | Access to read your project's webhooks | +| `webhooks.write` | Access to create, update, and delete your project's webhooks | +| `keys.read` | Access to read your project's API keys | +| `keys.write` | Access to create, update, and delete your project's API keys | | `rules.read` | Access to read your project's proxy rules | | `rules.write` | Access to create, update, and delete your project's proxy rules | -| `migrations.read` | Access to read your project's migrations | -| `migrations.write` | Access to create, update, and delete your project's migrations. | | `vcs.read` | Access to read your project's VCS repositories | | `vcs.write` | Access to create, update, and delete your project's VCS repositories | | `assistant.read` | Access to read the Assistant service | -| `tokens.read` | Access to read your project's tokens | -| `tokens.write` | Access to create, update, and delete your project's tokens | + +{% /accordion_item %} +{% /accordion %} diff --git a/static/images/docs/platform/create-api-key.png b/static/images/docs/platform/create-api-key.png index 8bacfc477d..58ed528280 100644 Binary files a/static/images/docs/platform/create-api-key.png and b/static/images/docs/platform/create-api-key.png differ diff --git a/static/images/docs/platform/dark/create-api-key.png b/static/images/docs/platform/dark/create-api-key.png index 3111d2ea4b..6377c72eee 100644 Binary files a/static/images/docs/platform/dark/create-api-key.png and b/static/images/docs/platform/dark/create-api-key.png differ