Document User-Agent header requirement for hosted API#2505
Open
robzolkos wants to merge 1 commit intobasecamp:mainfrom
Open
Document User-Agent header requirement for hosted API#2505robzolkos wants to merge 1 commit intobasecamp:mainfrom
robzolkos wants to merge 1 commit intobasecamp:mainfrom
Conversation
Add a note to the API docs that requests to app.fizzy.do must include a descriptive User-Agent header to avoid being blocked by Cloudflare.
robzolkos
force-pushed
the
document-user-agent-requirement
branch
from
b553d31 to
2a18183
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User-AgentheaderPython's built-in
urlliblibrary sets the User-Agent toPython-urllib/3.xby default. Cloudflare's Browser Integrity Check treats this as a bot signature and blocks the request with a 403 (error code 1010) before it ever reaches the Fizzy application.This isn't something we can fix in application code — the
allow_browser versions: :moderncheck in Rails allows unknown and missing user agents through fine. The blocking happens entirely at the Cloudflare layer. Self-hosted instances won't have this issue since they won't necessarily have the same infrastructure in front of them.Setting a descriptive User-Agent (e.g.,
MyApp/1.0) resolves the issue.Closes #2436