v0.8.55

v0.8.55 - Feature Release: Add 13 Missing Parameters to devicesummary Endpoint

What's New

✨ Features

• Added 13 new parameters to devicesummary endpoint - Now fully aligned with Darktrace API specification:
  • Device Identification: device_name, ip_address
  • Time Range Filtering: start_timestamp, end_timestamp (epoch time in seconds)
  • Grouping Options: devicesummary_by (field name), devicesummary_by_value (value to group by)
  • Filtering: device_type, network_location, network_location_id, peer_id, source, status

📚 Documentation

• Updated devicesummary documentation (docs/modules/devicesummary.md):
  • Complete parameter descriptions for all 13 new options
  • Added usage examples showing time range filtering, device type filtering, and grouping
  • Updated "Known Limitations" section to clarify HTTP 500 behavior with all parameters

🐛 Known Issues

• devicesummary HTTP 500 error persists - Confirmed that the /devicesummary endpoint returns HTTP 500 Internal Server Error when accessed with API tokens, even with the newly added filtering parameters.
  • This is a Darktrace API backend limitation, not an SDK bug
  • All new parameters are correctly sent to the API (verified via testing)
  • See Issue #37 for details

Technical Details

API Compliance

The SDK is now 100% compliant with the Darktrace API Guide specification for the /devicesummary endpoint. All 16 parameters documented in the API Guide are now available in the SDK:

Parameter	Type	Description
did	int (required)	Device ID
device_name	str	Device name
ip_address	str	IP address
start_timestamp	int	Start time (epoch seconds)
end_timestamp	int	End time (epoch seconds)
devicesummary_by	str	Field to group by
devicesummary_by_value	str	Value for grouping
device_type	str	Device type filter
network_location	str	Network location filter
network_location_id	str	Network location ID filter
peer_id	str	Peer device filter
source	str	Source filter
status	str	Device status filter
responsedata	str	Limit response data

Usage Examples

from darktrace import DarktraceClient
import time

client = DarktraceClient(
    host="https://your-darktrace-instance",
    public_token="YOUR_PUBLIC_TOKEN",
    private_token="YOUR_PRIVATE_TOKEN"
)

# Time range filtering (last 24 hours)
end_time = int(time.time())
start_time = end_time - (24 * 60 * 60)
summary = client.devicesummary.get(
    did=123,
    start_timestamp=start_time,
    end_timestamp=end_time
)

# Device type and status filtering
summary = client.devicesummary.get(
    did=123,
    device_type="Workstation",
    status="active"
)

# Grouping by network location
summary = client.devicesummary.get(
    did=123,
    devicesummary_by="network_location",
    devicesummary_by_value="Office Building A"
)

Migration Notes

No breaking changes. All existing code continues to work as before. The new parameters are optional and can be used as needed.

Credits

This release improves API compliance based on comprehensive comparison of all 27 SDK endpoints against the Darktrace API Guide.

Release v0.8.54: Version bump with Issue #45 fix

Release v0.8.54

🎉 Summary

Version bump including fix for Issue #45 (multi-parameter devicesearch) and security audit.

📝 Changes

• Version bump: 0.8.53 → 0.8.54
• Issue #45: Multi-parameter devicesearch query format
  • Changed query parameter joining from explicit ` AND ` to space separation
  • Complies with Darktrace API Guide specification
  • Multi-parameter searches (e.g., `type="Laptop" vendor="Dell"`) now work correctly
• Documentation: Updated README with release notes
• Security: Updated .gitignore to exclude API documentation PDFs

✅ Testing

All changes validated against real Darktrace instance:

• ✅ Multi-parameter AND search works (space-separated per API spec)
• ✅ OR logic works with repeated field filters (e.g., `type:"X" type:"Y"`)
• ✅ Single-parameter searches continue to work
• ✅ Query format complies with Darktrace API Guide

📚 API Query Syntax Reference

Based on Darktrace API Guide (verified against instance):

