Skip to main content

Backend API

The STATUS Backend API provides the core functionality for data management and business logic.

Overview

The backend API handles data storage and retrieval, business logic processing, authentication and authorization, and integration with external services.

API Sections

SectionDescription
Authentication EndpointsDetailed authentication flows including 2FA and OAuth
Compliance DomainRESTful endpoints for managing catalogs, controls, computations, and points
Data IntegrationDatabinder, Linker, Scope management, and Grafana proxy APIs
System ConfigurationAdmin-only endpoints for managing endpoint availability and service settings
AI AssistantOpenAI assistant, conversation threads, and messages APIs (DEPRECATED)
Node-RED IntegrationFlow-based programming environment for workflows and automation

Notes

  • All endpoints are prefixed with the API_PREFIX configured in environment variables
  • Authentication is required for all protected routes
  • Rate limiting may apply to certain endpoints