Skip to main content

Mock Engine Service API

The Mock Engine Service is the core of SureStage - managing instances, routes, responses, stateful mock behavior, collaborators, instance exports, and prospect portals.

Base URL (local): http://localhost:3003 Swagger UI: http://localhost:3003/api/docs

Endpoints

TagDescription
instancesInstance CRUD, lifecycle management
routesRoute definitions and configuration
responsesResponse templates and selection logic
mock-stateStateful mock data management
mockLive mock request handling
collaboratorsInstance collaborator management (add, remove, update permissions)
exportInstance export in Postman, Insomnia, and OpenAPI formats
prospect-portalsPublic portal creation, management, and engagement analytics
OpenAPI Spec

Auto-generated API docs from the OpenAPI spec will populate this section. Access the interactive Swagger UI at localhost:3003/api/docs.