> ## Documentation Index
> Fetch the complete documentation index at: https://docs.socdefenders.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Export IOCs as CEF or RFC 5424 Syslog events

> Stream IOCs as either CEF (Common Event Format, ArcSight-compatible) or RFC 5424 Syslog. Designed to be piped into a SIEM ingestion pipeline.

## Output

- `format=cef` (default): One CEF line per IOC. Example header: `CEF:0|SOCDefenders|ThreatIntel|1.0|ipv4|Malicious IPv4|6|src=192.168.1.1 ...`
- `format=syslog`: RFC 5424 lines with structured-data sections.

## Ingestion examples

- **Splunk**: configure a TCP/UDP listener on port 514 and `curl ... | nc splunk.example.com 514`
- **Sentinel**: forward via Logstash + Common Event Format connector
- **rsyslog**: pipe directly with `logger -p local0.info -t socdefenders`

Requires the **Pro plan** (`read:cef` scope).



## OpenAPI

````yaml https://socdefenders.ai/api/openapi.json get /api/v1/iocs/cef
openapi: 3.0.3
info:
  title: SOC Defenders Threat Intelligence API
  description: >-
    # Overview


    The SOC Defenders Threat Intelligence API provides programmatic access to
    aggregated threat intelligence from 30+ cybersecurity sources. Export IOCs
    (Indicators of Compromise) in various formats including JSON, CSV, STIX 2.1,
    MISP, CEF, and OpenIOC.


    ## Authentication


    All API endpoints require authentication using an API key. Include your key
    in one of these ways:


    - **Authorization Header** (recommended): `Authorization: Bearer
    sk_live_xxx`

    - **X-API-Key Header**: `X-API-Key: sk_live_xxx`

    - **Query Parameter**: `?api_key=sk_live_xxx`


    ## Rate Limiting


    Rate limits vary by tier. When limits are exceeded, the API returns a 429
    status code.


    | Tier | Requests/min | Requests/day | Lookback | Formats |

    |------|-------------|--------------|----------|---------|

    | Free | 10 | 1,000 | 1 day | JSON / CSV |

    | Pro ($299/mo) | 1,000 | 1,000,000 | 365 days | All (STIX, TAXII, MISP,
    CEF, OpenIOC, Sigma) |


    Rate limit headers are included in all responses:

    - `X-RateLimit-Limit`: Maximum requests per minute

    - `X-RateLimit-Remaining`: Requests remaining in current window

    - `X-RateLimit-Reset`: Unix timestamp when the limit resets


    ## Error Handling


    All errors follow a consistent format:


    ```json

    {
      "error": {
        "code": "error_code",
        "message": "Human readable message",
        "details": {},
        "request_id": "req_abc123"
      }
    }

    ```


    ## STIX/TAXII Support


    For STIX 2.1 and TAXII 2.1 integration, see the TAXII endpoints section.
    TAXII endpoints are available at `/api/taxii2/`.
  version: 1.0.0
  contact:
    name: SOC Defenders Support
    url: https://socdefenders.ai/contact
    email: support@socdefenders.ai
  license:
    name: Proprietary
    url: https://socdefenders.ai/terms
servers:
  - url: https://socdefenders.ai
    description: Production server
security: []
tags:
  - name: IOCs
    description: Indicators of Compromise endpoints
  - name: Statistics
    description: Feed and IOC statistics
  - name: API Keys
    description: API key management (requires session auth)
  - name: TAXII
    description: TAXII 2.1 threat intelligence sharing endpoints
  - name: Export Formats
    description: Specialized export format endpoints (MISP, CEF, OpenIOC)
  - name: Articles
    description: >-
      Aggregated news articles from 30+ cybersecurity sources, with rich
      filtering and bulk-export support
  - name: Lookup
    description: >-
      Single-IOC enrichment lookup. Auto-detects type, aggregates reporting
      sources, returns AI risk + MITRE techniques + hunting queries. Free-tier
      friendly.
  - name: Detection Rules
    description: >-
      Generate ready-to-deploy SIEM detection rules from recent IOCs. Sigma
      rules ship as multi-document YAML covering network / DNS / proxy /
      process_creation logsources.
