API Reference

Overview

The Mongo My Admin API is a RESTful API that provides programmatic access to all platform features.

Base URL

https://yourdomain.com/api/v1

Response Format

All responses follow a standard JSON format:

// Success Response
{
  "success": true,
  "message": "Operation successful",
  "data": { ... }
}

// Error Response
{
  "success": false,
  "message": "Error description",
  "error": "ERROR_CODE"
}

Pagination

List endpoints support pagination with these query parameters:

Authentication

The API uses JWT (JSON Web Token) authentication. Include the token in the Authorization header:

Authorization: Bearer <your_jwt_token>

Token Lifecycle

API Key Authentication

For automated integrations, use API key + secret key:

X-API-Key: your_api_key
X-API-Secret: your_api_secret

Auth Endpoints

SaaS Admin Auth

// Request Body
{
  "email": "super-admin@gmail.com",
  "password": "BetaZen@2023"
}

// Response
{
  "success": true,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIs...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIs...",
    "admin": {
      "id": "...",
      "email": "super-admin@gmail.com",
      "name": "Super Admin"
    }
  }
}

Company Auth

// Request Body
{
  "email": "admin@gmail.com",
  "password": "BetaZen@2023"
}

// Response
{
  "success": true,
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIs...",
    "refreshToken": "eyJhbGciOiJIUzI1NiIs...",
    "user": {
      "id": "...",
      "email": "admin@gmail.com",
      "name": "Admin",
      "role": "super_admin"
    },
    "company": {
      "id": "...",
      "name": "My Company",
      "status": "active"
    }
  }
}

Company Endpoints

Database Endpoints

// Request Body
{
  "name": "production_db"
}

// Response
{
  "success": true,
  "data": {
    "database": {
      "_id": "...",
      "name": "production_db",
      "internalName": "X7Y8Z9_production_db",
      "status": "active",
      "connectionString": "mongodb://..."
    }
  }
}

Collection Endpoints

Document Endpoints

Demo Data

// Request Body
{
  "count": 10,
  "template": "users"  // users | products | orders | posts | tasks | events | random
}

Database User Endpoints

// Request Body
{
  "username": "app_user",
  "password": "SecurePass123!",
  "roles": ["readWrite"]
}

Company User Endpoints

Subscription Endpoints

// Request Body
{
  "packageId": "PKG_PRO",
  "billingCycle": "yearly"  // monthly | quarterly | halfYearly | yearly | twoYear | threeYear | fiveYear
}

Trial Endpoints

Package Endpoints

Payment Endpoints

Razorpay

PhonePe

Paytm

Manual Payment

Analytics Endpoints

Company User Analytics

IP & Session Tracking

Storage Analytics

Settings Endpoints

Public Settings

Admin Endpoints

Company Management

Payment Management (Admin)

Gateway Configuration (Admin)

Storage Management (Admin)

Platform Analytics (Admin)

Settings (Admin)

Migration (Admin)

Error Codes

Rate Limiting

API endpoints are rate limited to prevent abuse:

• General endpoints: 100 requests per minute
• Auth endpoints: 10 requests per minute (brute-force protection)
• Upload endpoints: 20 requests per minute

Rate limit headers are included in responses:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1704067200