API Tester Agent

The CLI agent is a lightweight local proxy that lets the API Tester reach endpoints on your machine or private network — URLs that are not reachable from the public internet.

Install

npm install -g @247365/api-agent

Usage

api-agent start --token <your-token>

Once running, the agent opens a WebSocket tunnel between your machine and the 247365 API Tester. The status indicator in the app will turn green when the connection is established.

Getting a token

Your agent token is available in the API Tester settings panel. Sign in, open Settings, and copy the token shown under CLI Agent.

Troubleshooting

Agent shows as disconnected — check that the process is still running and your token is correct.
Firewall blocking the connection — the agent connects outbound on port 443; ensure your firewall allows outbound HTTPS/WSS.
Port conflict — by default the agent listens on port 7365 locally. Pass --port <n> to use a different port.
Reconnecting — stop the process and run api-agent start again. The app will reconnect automatically within a few seconds.

← Back to API Tester