Skip to content

fix: send an Apinator User-Agent so Cloudflare doesn't block requests #5

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
toocool merged 1 commit into from
Oct 25, 2026
Merged

fix: send an Apinator User-Agent so Cloudflare doesn't block requests #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions apinator/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
from __future__ import annotations

import json
import platform
import time
import urllib.request
import urllib.error
Expand All @@ -17,6 +18,15 @@
from .errors import ValidationError, AuthenticationError, ApiError


def _user_agent() -> str:
# Imported here because the package's __init__ imports this module.
from . import __version__

# Cloudflare in front of the API blocks urllib's default
# "Python-urllib/x.y" User-Agent (error 1010), so always send our own.
return f"apinator-server-python/{__version__} (Python {platform.python_version()})"


class Apinator:
"""
Apinator server SDK client.
Expand Down Expand Up @@ -229,6 +239,7 @@ def _request(

# Set headers
req.add_header('Content-Type', 'application/json')
req.add_header('User-Agent', _user_agent())
req.add_header('X-Realtime-Key', self.key)
req.add_header('X-Realtime-Timestamp', str(timestamp))
req.add_header('X-Realtime-Signature', signature)
Expand Down
2 changes: 2 additions & 0 deletions tests/test_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ def test_trigger_single_channel(self):
assert f"/apps/{TEST_APP_ID}/events" in request.full_url
assert request.get_header('Content-type') == 'application/json'
assert request.get_header('X-realtime-key') == TEST_KEY
# Cloudflare blocks urllib's default User-Agent (error 1010).
assert request.get_header('User-agent').startswith('apinator-server-python/')

# Verify body
body = json.loads(request.data.decode('utf-8'))
Expand Down
Loading