{"openapi":"3.1.0","info":{"title":"AegisIntel Public Security Tools REST API","version":"1.0.0","description":"Unauthenticated public security utilities on aegisintelai.com for DMARC/SPF domain auditing, historical breach metadata, and zero-knowledge k-Anonymity checks. Versioning & Deprecation Policy: breaking changes always ship under a new major URL path, responses emit X-API-Version headers, and deprecated endpoints provide a minimum 90-day Sunset timeline via RFC 9745 Deprecation and RFC 8594 Sunset headers.","contact":{"name":"AegisIntel Security Team","email":"security@aegisintelai.com","url":"https://aegisintelai.com/contact"}},"externalDocs":{"description":"AegisIntel API Documentation, Authentication, and RFC 9745 Versioning Policy","url":"https://aegisintelai.com/docs#versioning-and-deprecation"},"x-versioning-policy":{"strategy":"url-major-version-and-header","versionHeader":"X-API-Version","deprecationHeader":"Deprecation","sunsetHeader":"Sunset","minimumNoticeDays":90,"policyUrl":"https://aegisintelai.com/docs#versioning-and-deprecation"},"servers":[{"url":"https://aegisintelai.com","description":"Public Storefront & Free Security Tools API"}],"paths":{"/api/public/breaches":{"get":{"summary":"List indexed public historical breach advisories","operationId":"listPublicBreaches","responses":{"200":{"description":"List of public historical breach advisories","headers":{"X-API-Version":{"$ref":"#/components/headers/X-API-Version"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BreachCatalogResponse"}}}},"405":{"description":"Unsupported HTTP method returned as RFC 9457 problem+json","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limit exceeded with Retry-After and RateLimit headers","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/api/public/dmarc-check":{"get":{"summary":"Inspect public domain SPF, DMARC, MX/DKIM posture via query parameter","operationId":"getDomainDmarcAndSpf","parameters":[{"name":"domain","in":"query","required":true,"schema":{"type":"string","example":"example.com"}}],"responses":{"200":{"description":"DNS audit and redacted exposure summary","headers":{"X-API-Version":{"$ref":"#/components/headers/X-API-Version"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DmarcCheckResponse"}}}},"400":{"description":"Validation error returned as RFC 9457 problem+json","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"405":{"description":"Unsupported HTTP method returned as RFC 9457 problem+json","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limit exceeded with Retry-After and RateLimit headers","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}},"post":{"summary":"Inspect public domain SPF, DMARC, MX/DKIM posture and redacted breach count","operationId":"checkDomainDmarcAndSpf","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain"],"properties":{"domain":{"type":"string","example":"example.com"}}}}}},"responses":{"200":{"description":"DNS audit and redacted exposure summary","headers":{"X-API-Version":{"$ref":"#/components/headers/X-API-Version"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DmarcCheckResponse"}}}},"400":{"description":"Validation error returned as RFC 9457 problem+json","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"405":{"description":"Unsupported HTTP method returned as RFC 9457 problem+json","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limit exceeded with Retry-After and RateLimit headers","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/api/public/password-range/{prefix}":{"get":{"summary":"Zero-knowledge 5-hex SHA-1 k-Anonymity password hash suffix range query","operationId":"queryPasswordRange","parameters":[{"name":"prefix","in":"path","required":true,"schema":{"type":"string","pattern":"^[0-9A-Fa-f]{5}$","example":"B2E98"}}],"responses":{"200":{"description":"Line-delimited SHA-1 hash suffixes matching the 5-character prefix","headers":{"X-API-Version":{"$ref":"#/components/headers/X-API-Version"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"text/plain":{"schema":{"type":"string","example":"9548B44B1A5C5B339D8D3E5E9F8B7C2D123:145821"}}}},"400":{"description":"Validation error returned as RFC 9457 problem+json","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"405":{"description":"Unsupported HTTP method returned as RFC 9457 problem+json","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limit exceeded with Retry-After and RateLimit headers","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}},"/api/public/breach-teaser":{"post":{"summary":"Redacted email breach count teaser without disclosing full records","operationId":"checkEmailBreachTeaser","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","format":"email"}}}}}},"responses":{"200":{"description":"Redacted breach match count and exposed categories","headers":{"X-API-Version":{"$ref":"#/components/headers/X-API-Version"},"RateLimit-Policy":{"$ref":"#/components/headers/RateLimit-Policy"},"RateLimit":{"$ref":"#/components/headers/RateLimit"},"Deprecation":{"$ref":"#/components/headers/Deprecation"},"Sunset":{"$ref":"#/components/headers/Sunset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TeaserResponse"}}}},"400":{"description":"Validation error returned as RFC 9457 problem+json","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"405":{"description":"Unsupported HTTP method returned as RFC 9457 problem+json","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}},"429":{"description":"Rate limit exceeded with Retry-After and RateLimit headers","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ProblemDetails"}}}}}}}},"components":{"headers":{"X-API-Version":{"description":"API contract version identifier. Breaking changes ship under new major version URL paths.","schema":{"type":"string","example":"1.0"}},"Deprecation":{"description":"RFC 9745 Deprecation header emitted with minimum 90-day notice when an endpoint enters deprecation.","schema":{"type":"string"}},"Sunset":{"description":"RFC 8594 Sunset HTTP-date indicating earliest scheduled retirement timestamp (minimum 90 days after Deprecation announcement).","schema":{"type":"string","format":"date-time"}},"RateLimit-Policy":{"description":"IETF RateLimit-Policy quota definition (maxRequests;w=windowSeconds).","schema":{"type":"string","example":"120;w=60"}},"RateLimit":{"description":"IETF RateLimit remaining request budget and reset window in seconds.","schema":{"type":"string","example":"limit=120, remaining=119, reset=60"}}},"schemas":{"ProblemDetails":{"type":"object","required":["type","title","status","code","detail","resolution"],"properties":{"type":{"type":"string","format":"uri"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string"},"detail":{"type":"string"},"error":{"type":"string"},"resolution":{"type":"string"}}},"BreachSummary":{"type":"object","required":["name","title","domain","breachDate","pwnCount","dataClasses"],"properties":{"name":{"type":"string"},"title":{"type":"string"},"domain":{"type":"string"},"breachDate":{"type":"string"},"pwnCount":{"type":"integer"},"dataClasses":{"type":"array","items":{"type":"string"}},"description":{"type":"string"}}},"BreachCatalogResponse":{"type":"object","required":["version","count","breaches"],"properties":{"version":{"type":"string"},"count":{"type":"integer"},"breaches":{"type":"array","items":{"$ref":"#/components/schemas/BreachSummary"}}}},"DmarcCheckResponse":{"type":"object","required":["domain","dnsAudit","redactedExposureCount","exposedCategories","upgradeUrl"],"properties":{"domain":{"type":"string"},"redactedExposureCount":{"type":"integer"},"exposedCategories":{"type":"array","items":{"type":"string"}},"upgradeUrl":{"type":"string"},"dnsAudit":{"type":"object","required":["domain","hasSpf","hasDmarc","dmarcPolicy","riskScore","recommendations"],"properties":{"domain":{"type":"string"},"hasSpf":{"type":"boolean"},"spfRecord":{"type":["string","null"]},"hasDmarc":{"type":"boolean"},"dmarcRecord":{"type":["string","null"]},"dmarcPolicy":{"type":"string"},"riskScore":{"type":"string","enum":["LOW","MEDIUM","HIGH","CRITICAL"]},"recommendations":{"type":"array","items":{"type":"string"}}}}}},"TeaserResponse":{"type":"object","required":["maskedEmail","hitCount","remainingChecksThisHour","breaches","upgradeUrl"],"properties":{"maskedEmail":{"type":"string"},"hitCount":{"type":"integer"},"remainingChecksThisHour":{"type":"integer"},"upgradeUrl":{"type":"string"},"breaches":{"type":"array","items":{"type":"object","required":["name","title","breachDate","dataClasses"],"properties":{"name":{"type":"string"},"title":{"type":"string"},"breachDate":{"type":"string"},"dataClasses":{"type":"array","items":{"type":"string"}}}}}}}}}}