Developer documentationOperationalv1 · 2026-10-10

ForenShield API

ForenShield’s investigation tools as APIs: analyze a suspicious email, query an enriched CVE database (full CISA KEV catalog and recent critical and high CVEs), examine a suspicious URL and diagnose a domain (DNS, propagation, WHOIS) from your scripts, SOAR or SIEM. One key, per-tool scopes, a stable contract.

APIs
4
APIs
of the CISA KEV catalog
100%
of the CISA KEV catalog
browser profiles
10
browser profiles
content stored
0
content stored
Base URLhttps://api.forenshield.com
cURL
curl -X POST "https://api.forenshield.com/v1/eml/analyze?include=report" \
  -H "Authorization: Bearer $FORENSHIELD_API_KEY" \
  -H "Content-Type: message/rfc822" \
  --data-binary @suspect.eml
Full response and Python, Node.js and PowerShell examples: members only.
Documentation· Introduction

Introduction

The APIs are REST interfaces: HTTPS requests, UTF-8 JSON responses, standard HTTP codes. They expose the same engines as the website’s tools, without a browser.

API catalog

Each tool is a full API with its own scope: a key only opens the APIs you grant it. They all share the same authentication, limits, error format and OpenAPI document.

  • eml:analyze

    Email analysis

    Explained verdict, SPF / DKIM / DMARC, links, observables and routing of a suspicious .eml.

    • POST/v1/eml/analyze
    Reference
  • cve:read

    CVE database

    150,000+ enriched CVEs: CVSS, CISA KEV, ransomware, PoC, products and fixes.

    • GET/v1/cve/search
    • GET/v1/cve/{id}
    • GET/v1/cve/stats
    Reference
  • sandbox:analyze

    URL sandbox

    Suspicious URL examined by several browsers: phishing, ClickFix, HTML smuggling, cloaking, MITRE ATT&CK.

    • POST/v1/sandbox/analyze
    Reference
  • network:diagnose

    Network diagnostics

    IP and ASN resolution, DNS with real TTLs, propagation across 5 resolvers, TCP ping and WHOIS (RDAP) from our servers.

    • GET/v1/network/resolve
    • GET/v1/network/dns
    • GET/v1/network/propagation
    • GET/v1/network/ping
    • GET/v1/network/whois
    Reference
  • Secure by design

    Personal keys hashed with bcrypt, per-API scopes, expiry, instant revocation. Never a key in a URL.

  • Nothing stored

    Emails, URLs and pages are analyzed in memory then discarded. Logs keep only the endpoint, status and duration (90 days).

  • Stable contract

    snake_case JSON, date-versioned. Additions are backward compatible; any breaking change will ship as /v2.

  • Built for automation

    Typed errors, quota headers, a request id for support, examples in four languages.

Members access

The rest of the documentation is for members

Log in, or create your ForenShield account in under a minute, to access the full API reference and generate your key from the portal.

What you unlock

  • The reference for all 13 endpoints: parameters, request bodies, response codes
  • Ready-to-copy examples in cURL, Python, Node.js and PowerShell
  • Real responses and every response object in detail
  • The try-it console to call the APIs live
  • Authentication, scopes, quotas and the error catalog
  • The OpenAPI 3.1 specification and the changelog

A client account is enough. You come straight back to this page.

FAQ

Is the ForenShield API free?

Yes: a free client account is enough to create a key and call all four APIs, up to 3 requests per minute and 3 per day. Quotas depend on the account’s plan and are shared by all your keys.

Which APIs are available?

Four REST APIs: email analysis (.eml: SPF, DKIM, DMARC, links, observables, routing), CVE database (full CISA KEV catalog and recent critical and high CVEs, with CVSS, EPSS, ransomware and PoC), URL sandbox (phishing, cloaking, MITRE ATT&CK indicators) and network diagnostics (IP/ASN resolution, DNS, propagation, TCP ping, WHOIS/RDAP).

Are submitted emails and URLs stored?

No. Content is analyzed in memory then discarded. Logs keep only the endpoint called, the HTTP status and the duration, for 90 days.

How do I authenticate?

With a personal key created from the portal, sent in the Authorization: Bearer or X-API-Key header. Each key only opens the APIs it has the scope for, can expire and is revoked instantly. A key passed in the URL is rejected.

Is there an OpenAPI specification?

Yes: https://api.forenshield.com/v1/openapi.json describes every API in OpenAPI 3.1, without authentication. Import it into Postman, Insomnia, Bruno or a client generator.

What happens when I exceed my quota?

The API answers 429 with a Retry-After header (seconds to wait). Every response shows the remaining quota (X-RateLimit-*, X-Quota-*); the daily quota resets at midnight UTC.