langgenius/dify
1
0
Fork 0
mirror of https://github.com/langgenius/dify.git synced 2026-08-24 12:32:54 -04:00
Code Issues 775 Packages Projects Releases 10 Wiki Activity

[PR #6885] fix: Change API key authentication failure response code from 404 to 401 #25481

New Issue
Closed
opened 2026-02-21 20:25:01 -05:00 by yindo · 0 comments
yindo commented 2026-02-21 20:25:01 -05:00
Owner
Copy Link
Copy Source

Original Pull Request: https://github.com/langgenius/dify/pull/6885

State: closed
Merged: Yes

Checklist:

Important

Please review the checklist below before submitting your pull request.

  • Please open an issue before creating a PR or link to an existing issue
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

Description

When calling inner APIs, we use the @inner_api_only decorator. This decorator includes logic to compare the inner API key value provided in the API call with the value set on the server.

Currently, when the API keys do not match, a 404 status code is returned. However, for authentication failures, a 401 status code would be more appropriate and align with common practices.

The current 404 response led to confusion, causing developers to mistakenly believe the inner API URL was incorrectly set, resulting in significant time wasted on debugging.

I propose modifying the response to return a 401 status code for inner api calling authentication failures, which would more accurately represent the nature of the error and improve the developer experience.

⭐️Conclusion:
as-is: 404 for wrong inner api key
to-be: 401 for wrong inner api key

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update, included: Dify Document
  • Improvement, including but not limited to code refactoring, performance optimization, and UI/UX improvement
  • Dependency upgrade

Testing Instructions

This PR literally changed only one character.

**Original Pull Request:** https://github.com/langgenius/dify/pull/6885 **State:** closed **Merged:** Yes --- # Checklist: > [!IMPORTANT] > Please review the checklist below before submitting your pull request. - [X] Please open an issue before creating a PR or link to an existing issue - [X] I have performed a self-review of my own code - [X] I have commented my code, particularly in hard-to-understand areas - [X] I ran `dev/reformat`(backend) and `cd web && npx lint-staged`(frontend) to appease the lint gods # Description When calling inner APIs, we use the @inner_api_only decorator. This decorator includes logic to compare the inner API key value provided in the API call with the value set on the server. Currently, when the API keys do not match, a 404 status code is returned. However, for authentication failures, a 401 status code would be more appropriate and align with common practices. The current 404 response led to confusion, causing developers to mistakenly believe the inner API URL was incorrectly set, resulting in significant time wasted on debugging. **I propose modifying the response to return a 401 status code for inner api calling authentication failures**, which would more accurately represent the nature of the error and improve the developer experience. ⭐️Conclusion: as-is: 404 for wrong inner api key to-be: 401 for wrong inner api key ## Type of Change - [X] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) - [ ] This change requires a documentation update, included: [Dify Document](https://github.com/langgenius/dify-docs) - [ ] Improvement, including but not limited to code refactoring, performance optimization, and UI/UX improvement - [ ] Dependency upgrade # Testing Instructions This PR literally changed only one character.
yindo added the pull-request label 2026-02-21 20:25:01 -05:00
yindo closed this issue 2026-02-21 20:25:01 -05:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
Knowledge Pipeline
Proposal
WIP
cloud
dependencies
feat:webapp
good first issue
outdated
performance
pull-request
Mirrored from GitHub Pull Request
 python:uv
refactor
size:L
stale
status: accepting prs
status: blocked
status: in discussion
stt & tts
vulnerablity
web
wont-fix
🌊 feat:workflow
🌚 invalid
🐞 bug
👻 feat:rag
💪 enhancement
📚 documentation
🔨 feat:tools
🙋‍♂️ question
🙏 help wanted
🤔 cant-reproduce
🤖 feat:agent
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
yindo
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: langgenius/dify#25481
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?