> ## 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. # Get full details for one API key > Returns the full metadata + lightweight usage summary for one API key. For deep analytics (latency percentiles, status-code breakdown, time series), use the [usage endpoint](#operation/getAPIKeyUsage). ## OpenAPI ````yaml https://socdefenders.ai/api/openapi.json get /api/v1/keys/{keyId} 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/{keyId}: get: tags: - API Keys summary: Get full details for one API key description: >- Returns the full metadata + lightweight usage summary for one API key. For deep analytics (latency percentiles, status-code breakdown, time series), use the [usage endpoint](#operation/getAPIKeyUsage). operationId: getAPIKey parameters: - name: keyId in: path required: true description: API key ID (UUID) schema: type: string format: uuid example: 00000000-0000-4000-8000-000000000123 responses: '200': description: API key details. Full secret is never returned (only the prefix). content: application/json: schema: type: object properties: data: $ref: '#/components/schemas/APIKeyDetails' 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 rate_limit_per_minute: 1000 rate_limit_per_day: 1000000 total_requests: 142587 last_used_at: '2026-05-17T09:42:11Z' created_at: '2026-01-15T10:00:00Z' expires_at: null revoked_at: null allowed_ips: null '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' security: - CookieAuth: [] components: schemas: APIKeyDetails: allOf: - $ref: '#/components/schemas/APIKeyInfo' - type: object properties: usage: type: object properties: daily: type: array items: type: object properties: date: type: string format: date requests: type: integer errors: type: integer 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 NotFound: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: not_found message: The requested resource was not found request_id: req_abc123 securitySchemes: CookieAuth: type: apiKey in: cookie name: sb-access-token description: Session cookie (for API key management endpoints) ````