Skip to content

docs: Add API key permissions #361

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

Merged
wints merged 7 commits into from
Jun 15, 2026
Merged

docs: Add API key permissions #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
833ce65
docs: Add API key permissions page
sejla May 27, 2026
e43d625
docs: Enumerate all endpoints in API key permissions table
sejla May 28, 2026
f4c807c
docs: Update API key permissions page with scopes and screenshots
sejla Jun 11, 2026
b5b57df
docs(openapi): Document scope-based 403 on scoped endpoints
sejla Jun 11, 2026
23dbc58
docs: Move API key permissions into Managing API keys page
wints Jun 15, 2026
b764ec4
docs: Refine API key permissions section and add changelog entry
wints Jun 15, 2026
7b45a25
docs: Constrain API key permissions screenshot widths
wints Jun 15, 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
Binary file added _assets/images/api-key-permissions-badge-hover.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _assets/images/api-key-permissions-badges.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _assets/images/api-key-permissions-create.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _assets/images/api-key-permissions-edit-dialog.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _assets/images/api-key-permissions-edit-menu.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
54 changes: 32 additions & 22 deletions api-reference/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -993,7 +993,7 @@
"$ref": "#/components/responses/BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -1165,7 +1165,7 @@
"$ref": "#/components/responses/BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -1320,7 +1320,7 @@
"$ref": "#/components/responses/BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -1413,7 +1413,7 @@
"$ref": "#/components/responses/BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound404DocTransDownload"
Expand Down Expand Up @@ -2743,7 +2743,7 @@
"$ref": "#/components/responses/BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
Expand Down Expand Up @@ -2872,7 +2872,7 @@
"$ref": "#/components/responses/BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"413": {
"$ref": "#/components/responses/PayloadTooLarge"
Expand Down Expand Up @@ -2975,7 +2975,7 @@
"$ref": "#/components/responses/BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -3217,7 +3217,7 @@
"$ref": "#/components/responses/BadRequest"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -3377,7 +3377,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
Expand Down Expand Up @@ -3593,7 +3593,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
Expand Down Expand Up @@ -3705,7 +3705,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
Expand Down Expand Up @@ -3787,7 +3787,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
Expand Down Expand Up @@ -3903,7 +3903,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"429": {
"$ref": "#/components/responses/TooManyRequests"
Expand Down Expand Up @@ -3960,7 +3960,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -4033,7 +4033,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -4084,7 +4084,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -4162,7 +4162,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -4256,7 +4256,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -4325,7 +4325,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -4422,7 +4422,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -4479,7 +4479,7 @@
"$ref": "#/components/responses/Unauthorized"
},
"403": {
"$ref": "#/components/responses/Forbidden"
"$ref": "#/components/responses/ForbiddenScoped"
},
"404": {
"$ref": "#/components/responses/NotFound"
Expand Down Expand Up @@ -5405,8 +5405,18 @@
}
}
},
"ForbiddenScoped": {
"description": "Authorization failed. Please supply a valid `DeepL-Auth-Key` via the `Authorization` header. This error is also returned when the API key is scoped but does not include the scope required for this endpoint.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ErrorResponse"
}
}
}
},
"ForbiddenGlossaries": {
"description": "Forbidden. The access to the requested resource is denied, because of insufficient access rights."
"description": "Forbidden. The access to the requested resource is denied, because of insufficient access rights. This error is also returned when the API key is scoped but does not include the scope required for this endpoint."
},
"NotFound": {
"description": "The requested resource could not be found.",
Expand Down
Loading
Loading