LogoLogo
1.1.0
1.1.0
  • Maisa System
    • Introduction
    • API Reference
      • Maisa System API Documentation
        • Authentication
      • Users
      • Projects
      • Analytics
      • System
      • Models
    • Architecture
    • How to use it
  • Helm Installation
    • Getting Started
    • Authentication
    • Configuration Reference
Powered by GitBook
On this page
Export as PDF
  1. Maisa System
  2. API Reference

System

PreviousAnalyticsNextModels

System configuration operations

Get system health

get

Checks the health status of the system.

This endpoint does not require authentication and can be used for monitoring.

Responses
200
System health information
application/json
get
GET /v1/system/health HTTP/1.1
Host: api.maisa.com
Accept: */*
200

System health information

{
  "status": "healthy",
  "components": {
    "database": {
      "status": "up",
      "message": "Connected"
    },
    "cache": {
      "status": "up",
      "message": "Connected"
    },
    "storage": {
      "status": "up",
      "message": "Connected"
    }
  },
  "version": "1.2.0"
}

Get system configuration

get

Retrieves the current system configuration

Authorizations
Responses
200
System configuration
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
get
GET /v1/system/config HTTP/1.1
Host: api.maisa.com
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "data": {
    "general": {
      "siteName": "Maisa System",
      "defaultLanguage": "en",
      "supportEmail": "support@maisa.com"
    },
    "security": {
      "sessionTimeout": 3600,
      "loginAttempts": 5,
      "passwordPolicy": {
        "minLength": 8,
        "requireUppercase": true,
        "requireNumbers": true,
        "requireSpecialChars": true
      }
    },
    "email": {
      "enabled": true,
      "from": "no-reply@maisa.com",
      "smtpHost": "smtp.maisa.com",
      "smtpPort": 587
    },
    "features": {
      "analytics": true,
      "projects": true
    }
  }
}
  • GETGet system health
  • GETGet system configuration
  • PUTUpdate system configuration

Update system configuration

put

Updates the system configuration.

Changing system configuration may require a system restart to take effect.

Authorizations
Body
Responses
200
System configuration updated successfully
application/json
400
Bad request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
put
PUT /v1/system/config HTTP/1.1
Host: api.maisa.com
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 360

{
  "general": {
    "siteName": "text",
    "defaultLanguage": "text",
    "supportEmail": "name@gmail.com"
  },
  "security": {
    "sessionTimeout": 1,
    "loginAttempts": 1,
    "passwordPolicy": {
      "minLength": 1,
      "requireUppercase": true,
      "requireNumbers": true,
      "requireSpecialChars": true
    }
  },
  "email": {
    "enabled": true,
    "from": "text",
    "smtpHost": "text",
    "smtpPort": 1
  },
  "features": {
    "analytics": true,
    "projects": true
  }
}
{
  "data": {
    "general": {
      "siteName": "Maisa System",
      "defaultLanguage": "en",
      "supportEmail": "support@maisa.com"
    },
    "security": {
      "sessionTimeout": 3600,
      "loginAttempts": 5,
      "passwordPolicy": {
        "minLength": 8,
        "requireUppercase": true,
        "requireNumbers": true,
        "requireSpecialChars": true
      }
    },
    "email": {
      "enabled": true,
      "from": "no-reply@maisa.com",
      "smtpHost": "smtp.maisa.com",
      "smtpPort": 587
    },
    "features": {
      "analytics": true,
      "projects": true
    }
  },
  "restartRequired": true
}