API Reference

Complete REST API documentation for FabConnect.

API Overview

FabConnect provides a comprehensive REST API for integration with your systems.

Base URL

http://localhost:8080/api/v1

Authentication

All API requests require a valid JWT token in the Authorization header:

Authorization: Bearer <token>

Endpoints

Authentication

  • `POST /auth/login` - Login and get token
  • `POST /auth/logout` - Invalidate token
  • `POST /auth/refresh` - Refresh token

    • Equipment

  • `GET /equipment` - List all equipment
  • `GET /equipment/{id}` - Get equipment details
  • `POST /equipment` - Create equipment
  • `PUT /equipment/{id}` - Update equipment
  • `DELETE /equipment/{id}` - Delete equipment
  • `POST /equipment/{id}/connect` - Connect
  • `POST /equipment/{id}/disconnect` - Disconnect

    • Messages

  • `GET /messages` - List messages
  • `GET /messages/{id}` - Get message details
  • `POST /equipment/{id}/messages` - Send message

    • Alarms

  • `GET /alarms` - List alarms
  • `POST /alarms/{id}/acknowledge` - Acknowledge alarm

    • Events

  • `GET /events` - List events

    • OpenAPI Specification

    Full OpenAPI 3.0 spec available at `/api/docs`

    Was this page helpful? /