Huntsman

User Guide

  • Getting Started
    • Prerequisites
    • Installation
    • Verification
    • Stopping the Application
    • Next Steps
  • Usage
    • Dashboard Overview
    • Threat Detection
    • SuperDB Explorer
    • STIX Visualization
  • Configuration
    • API Recipes
      • Top-Level Keys
      • Authentication
      • Endpoint Configuration
      • Advanced Parameters & Templating
      • Pivots (Extraction Logic)
      • Full Recipe Example
    • Ratelimiting
    • Internal Services
    • IOC Patterns
    • Scraping Recipes
    • RSS Recipes

API Reference

  • REST API Reference
    • Overview
    • Errors
    • Service Discovery
    • Analysis Tasks
    • SuperDB Operations
    • Intelligence & Automation
  • Internal Python Reference
    • Views
      • DashboardView
        • DashboardView.template_name
        • DashboardView.get_context_data()
        • DashboardView.dispatch()
      • AnalysisTriggerView
        • AnalysisTriggerView.post()
      • BulkAnalysisTriggerView
        • BulkAnalysisTriggerView.post()
      • TaskStatusView
        • TaskStatusView.queryset
        • TaskStatusView.serializer_class
        • TaskStatusView.lookup_field
      • TaskListView
        • TaskListView.queryset
        • TaskListView.serializer_class
        • TaskListView.get_queryset()
      • SuperDBQueryView
        • SuperDBQueryView.post()
      • PredefinedQueriesListView
        • PredefinedQueriesListView.get()
      • CreatePoolView
        • CreatePoolView.post()
      • LoadDataToBranchView
        • LoadDataToBranchView.post()
      • ServiceListView
        • ServiceListView.get()
      • HealthCheckView
        • HealthCheckView.get()
        • HealthCheckView.check_database()
        • HealthCheckView.check_celery()
      • BulkTaskStatusView
        • BulkTaskStatusView.post()
      • CorrelationEngineView
        • CorrelationEngineView.post()
        • CorrelationEngineView.get()
      • STIXReportView
        • STIXReportView.post()
      • BulkSTIXReportView
        • BulkSTIXReportView.post()
      • AIAnalysisView
        • AIAnalysisView.post()
    • Serializers
      • AnalysisTaskSerializer
        • AnalysisTaskSerializer.Meta
        • AnalysisTaskSerializer.get_full_result()
      • SuperDBQuerySerializer
      • TaskSubmissionSerializer
      • BulkTaskSubmissionSerializer
      • BulkTaskStatusRequestSerializer
      • LoadDataToBranchSerializer
        • LoadDataToBranchSerializer.validate()
      • CreatePoolSerializer
      • CorrelationEngineSerializer
      • STIXReportSerializer
      • STIXReportItemSerializer
      • BulkSTIXReportSerializer
      • AIAnalysisSerializer
    • Models
      • AnalysisTask
        • AnalysisTask.Status
        • AnalysisTask.id
        • AnalysisTask.celery_task_id
        • AnalysisTask.status
        • AnalysisTask.service_name
        • AnalysisTask.identifier
        • AnalysisTask.identifier_type
        • AnalysisTask.result
        • AnalysisTask.created_at
        • AnalysisTask.completed_at
        • AnalysisTask.DoesNotExist
        • AnalysisTask.MultipleObjectsReturned
        • AnalysisTask.get_next_by_created_at()
        • AnalysisTask.get_previous_by_created_at()
        • AnalysisTask.get_status_display()
        • AnalysisTask.objects
      • ConfigFile
        • ConfigFile.name
        • ConfigFile.path
        • ConfigFile.content
        • ConfigFile.updated_at
        • ConfigFile.save()
        • ConfigFile.DoesNotExist
        • ConfigFile.MultipleObjectsReturned
        • ConfigFile.get_next_by_updated_at()
        • ConfigFile.get_previous_by_updated_at()
        • ConfigFile.id
        • ConfigFile.objects
      • clear_config_cache()
      • Rule
        • Rule.id
        • Rule.uuid
        • Rule.rule_id
        • Rule.name
        • Rule.title
        • Rule.author
        • Rule.description
        • Rule.content
        • Rule.updated_at
        • Rule.save()
        • Rule.DoesNotExist
        • Rule.MultipleObjectsReturned
        • Rule.get_next_by_updated_at()
        • Rule.get_previous_by_updated_at()
        • Rule.objects
    • Tasks
    • Correlation Engine
      • CorrelationRule
        • CorrelationRule.id
        • CorrelationRule.title
        • CorrelationRule.description
        • CorrelationRule.syntax
        • CorrelationRule.author
        • CorrelationRule.source
        • CorrelationRule.tags
        • CorrelationRule.file_path
        • CorrelationRule.execute_query()
      • CorrelationEngine
        • CorrelationEngine.rules_directory_path
        • CorrelationEngine.rules
        • CorrelationEngine.superdb_client
        • CorrelationEngine.load_rules()
        • CorrelationEngine.get_rules()
        • CorrelationEngine.run_correlation_analysis()
      • create_correlation_engine_instance()
    • Configuration
      • refresh_configuration()
      • load_api_recipes()
      • load_scraping_recipes()
      • load_internal_services_recipes()
      • load_rss_recipes()
      • load_ioc_patterns()
      • load_predefined_queries()
      • load_all_recipes()
    • URLs
Huntsman
  • Huntsman Documentation
  • View page source

Huntsman Documentation

Welcome to the Huntsman API documentation.

User Guide

  • Getting Started
    • Prerequisites
    • Installation
    • Verification
    • Stopping the Application
    • Next Steps
  • Usage
    • Dashboard Overview
    • Threat Detection
    • SuperDB Explorer
    • STIX Visualization
  • Configuration
    • API Recipes
    • Ratelimiting
    • Internal Services
    • IOC Patterns
    • Scraping Recipes
    • RSS Recipes

API Reference

  • REST API Reference
    • Overview
    • Errors
    • Service Discovery
    • Analysis Tasks
    • SuperDB Operations
    • Intelligence & Automation
  • Internal Python Reference
    • Views
    • Serializers
    • Models
    • Tasks
    • Correlation Engine
    • Configuration
    • URLs

Indices and tables

  • Index

  • Module Index

  • Search Page

Next

© Copyright 2024, ajtap.

Built with Sphinx using a theme provided by Read the Docs.