The official Python SDK for the Generator Labs API v4.0.
- Features
- Prerequisites
- Installation
- Quick Start
- RBL Monitoring
- Contact Management
- Certificate Monitoring
- Pagination
- Webhook Verification
- Rate Limiting
- API Structure
- Development
- Release History
- Contributing
- Support
- License
- Full support for Generator Labs API v4.0
- Automatic retry logic with exponential backoff and
Retry-Afterheader support - Configurable timeouts and retry behavior
- Automatic pagination support for large result sets
- RESTful endpoint design with proper HTTP verbs (GET, POST, PUT, DELETE)
- RBL and DNSBL monitoring
- Contact and contact group management
- Manual RBL checks
- Monitoring profiles and sources
- Type-safe with Python 3.8+ type hints and mypy strict mode
- requests.Session with connection pooling
- Async support (coming soon)
Before using this library, you must have:
- A Generator Labs account - Sign up or Login
- Valid API credentials (Account SID and Auth Token) from the Portal
- Python >= 3.8
Install via pip:
pip install generatorlabsimport generatorlabs
# Basic initialization
client = generatorlabs.Client("your_account_sid", "your_auth_token")
# With custom configuration
config = generatorlabs.Config(
timeout=45, # Request timeout in seconds
connect_timeout=10, # Connection timeout in seconds
max_retries=5, # Maximum retry attempts
retry_backoff=2 # Backoff multiplier (2x: 1s, 2s, 4s, 8s, 16s)
)
client = generatorlabs.Client("your_account_sid", "your_auth_token", config)try:
hosts = client.rbl.hosts.get({"page_size": 10, "page": 1})
print(hosts)
except generatorlabs.Exception as e:
print(e)try:
host = client.rbl.hosts.get("HT1a2b3c4d5e6f7890abcdef1234567890")
print(host)
except generatorlabs.Exception as e:
print(e)try:
result = client.rbl.hosts.create({
"name": "My Mail Server",
"host": "192.168.1.100",
"profile": "RP9f8e7d6c5b4a3210fedcba0987654321",
"contact_group": [
"CG4f3e2d1c0b9a8776655443322110fedc",
"CG5a6b7c8d9e0f1234567890abcdef1234"
],
"tags": ["production", "web"]
})
print(result)
except generatorlabs.Exception as e:
print(e)try:
result = client.rbl.hosts.update("HT1a2b3c4d5e6f7890abcdef1234567890", {
"name": "Updated Mail Server Name",
"tags": ["production", "web"]
})
print(result)
except generatorlabs.Exception as e:
print(e)try:
result = client.rbl.hosts.delete("HT1a2b3c4d5e6f7890abcdef1234567890")
print(result)
except generatorlabs.Exception as e:
print(e)try:
# Pause monitoring
client.rbl.hosts.pause("HT1a2b3c4d5e6f7890abcdef1234567890")
# Resume monitoring
client.rbl.hosts.resume("HT1a2b3c4d5e6f7890abcdef1234567890")
except generatorlabs.Exception as e:
print(e)try:
result = client.rbl.check.start({
"host": "192.168.1.100",
"callback": "https://myserver.com/callback",
"details": 1
})
check_id = result["data"]["id"]
# Get check status
status = client.rbl.check.status(check_id, {"details": 1})
print(status)
except generatorlabs.Exception as e:
print(e)try:
# List all profiles
profiles = client.rbl.profiles.get()
# Get a specific profile
profile = client.rbl.profiles.get("RP9f8e7d6c5b4a3210fedcba0987654321")
# Create a new profile
result = client.rbl.profiles.create({
"name": "My Custom Profile",
"entries": [
"RB1234567890abcdef1234567890abcdef",
"RB0987654321fedcba0987654321fedcba"
]
})
# Update a profile
client.rbl.profiles.update("RP9f8e7d6c5b4a3210fedcba0987654321", {
"name": "Updated Profile Name",
"entries": [
"RB1234567890abcdef1234567890abcdef",
"RB0987654321fedcba0987654321fedcba"
]
})
# Delete a profile
client.rbl.profiles.delete("RP9f8e7d6c5b4a3210fedcba0987654321")
except generatorlabs.Exception as e:
print(e)try:
# List all sources
sources = client.rbl.sources.get()
# Get a specific source
source = client.rbl.sources.get("RB18c470cc518a09678bb280960dbdd524")
# Create a custom source
result = client.rbl.sources.create({
"host": "custom.rbl.example.com",
"type": "rbl",
"custom_codes": ["127.0.0.2", "127.0.0.3"]
})
# Update a source
client.rbl.sources.update("RB18c470cc518a09678bb280960dbdd524", {
"host": "updated.rbl.example.com",
"custom_codes": ["127.0.0.2", "127.0.0.3"]
})
# Delete a source
client.rbl.sources.delete("RB18c470cc518a09678bb280960dbdd524")
except generatorlabs.Exception as e:
print(e)try:
# List contacts
contacts = client.contact.contacts.get()
# Create a contact
result = client.contact.contacts.create({
"contact": "admin@example.com",
"type": "email",
"schedule": "every_check",
"contact_group": [
"CG4f3e2d1c0b9a8776655443322110fedc",
"CG5a6b7c8d9e0f1234567890abcdef1234"
]
})
# Update a contact
client.contact.contacts.update("COabcdef1234567890abcdef1234567890", {
"contact": "updated@example.com",
"contact_group": [
"CG4f3e2d1c0b9a8776655443322110fedc",
"CG5a6b7c8d9e0f1234567890abcdef1234"
]
})
# Confirm a contact
client.contact.contacts.confirm("COabcdef1234567890abcdef1234567890", {
"authcode": "123456"
})
# Delete a contact
client.contact.contacts.delete("COabcdef1234567890abcdef1234567890")
except generatorlabs.Exception as e:
print(e)try:
# List contact groups
groups = client.contact.groups.get()
# Create a contact group
result = client.contact.groups.create({
"name": "Primary Contacts"
})
# Update a contact group
client.contact.groups.update("CG4f3e2d1c0b9a8776655443322110fed", {
"name": "Updated Group Name"
})
# Delete a contact group
client.contact.groups.delete("CG4f3e2d1c0b9a8776655443322110fed")
except generatorlabs.Exception as e:
print(e)Certificate monitoring allows you to monitor SSL/TLS certificates for expiration, validity, and configuration issues across HTTPS, SMTPS, IMAPS, and other TLS-enabled services.
try:
# List all certificate errors
errors = client.cert.errors.get()
# Get a specific error by ID
error = client.cert.errors.get("CE5e6f7a8b9c0d1e2f3a4b5c6d7e8f9a")
print(errors)
except generatorlabs.Exception as e:
print(e)try:
# List all certificate monitors
monitors = client.cert.monitors.get()
# Get a specific monitor
monitor = client.cert.monitors.get("CM62944aeeee2b46d7a28221164f38976a")
# Create a new certificate monitor
monitor = client.cert.monitors.create({
"name": "Production Web Server",
"hostname": "example.com",
"protocol": "https",
"profile": "CP79b597e61a984a35b5eb7dcdbc3de53c",
"contact_group": [
"CG4f3e2d1c0b9a8776655443322110fedc",
"CG5a6b7c8d9e0f1234567890abcdef1234"
],
"tags": ["production", "web", "ssl"]
})
# Update a monitor
monitor = client.cert.monitors.update("CM62944aeeee2b46d7a28221164f38976a", {
"name": "Updated Server Name",
"tags": ["production", "web", "ssl"]
})
# Delete a monitor
client.cert.monitors.delete("CM62944aeeee2b46d7a28221164f38976a")
# Pause monitoring
client.cert.monitors.pause("CM62944aeeee2b46d7a28221164f38976a")
# Resume monitoring
client.cert.monitors.resume("CM62944aeeee2b46d7a28221164f38976a")
except generatorlabs.Exception as e:
print(e)try:
# List all certificate profiles
profiles = client.cert.profiles.get()
# Get a specific profile
profile = client.cert.profiles.get("CP79b597e61a984a35b5eb7dcdbc3de53c")
# Create a new profile
profile = client.cert.profiles.create({
"name": "Standard Certificate Profile",
"expiration_thresholds": [30, 14, 7],
"alert_on_expiration": True,
"alert_on_name_mismatch": True,
"alert_on_misconfigurations": True,
"alert_on_changes": True
})
# Update a profile
profile = client.cert.profiles.update("CP79b597e61a984a35b5eb7dcdbc3de53c", {
"expiration_thresholds": [45, 14, 7],
"alert_on_misconfigurations": True,
"alert_on_changes": True
})
# Delete a profile
client.cert.profiles.delete("CP79b597e61a984a35b5eb7dcdbc3de53c")
except generatorlabs.Exception as e:
print(e)List endpoints return paginated results. You can manually pass page and page_size parameters, or use the get_all() helper to automatically fetch every page and return a flat list of all items:
try:
# Get all hosts across all pages (default page_size: 100)
all_hosts = client.rbl.hosts.get_all()
for host in all_hosts:
print(f"{host['name']} - {host['host']}")
# With a custom page size
all_hosts = client.rbl.hosts.get_all(page_size=50)
except generatorlabs.Exception as e:
print(e)The get_all() method is available on all list endpoints:
client.rbl.hosts.get_all()client.rbl.profiles.get_all()client.rbl.sources.get_all()client.rbl.listings.get_all()client.contact.contacts.get_all()client.contact.groups.get_all()client.cert.monitors.get_all()client.cert.profiles.get_all()client.cert.errors.get_all()
The SDK includes a helper for verifying incoming webhook signatures. Each webhook is assigned a signing secret (available in the Portal), which is used to compute an HMAC-SHA256 signature sent with every request in the X-Webhook-Signature header.
from generatorlabs import Webhook, Exception
header = request.headers.get('X-Webhook-Signature', '')
body = request.get_data(as_text=True)
secret = os.getenv('GENERATOR_LABS_WEBHOOK_SECRET')
try:
payload = Webhook.verify(body, header, secret)
# payload is the decoded event data
print(payload['event'])
except Exception as e:
# Signature verification failed
return jsonify({'error': 'Invalid signature'}), 403The default timestamp tolerance is 5 minutes. You can customize it (in seconds), or pass 0 to disable:
payload = Webhook.verify(body, header, secret, 600) # 10-minute tolerance
payload = Webhook.verify(body, header, secret, 0) # disable timestamp checkSee examples/webhook_verification.py for a complete example.
Full API documentation is available at the Generator Labs Developer Site.
The API enforces two layers of rate limiting:
- Hourly limit: 1,000 requests per hour per application
- Per-second limit: varies by endpoint — 100 RPS for read operations, 50 RPS for write operations, and 20 RPS for manual check start
When a rate limit is exceeded, the API returns HTTP 429 with a Retry-After header indicating how many seconds to wait. The SDK automatically respects this header during retries, falling back to exponential backoff for other retryable errors.
All API responses include IETF draft rate limit headers, accessible via the rate_limit_info attribute on every response:
| Header | Description | Example |
|---|---|---|
RateLimit-Limit |
Active rate limit policies | 1000;w=3600, 100;w=1 |
RateLimit-Remaining |
Requests remaining in the most restrictive window | 95 |
RateLimit-Reset |
Seconds until the most restrictive window resets | 1 |
response = client.rbl.hosts.get()
# Access response data (bracket notation works as before)
hosts = response['data']
# Access rate limit info
if response.rate_limit_info is not None:
print(f"Remaining: {response.rate_limit_info.remaining}")
print(f"Reset: {response.rate_limit_info.reset}s")The v4.0 API follows a RESTful design with three main resource namespaces:
- hosts - List, get, create, update, delete, pause, and resume hosts
- listings - Get currently listed hosts
- check - Start manual checks and get status
- profiles - List, get, create, update, and delete monitoring profiles
- sources - List, get, create, update, delete, pause, and resume RBL sources
- contacts - List, get, create, update, delete, pause, resume, confirm, and resend contacts
- groups - List, get, create, update, and delete contact groups
- errors - List certificate errors and get specific error details
- monitors - List, get, create, update, delete, pause, and resume certificate monitors
- profiles - List, get, create, update, and delete certificate monitoring profiles
pytestmypy generatorlabspytest --cov=generatorlabs --cov-report=term-missing- Complete rewrite for Generator Labs API v4.0
- RESTful endpoint design with proper HTTP verbs
- Updated to use Generator Labs branding (formerly RBLTracker)
- Minimum Python version bumped to 3.8
- Added full pytest test coverage
- Added mypy strict type checking
- Added GitHub Actions CI/CD workflow
- Organized endpoints under
/rbl/,/contact/, and/cert/namespaces - Added support for PUT and DELETE methods
- Improved error handling for v4.0 response format
- Full type hints throughout the codebase
- Automatic
Retry-Afterheader support on 429 rate limit responses Responsewrapper (dict-like) exposes per-request rate limit info (rate_limit_info)- Added
RateLimitInfoclass withlimit,remaining, andresetattributes - Webhook signature verification with HMAC-SHA256 and constant-time comparison
- Automatic pagination via
get_all()for large result sets
- Updated to use the new API endpoint URL
- Added support for Monitoring Profiles
- Added support for the ACLs endpoint
- Initial release
Contributions are welcome! Please feel free to submit a Pull Request.
For questions, issues, or feature requests:
- GitHub Issues: https://github.com/generator-labs/python-sdk/issues
- Email: support@generatorlabs.com
- Documentation: https://docs.generatorlabs.com
This library is released under the MIT License. See LICENSE for details.