Skip to main content

Securedns Categoryget

Endpoints Summary

Method Path Swagger GET /securedns_categoryget/ Swagger ↗

The SecureDNS Category API provides access to DNS transaction categorization data, allowing youfunctionality to retrieve the category classificationinformation of specificfor SecureDNS transactions.transactions using their unique identifiers. This endpoint is essential for security monitoring, content filtering analysis, and understanding the natureclassification of DNS requestssecurity processedevents throughand thecan SecureDNSbe service.integrated into security monitoring workflows, reporting systems, and compliance auditing processes.

Base URL: https://control.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The SecureDNS Category API enables youdevelopers to query andthe retrievecategorization categoryof informationSecureDNS transactions by providing a UUID-based lookup mechanism. This API is particularly valuable for security operations teams who need to understand the nature and classification of DNS transactionssecurity events that have been processed through the SecureDNS filtering system. Each DNS transaction is assigned a unique UUID when processed, and this API allows you to look up the category classification associated with that transaction.

Key Features:

  • Transaction Classification: Retrieve detailed category namesinformation for specific SecureDNS transactions
  • Support for UUID-based Lookups: Use unique transaction lookups
Essential for security auditing and DNS filtering analysis Real-time accessidentifiers to transactionget precise categorization data Security Integration: Perfect for SIEM integration, security dashboards, and compliance reporting Real-time Insights: Access category data for immediate security decision-making

Common UseIntegration Cases:Scenarios:

  • Security incident investigationInformation and forensics
Event Management (SIEM) systems pulling DNS filteringsecurity policy analysis and optimization Compliance reporting for web access monitoringclassifications Automated securityincident response workflows that need to categorize DNSDNS-related activitysecurity events IntegrationCompliance with SIEMreporting systems that track DNS security categories for enhancedaudit purposes Security dashboards displaying real-time DNS threat detectioncategorization Forensic analysis tools examining historical DNS security transactions

The category information returned by this API helps classifyorganizations understand the typetypes of content or service associated with DNS requests,security events they're experiencing, enabling better understandingthreat of network traffic patternsintelligence and potentialmore informed security threats.decisions.

Endpoints

GET /securedns_categoryget/

Description: Retrieves the category nameclassification associated withfor a specific SecureDNS transaction identified byusing its UUID. This endpoint is crucialessential for understanding what type of content or service was being accessed in a particular DNS request, making it invaluable for security analysis,event complianceoccurred, reporting,enabling security teams to properly categorize, respond to, and trafficreport classification.on DNS-related security incidents.

Use Cases:

  • InvestigateSIEM suspicioussystems automatically categorizing DNS activitysecurity alerts for proper incident handling
Security analysts investigating specific DNS security transactions during incident response Compliance reporting systems that need to classify DNS security events by looking up transaction categoriescategory Generate reports on types of websites and services accessed through DNS Validate DNS filtering policies by checking categorization accuracy Build automatedAutomated security workflows that respondtrigger different responses based on DNS transaction categories PerformSecurity forensicdashboards analysisdisplaying ofcategorized networkDNS trafficthreat patternsintelligence

Full URL Example:

https://control.zequenze.com/api/v1/securedns_categoryget/?uuid=550e8400-e29b-41d4-a716-446655440000

Parameters:

Parameter Type In Required Description
uuid string query Yes The unique identifier of the SecureDNS transaction to lookretrieve up.category Mustinformation be a valid UUID format.for

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/securedns_categoryget/?uuid=550e8400-e29b-41d4-a716-446655440000" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

[
  {
    "category": "Social Networking"
  }
]

Additional Example Responses:

[
  {
    "category": "Malware"
  }
]

[
  {
    "category": "Business and Economy"malware"
  }
]

Response Codes:

Status Description
200 Category request Ok - Successfully retrievedReturns the category information for the specified transaction
401 Category request not authorized - Invalid or missing APIauthentication token
403 Category request forbidden / not allowed - Valid tokenauthentication but insufficient permissions
404 Provided UUID don't match any transaction - The specified UUID wasdoes not foundexist in the system

Common Use Cases

Use Case 1: SIEM Integration for DNS Security Incident InvestigationMonitoring

Security operations centers integrate this API into their SIEM platforms to automatically categorize DNS security events. When investigating a potential security incident, security analysts can useSecureDNS transaction UUIDsis fromflagged, DNSthe logsSIEM system uses the transaction UUID to quicklyretrieve determinethe whatcategory, categoriesenabling ofautomated contentrule-based were being accessed. This helps prioritize investigationsresponses and understandproper theincident scope of potential threats.classification.

Use Case 2: DNSIncident PolicyResponse OptimizationInvestigation

NetworkDuring administratorssecurity incident investigations, analysts use this endpoint to quickly understand the nature of DNS-related security events. By querying transaction UUIDs from security logs, investigators can analyzerapidly thecategorize categoriesthreats ofand blockeddetermine orappropriate allowedresponse DNS requests to fine-tune their filtering policies, ensuring legitimate business traffic flows while maintaining security controls.procedures.

Use Case 3: Compliance Reporting and Auditing

Organizations canuse this API to generate compliance reports bythat categorizingcategorize DNS trafficsecurity toevents. The category information helps demonstrate adherencesecurity tomonitoring acceptable use policieseffectiveness and regulatoryprovides requirementsdetailed classifications required for internetvarious accessregulatory monitoring.frameworks.

Use Case 4: Automated Threat Response Workflows

Security orchestrationautomation platforms can integrate this APIendpoint to automaticallycreate categorizedynamic response workflows. Different DNS transactionssecurity andcategories trigger appropriatedifferent responseautomated workflowsresponses, basedfrom onsimple thelogging categoryfor (e.g.,low-risk categories to immediate blocking and alerting for malwarehigh-risk categories).classifications.

Use Case 5: NetworkSecurity TrafficDashboard AnalysisVisualization

ITSecurity dashboards use this API to display real-time categorized DNS threat intelligence, helping security teams canvisualize analyzethe types and distribution of DNS transaction patterns over time by categorizing requests, helping identify unusual activity patterns or potential security risksevents inacross networktheir usage.organization.

Best Practices

  • UUID Validation: Always validate UUID format before making API calls to avoid unnecessary 404 errorsresponses and reduce API usage
  • Error Handling: Implement robustcomprehensive error handling for all response codes, especially 404 responses when UUIDs don't exist
match any Rate Limiting: Consider implementing client-side rate limiting to avoid overwhelming the API with too many concurrent requeststransactions Caching Strategy: CacheConsider caching category resultsresponses for frequently queried UUIDs to improve performance and reduce API calls and improve performance Security: Never log or expose API tokens in client-side code or logs; always use secure token storage methods Monitoring: Track API response times and error rates to ensure your integration remains healthy Batch Processing: When analyzingprocessing multiple transactions, implement properappropriate queuingrate limiting and throttlingconsider mechanismsbatching requests to processavoid overwhelming the API Security Considerations: Store and transmit UUIDs efficientlysecurely as they may contain sensitive information about your organization's DNS security events Monitoring Integration: Log all API interactions for audit purposes and to track usage patterns in your security monitoring workflows Fallback Mechanisms: Implement fallback procedures when the API is unavailable to ensure critical security operations can continue
Back to top