Skip to content

Home

Jump to bottom
Adhithya edited this page Jun 14, 2025 · 1 revision

Aran API Sentinel Wiki

Aran API Sentinel is a powerful and intelligent platform designed to give organizations comprehensive visibility, control, and security across their API ecosystem. In today’s interconnected digital landscape, APIs are critical assets—Aran helps you manage them effectively and securely.

Overview of Aran Features

Automated API Discovery

  • Uses AI to discover all APIs, including shadow and zombie APIs.
  • Continuously updates a comprehensive API inventory.

Centralized API Catalog

  • Searchable, organized catalog of all discovered and registered APIs.
  • Includes metadata, ownership, and links to documentation.

API Security Management

  • Helps define, enforce, and monitor API security policies.
  • Promotes consistent application of best practices.

AI-Powered Threat Detection

  • Monitors API traffic patterns for anomalies and suspicious behavior.
  • Alerts security teams to potential threats in real-time.

Streamlined Governance and Compliance

  • Ensures APIs meet internal standards and compliance frameworks.
  • Provides audit-ready documentation and history.

System Architecture

Aran integrates modern tools and frameworks to deliver its feature set effectively:

graph TD
    A[User / Admin] --> B(Frontend: Aran UI - Next.js)
    B --> C{Firebase Backend}
    C --> B
    B --> D[Genkit AI Flows]
    D --> B
    D --> C
    D --> E[External AI Services (e.g., Gemini via Vertex AI)]
Loading

Key Components

  • User/Admin Interface: Interacts with Aran via a responsive web UI to manage APIs, view insights, and configure policies.

  • Next.js Frontend: Delivers the user interface. Includes modules for:

    • API catalog
    • Security policy management
    • Documentation and metadata views
    • Threat dashboards and audit trails

  • Firebase Backend:

    • Authentication: Manages user roles and permissions.
    • Firestore: Stores API metadata, user activity logs, security settings, and threat data.
    • Cloud Storage: For uploading and retrieving API spec files (OpenAPI, Postman, etc.).

  • Genkit AI Flows:

    • Built using server-side TypeScript.

    • Executes core AI logic like:

      • API auto-discovery from traffic/code repositories.
      • Threat analysis and pattern detection.
      • Governance assistance (compliance checks, metadata suggestions).

  • External AI Services:

    • Integrates with advanced models (e.g., Google Gemini via Vertex AI) for high-performance AI processing.

For deeper insights into architecture, see the "Detailed Architecture" page.

Local Development Guide

Frontend (Next.js UI - http://localhost:3000/)

npm install       # Install dependencies
npm run dev       # Start development server

Backend (Genkit AI Flows - http://localhost:4000/)

npm run genkit:watch   # Dev server with auto-reloading
# Or
npm run genkit:dev     # One-time dev run

For setup details, refer to the main README.md in the root repository.

Documentation Site

For comprehensive usage and technical guides:

Live Site: https://radhi1991.github.io/aran/

To run the documentation locally:

cd docs/website
npm install          # or yarn install
yarn start           # or npm run start

Open your browser at: http://localhost:3000

The full documentation includes:

  • Feature walkthroughs
  • User/admin guides
  • Governance checklists
  • Deployment and architecture references

Aran API Sentinel is built to bring clarity, control, and security to modern API ecosystems. From intelligent discovery to threat detection and governance, Aran enables teams to stay ahead in their API journey.

Clone this wiki locally