Skip to content

docs: Announce API key permissions general availability #375

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wints wants to merge 2 commits into
base: main
Choose a base branch
from
+10 −5
Draft

docs: Announce API key permissions general availability #375

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47b9fba
docs: Announce API key permissions general availability
wints Jun 22, 2026
8fe4b6c
docs: Clarify API key permissions release timing and prior behavior
wints Jun 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/getting-started/managing-api-keys.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,23 +105,23 @@ It's possible to set an API key-level limit to 0, which means the API key will n

### API key permissions

<Warning>
**Private beta.** This feature is currently available to select customers only. To request access, contact your customer success manager or [DeepL support](https://support.deepl.com/hc/en-us/requests/new).
</Warning>

API key permissions let you limit what a developer API key can do. Instead of one key with full access to every endpoint, you can issue keys that are scoped to specific operations, for example a key that can only translate text or a key that can only read glossaries.
API key permissions, introduced in June 2026, let you limit what a developer API key can do. Instead of one key with full access to every endpoint, you can issue keys that are scoped to specific operations, for example a key that can only translate text or a key that can only read glossaries.

Permissions are implemented as scopes. Each scope groups a set of related operations into a single capability you can grant to a key. This section uses "permissions" for the user-facing feature and "scopes" for the technical mechanism.

Permissions are currently supported only for developer API keys. An account can hold any mix of scoped and unrestricted developer keys.

API key permissions are available on the API Pro, API Developer, API Growth, and API Enterprise plans.

**When to use scoped keys**

| **Key Type** | **Choose When** |
| --- | --- |
| **Unrestricted** | A key can access any endpoint and doesn't need to be limited in any way. |
| **Scoped** | A key should have access only to specific endpoints, for example to prevent glossaries from being modified inadvertently. |

Before API key permissions, every DeepL API key behaved like an unrestricted key.

**How scopes work**

Developer keys can be turned into scoped keys by assigning them one or more scopes. Once a key is scoped:
Expand Down
5 changes: 5 additions & 0 deletions docs/resources/roadmap-and-release-notes.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ rss: true
</Update>

<Update label="June 2026">
## June 23 - API Key Permissions General Availability
- [API key permissions](/docs/getting-started/managing-api-keys#api-key-permissions) are now generally available. Scope a developer API key to specific endpoints so it can perform only the operations you allow.
- Available on the API Pro, API Developer, API Growth, and API Enterprise plans.
- Assign scopes when [creating or editing a key](https://www.deepl.com/your-account/keys). A scoped key returns `403 Forbidden` on any endpoint its scopes don't cover.

## June 17 - `latency_optimized` Now Supported for All Features
- The `latency_optimized` model type is now fully compatible with all Translate API features, including:
- [Tag handling v2](/docs/xml-and-html-handling/tag-handling-v2) (`tag_handling_version=v2`)
Expand Down