Alex Blank
c4be7163d6
- API documentation for config profiles with git mounts endpoint details - User guide for using git repositories in config profiles - Document branch pinning, glob patterns, error handling, and best practices - Update API README to link to new config-profiles documentation
API Documentation
Overview
The Headquarter API is a RESTful API built with FastAPI. All endpoints (except auth) require authentication via session cookie.
Base URL
- Development:
http://localhost:8000 - Production:
https://api.yourdomain.com
Authentication
Most endpoints require authentication. Include the session cookie in requests:
curl http://api.example.com/endpoint \
-H "Cookie: session=your_session_cookie"
Response Format
All responses are JSON. Error responses follow this format:
{
"detail": "Error message"
}
API Sections
- Auth - Authentication endpoints
- Projects - Project management
- Repositories - Git repositories and file operations
- Config Profiles - Config profile management with git mounts
- Users - User management and settings
- Tool Types - Tool type management
- SSH Keys - SSH key management
Testing
Interactive API documentation is available at /docs when running the backend:
http://localhost:8000/docs
This provides:
- Interactive endpoint testing
- Request/response schemas
- Authentication via "Authorize" button