Status
Real-time status and uptime information for WISTX services.Status information is checked on-demand via the Status API. For programmatic access, use the API endpoints.
Current Status
Status indicators reflect the current operational state. Use the Status API endpoint for real-time status checks.
Service Components
WISTX consists of the following service components, each monitored independently:API Service
- Endpoint:
api.wistx.ai - Status: Monitors REST API availability and response times
- Health Check:
/v1/health(basic) or/v1/status(comprehensive) - Metrics: API version, uptime, response times
Database Services
- Service: MongoDB
- Status: Monitors database connectivity, latency, and connection pool
- Metrics: Connection count, query latency, server version, connection pool status
Vector Search
- Service: Pinecone
- Status: Monitors vector database connectivity and index availability
- Metrics: Total vectors, index statistics, index name
- Note: Shows as “not_configured” if Pinecone API key is not set
Indexing Service
- Status: Monitors indexing job processing
- Metrics: Active jobs, recent job counts (jobs created today)
Authentication Service
- Status: Monitors user authentication and authorization
- Metrics: Total users, active users
Status API
For programmatic access to status information, use the Status API endpoints:Get System Status
- Overall system status (
operational,degraded, ordown) - Individual service status for API, Database, Vector Search, Indexing, and Authentication
- Service-specific metrics (latency, connections, job counts, etc.)
- Check timestamp and duration
Get Uptime Statistics
View API Documentation
Complete Status API reference with request/response examples in 7 programming languages
Status Indicators
Status indicators use the following status values:- operational (Green) - Service is functioning normally
- degraded (Yellow) - Service is operational but experiencing issues or errors
- down (Red) - Service is unavailable or failing
- not_configured (Gray) - Service is not configured (e.g., optional services like Pinecone)
Overall Status Determination
The overall system status is determined from individual service statuses:- down - If any service is
down - degraded - If any service is
degradedornot_configured - operational - If all services are
operational
Monitoring
WISTX status can be monitored using:- Health Check Endpoint (
/v1/health) - Simple health check, no authentication required - Status Endpoint (
/v1/status) - Comprehensive status for all services, requires authentication - Uptime Statistics (
/v1/status/uptime) - Historical uptime data, requires authentication
Integration Tips:
- Use
/v1/healthfor load balancer health checks (no auth required) - Use
/v1/statusfor monitoring dashboards and alerting (requires API key) - Poll
/v1/statusat your desired interval (e.g., every 60 seconds) for continuous monitoring - Set up alerts based on the
statusfield in the response
Service-Specific Details
API Service Status
- Always returns
operationalif the API is responding - Includes API version and title from configuration
- Calculates uptime from service start time
Database Service Status
- Checks MongoDB connectivity via ping command
- Returns connection pool statistics
- Includes server version and latency metrics
- Returns
downif database is unreachable
Vector Search Status
- Checks Pinecone index availability
- Returns
not_configuredif Pinecone API key is not set - Returns
degradedif index is not found - Returns
downif Pinecone API is unreachable - Includes total vector count and index statistics
Indexing Service Status
- Checks active indexing jobs (status:
indexingorpending) - Counts jobs created today
- Returns
degradedif database query fails
Authentication Service Status
- Checks user collection statistics
- Returns total and active user counts
- Returns
degradedif database query fails
Error Handling
If a status check fails:- Individual service status will show
degradedordownwith an error message - Overall status will reflect the most severe service status
- Error details are included in the service response for debugging
Related Documentation
Status API Reference
Complete API documentation with examples
Support
Contact support for status-related questions