Skip to main content

​
Current Status

Veratrace does not currently have a published public API specification. The API endpoints documented in this reference are inferred from the frontend codebase and may not reflect the actual backend implementation. Source: /docs/_generated/feature-inventory.md - API Surface section

​
What’s Available

​
Inferred API Endpoints

API endpoints have been inferred from frontend API client code. These endpoints are instance-scoped and use REST conventions:
  • Base URL: http://localhost:8080 (development)
  • Instance Scoping: All endpoints are scoped to an instance: /instances/:instanceId/{resource}
  • Pagination: List endpoints return paginated responses
Source: Feature Inventory - API Surface

​
Authentication

Veratrace uses AWS Cognito for authentication via OpenID Connect (OIDC). Each instance has its own Cognito user pool. Documentation: Source: /docs/pages/authentication.mdx, Feature Inventory - Core Objects (Instance)

​
Data Model

The data model defines core objects and their relationships:
  • Instance, TWU Model, Agent, Integration, User, Work Ledger Entry
Documentation: Source: /docs/pages/reference/data-model.mdx, Feature Inventory - Core Objects

​
Permissions

Role-based permissions are defined in mock data. Permission enforcement is not found in the frontend codebase. Documentation: Source: /docs/pages/reference/permissions.mdx, Feature Inventory - User Roles and Permissions

​
What’s Not Available

The following are not currently available:
  • ❌ OpenAPI Specification - No OpenAPI/Swagger spec found
  • ❌ tRPC Router Definitions - No tRPC router found
  • ❌ GraphQL Schema - No GraphQL schema found
  • ❌ Public API Documentation - No published API specification
  • ❌ Webhooks - Webhooks not yet implemented
  • ❌ Events - Event system not found in codebase
  • ❌ API Versioning - Versioning scheme not documented
  • ❌ Rate Limiting - Rate limits not documented
  • ❌ Error Response Formats - Error formats not documented
Source: Feature Inventory - API Surface, Evidence + Audit Concepts

​
API Reference Pages

​
Main API Documentation

​
Resource-Specific APIs

​
Supporting Documentation

​
TODOs for Public API Reference

To publish a complete public API reference, the following are needed:

​
1. OpenAPI Specification

​
2. Authentication Scheme

​
3. API Versioning

​
4. Error Responses

​
5. Rate Limiting

​
6. Webhooks

​
7. Events

​
8. Production Base URL

​
Finding the Actual API Implementation

Since no OpenAPI spec, tRPC router, or GraphQL schema was found, use these paths to locate the actual backend implementation:

​
Backend Route Definitions

  • ../clearline-backend/**/routes/** - REST route definitions
  • ../clearline-backend/**/controllers/** - Controller implementations
  • ../clearline-backend/**/handlers/** - Request handlers

​
API Specification Files

  • ../clearline-backend/**/openapi.json - OpenAPI 3.0 specification
  • ../clearline-backend/**/swagger.yaml - Swagger 2.0 specification
  • ../clearline-backend/**/api.yaml - API specification

​
tRPC (if used)

  • ../clearline-backend/**/trpc/** - tRPC router definitions
  • ../clearline-backend/**/routers/** - tRPC routers

​
GraphQL (if used)

  • ../clearline-backend/**/schema.graphql - GraphQL schema
  • ../clearline-backend/**/schema.gql - GraphQL schema
  • ../clearline-backend/**/graphql/** - GraphQL resolvers
Source: Feature Inventory - API Surface