List all local Mockoon environment files. Returns the file path for each environment, which can be passed to start_mock. Searches the default storage directory and any extra directories set via MOCKOON_DATA_DIRS.

Create a new Mockoon environment

Delete a Mockoon environment by UUID. The environment file will be permanently removed from disk.

List all routes in a Mockoon environment with their UUIDs, method, endpoint and number of responses.

Return full details of a single route including all responses (status codes, labels, rules, headers, body).

Create a new HTTP route with a single default response. Use create_route_with_responses to add multiple responses in one call.

Create a new HTTP route together with all its responses (default + conditionals) in a single call. The first response in the list is treated as the default unless one has isDefault=true.

Update a route's method, endpoint, documentation and/or its default response (body, status code, headers). Only provided fields are changed.

Clone an existing route (with all its responses) into the same environment. All UUIDs are regenerated. The copy gets '(copy)' appended to its documentation.

Create multiple routes at once. Each item in the array follows the same structure as create_route_with_responses. Ideal for scaffolding an entire API in one call.

Delete a route and all its responses from a Mockoon environment.

Add a new conditional or alternative response to an existing route. Use rules to define when this response is activated.

Set an existing response as the default for a route (demotes all other responses). Use get_route to list response UUIDs.

Return the current default response of a route (status code, headers, body). Use get_route for full details including all responses.

List all databuckets (data templates) in a Mockoon environment

Create a new databucket (data template) in a Mockoon environment

Update the content of an existing databucket

Delete a databucket from a Mockoon environment

Start a Mockoon mock server from a local environment JSON file. Use list_environments to find available file paths. Returns immediately with an error if the server is already running.

Stop a running Mockoon mock server. Returns an error message if no server is running for the given environment.

List the UUIDs of all Mockoon environments currently running as mock servers.