Frequently asked questions
General
Section titled “General”Is Restorm free?
Section titled “Is Restorm free?”Yes. The Community edition works without an account and without limits: every execution protocol, every import, scenarios in the interface, mock servers, the firewall.
The Pro and Enterprise editions unlock capabilities — continuous-integration runs, built-in git, advanced MCP tools, SSO — never quotas. See Plans and capabilities.
Do I need to create an account?
Section titled “Do I need to create an account?”No, except to activate a paid edition.
Which platforms?
Section titled “Which platforms?”Windows (installer), macOS (arm64 and Intel), Linux (AppImage, .deb, .rpm).
See Installation.
Does my data go anywhere?
Section titled “Does my data go anywhere?”No. Projects are files on your own disk, mock servers run on your machine, and the firewall blocks by default every outbound call that does not come from your project.
Projects and files
Section titled “Projects and files”What format is a project in?
Section titled “What format is a project in?”A .restorm file, in YAML by default (json and json5 are also
available), or a directory tree. See
.restorm projects and files.
Can I commit it?
Section titled “Can I commit it?”Yes, that is the intended way to share it. Serialisation is deterministic so that diffs stay readable.
Add *.responses.zip and restorm.env to your .gitignore — see
File formats.
How do I share a project with my team?
Section titled “How do I share a project with my team?”Through git. There is no hosted workspace. See Teams and seats.
Where are my secrets stored?
Section titled “Where are my secrets stored?”Never in the project. Either in a local secrets file, or read from the system’s environment variables. See Secrets.
Protocols
Section titled “Protocols”Which protocols are supported?
Section titled “Which protocols are supported?”Fifteen: HTTP, GraphQL, gRPC, SOAP, WebSocket, Socket.IO, MQTT, SSE, STOMP, OData, JSON-RPC, tRPC, Redis, AMQP, Kafka. See the catalogue.
What about Thrift? AMQP 1.0? NATS?
Section titled “What about Thrift? AMQP 1.0? NATS?”No. Thrift imports for documentation purposes but does not execute; only AMQP 0-9-1 (RabbitMQ) is implemented; NATS is not supported.
Can I mock a server?
Section titled “Can I mock a server?”Yes, on six protocols: HTTP, GraphQL, gRPC, SOAP, WebSocket / Socket.IO / MQTT, and OData. Locally, offline. See Server mode.
Import
Section titled “Import”Can I import my Postman collections?
Section titled “Can I import my Postman collections?”Yes, including your scripts, which become a runnable scenario thanks to the
pm.* compatibility layer. See
Migrating from Postman.
How many formats?
Section titled “How many formats?”Twenty-four. See Importing an API.
What happens when the specification changes?
Section titled “What happens when the specification changes?”Twelve formats are re-syncable: Restorm applies the delta, marks vanished operations as deprecated and keeps your edits. See Updating from the source.
Variables and authentication
Section titled “Variables and authentication”Why isn’t my {{variable}} being substituted?
Section titled “Why isn’t my {{variable}} being substituted?”Almost always because the value is of type String rather than Expression: a string is sent as it is. See Variables and environments.
Where is the “authentication type” menu?
Section titled “Where is the “authentication type” menu?”There isn’t one. Restorm uses authentication requests: a dedicated request that obtains the token and declares the headers it produces, with expiry and automatic renewal. That is more general than a closed list. See Authentication.
Is OAuth 2 supported?
Section titled “Is OAuth 2 supported?”Yes, by modelling the token call as an authentication request. There is no dedicated OAuth flow wizard.
What about AWS SigV4, NTLM, Digest?
Section titled “What about AWS SigV4, NTLM, Digest?”Those schemes are not implemented natively today.
Scenarios and CI
Section titled “Scenarios and CI”How does a scenario differ from a script?
Section titled “How does a scenario differ from a script?”It is a visible graph: the data flow is the drawing, branches and loops are boxes. See Introduction to scenarios.
Can I still write code?
Section titled “Can I still write code?”Yes, in seven languages: TypeScript, JavaScript, Python, Lua, Ruby, R and C#. See Code actions.
How do I run a scenario in CI?
Section titled “How do I run a scenario in CI?”restorm --open projet.restorm --run "Tests" --headlessOn a Linux runner, prefix it with xvfb-run -a. Headless execution requires a
Pro plan and a token in RESTORM_TOKEN. See
Headless execution and CI.
What does exit code 3 mean?
Section titled “What does exit code 3 mean?”A denied entitlement: missing, invalid or revoked token, or an insufficient plan. The message says which.
AI and MCP
Section titled “AI and MCP”Can an AI drive Restorm?
Section titled “Can an AI drive Restorm?”Yes, through the built-in MCP server, which is on by default. Driving requests is included in the Community edition; scenarios, screenshots and interface automation belong to the Pro edition.
Can an agent see my secrets?
Section titled “Can an agent see my secrets?”Yes: an agent drives Restorm on your behalf and receives a secret’s resolved value, exactly as you see it in the application. They are your secrets. What the Secret type guarantees is that they go neither into the project, nor into an export, nor out to an unauthorised third-party service. Every call is recorded in the MCP logs.
Does the MCP server run on my CI servers?
Section titled “Does the MCP server run on my CI servers?”No, never: on a machine with no display it does not start, whatever the setting says.
Does the built-in git replace my command line?
Section titled “Does the built-in git replace my command line?”It complements it. It uses your local git: if git push works in your
terminal, it works in Restorm. Its real value is conflict resolution, which
shows entities in their genuine editors. See
Built-in git.
Is it included for free?
Section titled “Is it included for free?”No, it belongs to the Pro edition. Nothing stops you from using git on the command line against a Restorm project in the Community edition — the format is designed for it.
Miscellaneous
Section titled “Miscellaneous”How do I change the language?
Section titled “How do I change the language?”Settings ▸ Appearance ▸ Language — 27 languages available.
How do I change the theme?
Section titled “How do I change the theme?”Settings ▸ Appearance ▸ Theme — 14 themes, applied live. See Themes.
Does Restorm update itself?
Section titled “Does Restorm update itself?”Yes for directly downloaded packages (AppImage, Windows installer, .dmg). The
.deb and .rpm packages go through your package manager. See
Installation.