Skip to main content

Securedns Categoryget

The SecureDNS Category API enablesprovides retrievalaccess to DNS transaction categorization data, allowing you to retrieve the category classification of categorization information forspecific SecureDNS transactions using their unique identifiers.transactions. This endpoint is essential for security monitoring, content filtering analysis, and understanding whatthe typenature of DNS activityrequests orprocessed threatthrough categorythe wasSecureDNS associated with a specific transaction, providing crucial context for security analysis and compliance reporting.service.

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 providesenables accessyou to transactionquery categorizationand dataretrieve withincategory Zequenze'sinformation for DNS transactions that have been processed through the SecureDNS service.filtering Whensystem. SecureDNS processesEach DNS requests, each transaction is assigned a unique identifierUUID (UUID)when processed, and categorizedthis API allows you to look up the category classification associated with that transaction.

Key Features:

    Retrieve category names for specific SecureDNS transactions Support for UUID-based ontransaction lookups Essential for security auditing and DNS filtering analysis Real-time access to transaction categorization data

    Common Use Cases:

      Security incident investigation and forensics DNS filtering policy analysis and optimization Compliance reporting for web access monitoring Automated security workflows that need to categorize DNS activity Integration with SIEM systems for enhanced threat detection

      The category information returned helps classify the type of content, threat level,content or policyservice matchassociated thatwith occurred.

      DNS

      Thisrequests, APIenabling categorybetter is particularly valuable for:

        Security Analysis: Understanding what categoriesunderstanding of contentnetwork userstraffic arepatterns accessingand Compliance Reporting: Generating reports on blocked or allowed content categories Incident Investigation: Researching specific DNS transactions duringpotential security incidents Policy Validation: Confirming that DNS filtering policies are working as expected

        The categorization system helps administrators understand whether DNS requests were related to malware, phishing, social media, productivity tools, or other predefined categories. This information is crucial for maintaining security posture and ensuring compliance with organizational policies.threats.


        Endpoints

        GET /securedns_categoryget/

        Description: Retrieves the category name associated with a specific SecureDNS transaction usingidentified by its UUID. This endpoint is essentialcrucial whenfor you need to understandunderstanding what type of content or threatservice was associatedbeing withaccessed in a particular DNS request, whethermaking it was blocked, allowed, or flaggedinvaluable for review.security analysis, compliance reporting, and traffic classification.

        Use Cases:

        • InvestigatingInvestigate securitysuspicious incidentsDNS activity by looking up transaction categories
        • Generating complianceGenerate reports showingon what categoriestypes of contentwebsites wereand services accessed through DNS
        • ValidatingValidate DNS filtering policypolicies effectivenessby checking categorization accuracy
        • ProvidingBuild detailedautomated contextsecurity forworkflows that respond based on DNS transaction logscategories
        Perform forensic analysis of network traffic patterns

        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 for which you want to retrievelook theup. categoryMust informationbe a valid UUID format.

        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:

        [
          {
          "uuid": "550e8400-e29b-41d4-a716-446655440000",
            "category": "Social Media",Networking"
          }
        ]
        

        Additional Example Responses:

        [
          {
            "category_id": 23,
          "threat_level"category": "low",Malware"
          }
        ]
        
        [
          {
            "policy_action"category": "allowed",Business "timestamp":and "2024-01-15T14:23:45Z",
          "domain": "facebook.com",
          "subcategory": "Social Networking"Economy"
          }
        ]
        

        Response Codes:

        Status Description
        200 Category request Ok - Successfully retrieved the category information
        401 Category request not authorized - Invalid or missing BearerAPI token
        403 Category request forbidden / not allowed - InsufficientValid token but insufficient permissions to access this transaction
        404 Provided UUID don't match any transaction - The specified UUID doeswas not existfound in the system

        Common Use Cases

        Use Case 1: Security Incident Investigation

        When investigating a potential security breach,incident, security analysts can use transaction UUIDs from theirDNS SIEM or log analysis toolslogs to quickly determine what categories of content were involvedbeing inaccessed. suspiciousThis DNShelps activity.prioritize investigations and understand the scope of potential threats.

        Use Case 2: DNS Policy Optimization

        Network administrators can analyze the categories of blocked or allowed DNS requests to fine-tune their filtering policies, ensuring legitimate business traffic flows while maintaining security controls.

        Use Case 3: Compliance Reporting

        Organizations can batchgenerate processcompliance transactionreports UUIDsby categorizing DNS traffic to generate comprehensive reports showing what categories of content users accessed during specific time periods, helping demonstrate compliance with industry regulations.

        Use Case 3: Policy Effectiveness Analysis

        IT administrators can sample transaction UUIDs from their DNS logsadherence to verifyacceptable that their SecureDNSuse policies are correctly categorizing and handlingregulatory differentrequirements typesfor ofinternet contentaccess according to organizational requirements.monitoring.

        Use Case 4: UserAutomated ActivityThreat ContextResponse

        HelpSecurity deskorchestration platforms can integrate this API to automatically categorize DNS transactions and trigger appropriate response workflows based on the category (e.g., immediate blocking for malware categories).

        Use Case 5: Network Traffic Analysis

        IT teams can lookanalyze upDNS specifictransaction transactionspatterns whenover userstime reportby blockedcategorizing content,requests, providinghelping immediateidentify contextunusual aboutactivity whypatterns certainor domainspotential weresecurity categorizedrisks andin blocked.network usage.


        Best Practices

        • UUID Validation: Always validate UUID format before making API calls to avoid unnecessary 404 errors
        Error Handling: Implement robust error handling for all response codes, especially 404 responses when UUIDs don't exist Rate Limiting: ImplementConsider appropriateimplementing delaysclient-side whenrate processing large batches of UUIDslimiting to respectavoid overwhelming the API ratewith limitstoo many Errorconcurrent Handling: Design your application to gracefully handle 404 responses for UUIDs that may have aged out of the systemrequests Caching: Consider cachingCache category results for frequently queried UUIDs to reduce API calls and improve performance Security: Never log or expose BearerAPI tokens in your applicationclient-side code or configurationlogs; filesalways use secure token storage methods Monitoring: Track API response times and error rates to ensure optimalyour performanceintegration whenremains processinghealthy high volumesBatch ofProcessing: categoryWhen lookupsanalyzing multiple transactions, implement proper queuing and throttling mechanisms to process UUIDs efficiently