Local runtime

Run a Mock API Server Locally

The cloud dashboard stores project configuration, while the CLI starts the generated Express API and SQLite data store on your machine. Requests and CRUD state stay in the local runtime instead of being served by a hosted public mock endpoint.

What runs locally?

Express routes, generated response records, authentication simulation, query behavior, latency, failures, OpenAPI output, and SQLite persistence run in the CLI process on your computer. The CLI contacts Mock API Studio to authenticate and synchronize accessible project configuration when it starts.

Start a synchronized project

Run the interactive picker or provide a project slug. After synchronization, the terminal prints the base URL and enabled routes.

Shell
npx mock-api-studio-cli start customer-portal

# Override the configured port
npx mock-api-studio-cli start customer-portal --port 4500

Persist local CRUD changes

Each project stores records in .mock-api-studio/<slug>.db under the launch directory. Mutations survive restarts while the schema and configuration hash remain compatible. A material change can require regenerated state.

Text
.mock-api-studio/
└── customer-portal.db

Synchronize dashboard changes

The runtime does not currently watch cloud configuration. Stop and restart the CLI after saving changes in the dashboard. Team viewers can synchronize accessible projects but cannot edit their cloud configuration.

Related questions

Does Mock API Studio host my generated endpoint?

No. It manages configuration in the cloud and runs the generated API locally through the CLI.

Keep exploring

Last updated September 17, 2026. Product behavior described here is verified against the current Mock API Studio runtime.