paths:
  /api/v1/iocs/cef:
    get:
      tags:
        - Export Formats
      summary: Export IOCs as CEF or RFC 5424 Syslog events
      description: >-
        Stream IOCs as either CEF (Common Event Format, ArcSight-compatible) or
        RFC 5424 Syslog. Designed to be piped into a SIEM ingestion pipeline.


        ## Output


        - `format=cef` (default): One CEF line per IOC. Example header:
        `CEF:0|SOCDefenders|ThreatIntel|1.0|ipv4|Malicious
        IPv4|6|src=192.168.1.1 ...`

        - `format=syslog`: RFC 5424 lines with structured-data sections.


        ## Ingestion examples


        - **Splunk**: configure a TCP/UDP listener on port 514 and `curl ... |
        nc splunk.example.com 514`

        - **Sentinel**: forward via Logstash + Common Event Format connector

        - **rsyslog**: pipe directly with `logger -p local0.info -t
        socdefenders`


        Requires the **Pro plan** (`read:cef` scope).
      operationId: exportCEF
      parameters:
        - name: format
          in: query
          description: Output format — `cef` (ArcSight) or `syslog` (RFC 5424).
          schema:
            type: string
            enum:
              - cef
              - syslog
            default: cef
            example: cef
        - name: since
          in: query
          description: Lower time bound (ISO 8601). Clamped to your tier lookback.
          schema:
            type: string
            format: date-time
            example: '2026-05-15T00:00:00Z'
        - name: limit
          in: query
          description: Max events to emit. Tier-capped.
          schema:
            type: integer
            default: 100
            example: 500
      responses:
        '200':
          description: CEF or Syslog events, one per line
          content:
            text/plain:
              schema:
                type: string
              example: >-
                CEF:0|SOCDefenders|ThreatIntel|1.0|ipv4|Malicious
                IPv4|6|src=192.168.1.1 cs1=high cs1Label=confidence msg=C2 IP
                from "New botnet observed beaconing"

                CEF:0|SOCDefenders|ThreatIntel|1.0|domain|Malicious
                Domain|6|destinationDnsDomain=c2.example.com cs1=high
                cs1Label=confidence

                CEF:0|SOCDefenders|ThreatIntel|1.0|sha256|Malicious
                Hash|7|fileHash=e3b0c44298fc1c14... cs1=high cs1Label=confidence
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimitExceeded'
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
      x-codeSamples:
        - lang: cURL
          label: CEF for Splunk
          source: |-
            curl -H "Authorization: Bearer sk_live_..." \
              "https://socdefenders.ai/api/v1/iocs/cef?format=cef&since=2026-05-15T00:00:00Z&limit=500"
        - lang: bash
          label: Pipe to Syslog
          source: |-
            curl -sS -H "Authorization: Bearer sk_live_..." \
              "https://socdefenders.ai/api/v1/iocs/cef?format=syslog&limit=1000" \
              | logger -p local0.info -t socdefenders
components:
  responses:
    Unauthorized:
      description: Authentication required or invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: missing_api_key
              message: >-
                API key is required. Include it in the Authorization header as
                "Bearer sk_live_..."
              request_id: req_abc123
    Forbidden:
      description: Insufficient permissions or scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: insufficient_scope
              message: This endpoint requires the "read:stix" scope
              details:
                required_scope: read:stix
                your_scopes:
                  - read:iocs
                upgrade_url: https://socdefenders.ai/export#pricing
              request_id: req_abc123
    RateLimitExceeded:
      description: Rate limit exceeded
      headers:
        Retry-After:
          description: Seconds to wait before retrying
          schema:
            type: integer
        X-RateLimit-Limit:
          description: Rate limit ceiling
          schema:
            type: integer
        X-RateLimit-Remaining:
          description: Remaining requests (will be 0)
          schema:
            type: integer
        X-RateLimit-Reset:
          description: Unix timestamp when limit resets
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: rate_limit_exceeded
              message: Rate limit exceeded. Please wait before making more requests.
              details:
                limit: 10
                reset_at: '2024-12-09T10:31:00Z'
                tier: free
                upgrade_url: https://socdefenders.ai/export#pricing
              request_id: req_abc123
  schemas:
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - request_id
          properties:
            code:
              type: string
              description: Error code for programmatic handling
            message:
              type: string
              description: Human-readable error message
            details:
              type: object
              description: Additional error details
            request_id:
              type: string
              description: Unique request identifier for support
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key in X-API-Key header
    BearerAuth:
      type: http
      scheme: bearer
      description: 'API key in Authorization header: `Authorization: Bearer sk_live_xxx`'

````