Configuration API
Configuration APIs manage creation, retrieval, validation, and updates of organization-level system settings. All APIs are authenticated and protected via RBAC.Endpoints Overview
| Category | Method | Endpoint | Purpose |
|---|---|---|---|
| Organization | GET | /organizations | Fetch all organizations for the Select Organization dropdown |
| Configuration | GET | /configurations | Fetch all configurations (admin/debug use) |
| Configuration | GET | /configurations/:id | Fetch a configuration by its ID |
| Configuration | GET | /configurations/organization/:organizationId | Load configuration for a selected organization |
| Configuration | POST | /configurations | Create a new configuration for an organization |
| Configuration | PUT | /configurations/:id | Update an existing configuration |
| Configuration | DELETE | /configurations/:id | Delete a configuration (not exposed in UI) |
| Validation | POST | /configurations/test-smtp | Test SMTP credentials and email delivery |
| Validation | POST | /configurations/test-aws | Test AWS access (S3, SES, CloudWatch) |
Configuration APIs
Get Configuration by Organization
- Loads configuration for the selected organization.
- Returns 404 if none exists.
Create Configuration
- Creates a new configuration for an organization.
- Used when saving configuration for the first time.
Update Configuration
- Updates existing configuration.
- Replaces SMTP, AWS, and AI model settings.
Delete Configuration
- Soft or hard deletes a configuration.
- Not exposed in UI.
Validation APIs
Test SMTP Configuration
- Verifies SMTP credentials.
- Sends a test email internally.
Test AWS Configuration
- Verifies access to S3, SES, and CloudWatch.
- Confirms permissions and connectivity.
Organization API (Supporting)
- Used to populate organization selector.