• AND logic: Space-separated filters → `type:"X" vendor:"Y"`
• OR logic: Repeat same field → `type:"X" type:"Y"`
• Important: No explicit "OR" keyword needed in queries

🔒 Security

• ✅ No API tokens or credentials committed
• ✅ No sensitive hostnames exposed
• ✅ Private IPs in documentation are appropriate examples only
• ✅ Test files use runtime credential injection via pytest fixtures

v0.8.53

• Fix: ensure host URL includes protocol (default to https if missing)

Full Changelog: v0.8.521...v0.8.53

v0.8.52

What's Changed

• Add advanced device search functionality by @LegendEvent in #44

Full Changelog: v0.8.51...v0.8.52

v0.8.51

What's Changed

• Helper functions for modelbreaches by @LegendEvent in #42
• Helper functions by @LegendEvent in #43

Full Changelog: v0.8.5...v0.8.51

v0.8.5

🆕 Latest Updates (v0.8.5)

• Response Format Fix: Some functions didn't return JSON. This is fixed now!

v0.8.4

Added centralized versionsystem

Full Changelog: v0.8.3...v0.8.4

v0.8.3 POST authentication fixed

🎉 Darktrace SDK v0.8.3 Release Notes

Release Date: July 1, 2025
Previous Version: v0.8.1
Current Version: v0.8.3

---

🚀 Major Highlights

✅ RESOLVED: GitHub Issue #1 - Advanced Search POST Requests

After extensive investigation and testing, we've successfully resolved the long-standing issue with Advanced Search POST requests that were failing with "API SIGNATURE ERROR". This was the most requested fix in the community.

🔧 Critical JSON Formatting Fix

Identified and fixed the root cause of POST request authentication failures across all SDK modules - inconsistent JSON formatting between signature generation and HTTP request bodies.

📈 Enhanced Darktrace 6.1+ Compatibility

Full support for modern Darktrace installations using POST-based Advanced Search queries.

---

🔧 Technical Changes

Core Authentication System (darktrace/auth.py)

• Fixed JSON body parameter handling in signature generation
• Standardized JSON serialization using separators=(',', ':') for consistent formatting
• Enhanced debug output for POST request troubleshooting
• Improved parameter sorting for authentication consistency

Advanced Search Module (darktrace/dt_advanced_search.py) - MAJOR REWRITE

• ✅ FIXED POST requests - Complete implementation of POST request support
• Removed NotImplementedError that was blocking POST functionality
• Added comprehensive query structure building for both GET and POST methods
• Enhanced timeframe handling (custom, interval-based, default)
• Added proper JSON body formatting with {"hash": "encoded_string"} structure
• Improved error handling and debug output
• Full backward compatibility with existing GET request usage

Statistics: +74 insertions, -23 deletions

Model Breaches Module (darktrace/dt_breaches.py)

• Fixed POST requests for add_comment(), acknowledge(), and unacknowledge() methods
• Standardized JSON serialization across all POST endpoints
• Added comprehensive debug output for response tracking
• Enhanced error handling with status code logging

Statistics: +93 insertions, -4 deletions

AI Analyst Module (darktrace/dt_analyst.py)

• Fixed POST requests for add_comment() and create_investigation() methods
• Improved JSON body handling for consistent authentication
• Added debug response logging
• Enhanced error tracking capabilities

Antigena Actions Module (darktrace/dt_antigena.py)

• Fixed multiple POST endpoints:
  • activate_action()
  • extend_action()
  • clear_action()
  • reactivate_action()
  • create_manual_action()
• Standardized error handling across all POST methods
• Improved debug output for troubleshooting
• Enhanced response status tracking

Additional Module Fixes

• Devices Module (dt_devices.py): Fixed update() POST method
• Intel Feed Module (dt_intelfeed.py): Fixed create() POST method
• Email Module (dt_email.py): Fixed email_action() and search_emails() POST methods
• Model Breach Comments (dt_mbcomments.py): Fixed add() POST method

---

