WoWSQLWoWSQL
Dashboard

Projects

Projects in WoWSQL are isolated environments where you can manage your database, authentication, storage, and all other services. Each project has its own database, API keys, and configuration.

Creating a Project

You can create a project through:

  • Dashboard - Web interface at app.wowsql.com
  • CLI - Command-line tool
  • API - REST API endpoints

Project Configuration

Each project includes:

  • Project Slug - Unique identifier for your project
  • Database - Isolated MySQL database
  • Region - Choose the closest region to your users
  • Deployment Type:
    • Shared - Perfect for development and small apps
    • Dedicated (RDS) - Production-grade AWS RDS instance
  • API Keys - Public and secret keys for authentication

Project Management

Project Roles

  • Owner - Full control, can delete project
  • Admin - Can manage settings and team members
  • Member - Can read and write data
  • Viewer - Read-only access

Team Collaboration

Invite team members to collaborate on projects:

  • Send invitations via email
  • Assign roles based on permissions needed
  • Track activity logs for all team members

    • API Endpoints

    GET    /api/v1/projects              // List all projects
POST   /api/v1/projects              // Create new project
GET    /api/v1/projects/{slug}       // Get project details
PATCH  /api/v1/projects/{slug}/settings  // Update project settings
DELETE /api/v1/projects/{slug}       // Delete project
GET    /api/v1/projects/{slug}/api-keys  // Get API keys
POST   /api/v1/projects/{slug}/regenerate-api-key  // Regenerate API key
GET    /api/v1/projects/{slug}/connection-string  // Get connection string

    Team Management

    GET    /api/v1/team/{project_slug}/members      // Get team members
POST   /api/v1/team/{project_slug}/invite       // Invite team member
GET    /api/v1/team/{project_slug}/invitations   // Get pending invitations

    Authentication & Headers

    All API requests require authentication and project context:

    Base URL: https://api.wowsql.com

Required Headers:
  Authorization: Bearer your-api-key
  X-Project-Slug: your-project-slug  // Required for most endpoints
  Content-Type: application/json      // For POST/PUT/PATCH requests

    Note: Some endpoints (like project-level auth) use subdomain routing:

    Base URL: https://your-project-slug.wowsql.com
// No X-Project-Slug header needed for subdomain routes