> ## 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.

# List your API keys

> Returns all API keys belonging to the authenticated user. Used by the SOC Defenders dashboard to populate the key-management UI.

**Auth**: Session cookie (browser), not Bearer token. Hit this from a logged-in fetch — programmatic Bearer access is not allowed for the keys endpoints (chicken-and-egg).

Each list item includes the key prefix (e.g. `sk_live_zIc8`) but **not** the full secret — full keys are only ever shown once at creation time. Use the prefix to identify keys in your code or telemetry.



## OpenAPI

````yaml https://socdefenders.ai/api/openapi.json get /api/v1/keys
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/keys:
    get:
      tags:
        - API Keys
      summary: List your API keys
      description: >-
        Returns all API keys belonging to the authenticated user. Used by the
        SOC Defenders dashboard to populate the key-management UI.


        **Auth**: Session cookie (browser), not Bearer token. Hit this from a
        logged-in fetch — programmatic Bearer access is not allowed for the keys
        endpoints (chicken-and-egg).


        Each list item includes the key prefix (e.g. `sk_live_zIc8`) but **not**
        the full secret — full keys are only ever shown once at creation time.
        Use the prefix to identify keys in your code or telemetry.
      operationId: listAPIKeys
      responses:
        '200':
          description: Array of API key metadata. Full key secrets are never returned here.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/APIKeyInfo'
                  meta:
                    type: object
                    properties:
                      total:
                        type: integer
              example:
                data:
                  - id: 00000000-0000-4000-8000-000000000123
                    key_prefix: sk_live_zIc8
                    name: Production SIEM
                    tier: pro
                    scopes:
                      - read:iocs
                      - read:articles
                      - read:articles:export
                      - read:stix
                    total_requests: 142587
                    last_used_at: '2026-05-17T09:42:11Z'
                    created_at: '2026-01-15T10:00:00Z'
                    expires_at: null
                    revoked_at: null
                  - id: 00000000-0000-4000-8000-000000000456
                    key_prefix: sk_live_aB3x
                    name: Dev sandbox
                    tier: free
                    scopes:
                      - read:iocs
                      - read:articles
                    total_requests: 234
                    last_used_at: '2026-05-16T18:30:00Z'
                    created_at: '2026-05-10T08:00:00Z'
                    expires_at: '2026-08-10T08:00:00Z'
                    revoked_at: null
                meta:
                  total: 2
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - CookieAuth: []
      x-codeSamples:
        - lang: JavaScript
          label: List keys from logged-in browser
          source: >-
            const r = await fetch('/api/v1/keys', { credentials: 'include' });

            const { data } = await r.json();

            data.forEach(k => console.log(`${k.key_prefix}: ${k.name}
            (${k.tier})`));
components:
  schemas:
    APIKeyInfo:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
        key_preview:
          type: string
          example: sk_live_••••••••
        tier:
          type: string
          enum:
            - free
            - pro
        scopes:
          type: array
          items:
            type: string
        rate_limit_per_minute:
          type: integer
        rate_limit_per_day:
          type: integer
        total_requests:
          type: integer
        last_used_at:
          type: string
          format: date-time
          nullable: true
        created_at:
          type: string
          format: date-time
        expires_at:
          type: string
          format: date-time
          nullable: true
    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
  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
  securitySchemes:
    CookieAuth:
      type: apiKey
      in: cookie
      name: sb-access-token
      description: Session cookie (for API key management endpoints)

````