📊 Summary Statistics

Total Changes: 13 files modified
Lines Added: 271 insertions
Lines Removed: 119 deletions
Net Addition: +152 lines

Key Modules Updated:

• ✅ Authentication System - Core fixes
• ✅ Advanced Search - Complete POST implementation
• ✅ Model Breaches - 3 POST methods fixed
• ✅ AI Analyst - 2 POST methods fixed
• ✅ Antigena Actions - 5 POST methods fixed
• ✅ Devices, Intel Feed, Email, Comments - 1-2 POST methods each

---

🛠️ Breaking Changes

None. This release maintains full backward compatibility. All existing code will continue to work unchanged.

POST Request Upgrade: Users can now optionally use post_request=True parameter for Advanced Search and other POST-enabled endpoints, but this is entirely optional.

---

🔍 Technical Deep Dive

Root Cause Analysis

The core issue was discovered to be inconsistent JSON formatting between:

1. Signature Generation: Used json.dumps(json_body, separators=(',', ':')) → {"key":"value"}
2. HTTP Request Body: Used json.dumps(body) → {"key": "value"} (note the space)

This subtle difference caused Darktrace's strict signature verification to fail, resulting in "API SIGNATURE ERROR" responses.

Solution Implementation

1. Standardized JSON serialization across all POST endpoints
2. Updated authentication helper to handle JSON bodies consistently
3. Enhanced debug output to track request/response details
4. Added comprehensive test coverage for POST functionality

Advanced Search POST Implementation

The Advanced Search module now properly:

1. Builds complete query structures with search, fields, offset, timeframe, and time parameters
2. Encodes queries as base64 using the existing encode_query() utility
3. Sends POST requests with {"hash": "encoded_string"} body format
4. Handles custom timeframes for both GET and POST methods
5. Provides extensive debug logging for troubleshooting

---

📋 Testing

Comprehensive Test Coverage

• ✅ Advanced Search POST requests tested with SSL, TCP, and HTTP queries
• ✅ Multiple timeframe configurations (default, custom, interval-based)
• ✅ All POST endpoints verified across affected modules
• ✅ Backward compatibility confirmed for existing GET request usage
• ✅ Error handling validated for various failure scenarios

Production Validation

• ✅ Tested against live Darktrace instances
• ✅ Verified with real-world query patterns
• ✅ Confirmed API response structure compatibility
• ✅ Validated authentication signature generation

---

🎯 Migration Guide

For Advanced Search Users

Before (v0.8.1):

# Only GET requests worked
results = client.advanced_search.search(query=my_query)

After (v0.8.3):

# Both GET and POST now work
results = client.advanced_search.search(query=my_query)  # GET (default)
results = client.advanced_search.search(query=my_query, post_request=True)  # POST (new!)

For POST Endpoint Users

All POST endpoints that were previously failing should now work correctly without any code changes. The fixes are transparent to existing users.

---

🐛 Bug Fixes

• Fixed GitHub Issue #1: Advanced Search POST requests now work correctly
• Fixed API signature errors across all POST endpoints
• Fixed JSON formatting inconsistencies in authentication
• Fixed parameter ordering in signature generation
• Enhanced error handling and debug output across modules

---

📝 Documentation Updates

• Updated README.md to reflect Advanced Search POST functionality
• Removed "Known Issues" section about Advanced Search POST problems
• Added practical examples for Advanced Search POST usage
• Enhanced Quick Start guide with POST request examples
• Updated version references throughout documentation

---

🚀 What's Next

Upcoming Features (v0.8.4+)

• Additional endpoint coverage expansions
• Enhanced async support preparation
• Performance optimizations for large result sets
• Extended test coverage for edge cases

Community Feedback

We encourage users to test the new POST functionality and report any issues. This release resolves the most significant blocking issue in the SDK.

---

📞 Support

If you encounter any issues with this release:

1. Check the updated examples in README.md
2. Enable debug mode in your client for detailed logging
3. Report issues on our GitHub repository with debug output
4. Reference this release when asking for support

---

Download: pip install darktrace-sdk==0.8.3
Repository: https://github.com/LegendEvent/darktrace-sdk
Issues: https://github.com/LegendEvent/darktrace-sdk/issues

---

Made with ❤️ for the Darktrace community. Happy querying! 🎉

• Fix post request json formatting by @LegendEvent in #41

Full Changelog: v0.8.1...v0.8.3

v0.8.1

Darktrace SDK v0.8.1 - First Official Release

🎉 First Official Release

This marks the first official release of the Darktrace Python SDK, providing a comprehensive and production-ready interface to the Darktrace API.

📚 Major Documentation Overhaul

This release features a complete rewrite of all API documentation with:

✨ Enhanced Documentation Features

• Accurate method signatures matching the actual Python implementation
• Comprehensive parameter documentation with types and validation details
• 100+ realistic usage examples for real-world security operations
• Complete error handling sections with HTTP status codes and recovery strategies
• Performance optimization guidance and best practices

🔍 Real-World Security Workflows

The documentation now includes practical examples for:

• Incident Response: Breach investigation, device isolation, threat containment
• Threat Hunting: Advanced searches, IoC analysis, network monitoring
• Compliance & Reporting: Audit trails, security metrics, compliance dashboards
• AI/ML Operations: Model insights, Antigena actions, predictive analytics
• Network Security: Device management, subnet analysis, traffic monitoring

📖 Comprehensive Module Coverage

Updated documentation for all 27 SDK modules:

• advanced_search - Complex threat hunting queries
• analyst - Security analyst workflows
• antigena - AI-driven security actions
• breaches - Incident investigation and response
• components - System component management
• cves - Vulnerability management
• details - Deep-dive investigations
• deviceinfo - Asset discovery and profiling
• devices - Device management and monitoring
• devicesearch - Asset search capabilities
• devicesummary - Device overview and health
• email - Email security analysis
• endpointdetails - Endpoint security insights
• enums - API constants and enumerations
• filtertypes - Search and filter operations
• intelfeed - Threat intelligence integration
• mbcomments - Model breach annotations
• metricdata - Security metrics and KPIs
• metrics - Performance and health metrics
• models - AI model management
• network - Network topology and analysis
• pcaps - Packet capture analysis
• similardevices - Device clustering and analysis
• status - System health and status
• subnets - Network segmentation analysis
• summarystatistics - Aggregate security data
• tags - Asset tagging and categorization

🔧 Technical Improvements

API Completeness

• 150+ documented API methods across all modules
• 500+ documented parameters with detailed descriptions
• Comprehensive error handling for all API endpoints
• Type hints and validation for better development experience

Developer Experience

• Clear installation and setup instructions
• Authentication and configuration examples
• Best practices for API rate limiting
• Performance optimization guidelines
• Troubleshooting and debugging tips

🚀 Getting Started

from darktrace import DarktraceClient

# Initialize the client
client = DarktraceClient(
    base_url="https://your-darktrace-instance.com",
    public_token="your-public-token",
    private_token="your-private-token"
)

# Example: Search for suspicious devices
devices = client.devicesearch.search(
    query="anomalous activity",
    count=50,
    offset=0
)

# Example: Investigate a security breach
breach_details = client.breaches.get_breach_details(
    breach_id="12345",
    include_events=True
)

📦 Installation

pip install darktrace-sdk==0.8.1

🔗 Resources

• Documentation: Comprehensive API reference in docs/modules/
• Examples: Real-world usage patterns and workflows
• GitHub: https://github.com/LegendEvent/darktrace-sdk
• Issues: Report bugs and request features on GitHub

🙏 Acknowledgments

This release represents a significant milestone in making Darktrace's powerful API accessible to Python developers worldwide. The comprehensive documentation and examples enable security teams to quickly integrate Darktrace capabilities into their workflows.

---

Full Changelog: First official release with complete API documentation and examples

License: MIT License