Start by confirming the environment requirements for your operating system and runtime. Install the required package, image, or deployment artifact using the method that matches your local or server setup. Next, create a dedicated workspace for the probe configuration, including any project folders, configuration files, and supporting assets you will use during testing. Keep the setup minimal and organized so the probe is ready for validation without extra dependencies.
Set up API Probe fast
Follow the installation and workspace steps to prepare API Probe for local or server-based testing.
Start setup guideWhat you need before setup
System requirements
Confirm your development environment meets the supported operating system, runtime, and storage requirements. Make sure you have the tools needed to install packages or deploy the probe service.
Installation methods
Choose the setup path that matches your workflow: package-based installation, container-based deployment, or a server install. Use the method recommended for your team’s test environment.
Deployment options
Prepare for either local execution on a workstation or deployment on a shared server. Select the option that fits your QA process, infrastructure, and access model.
Workspace preparation
Create a clean project folder, organize configuration files, and confirm your editor or terminal setup is ready. This keeps the probe configuration isolated and easy to maintain.
Set up the probe
Check readiness before testing
Installation confirmed
Verify the probe is installed in the intended environment and that the chosen installation method completed successfully. The setup should match the deployment path you planned.
Workspace prepared
Confirm your project structure, configuration files, and working directory are in place. A prepared workspace makes testing setup repeatable and easier to manage.
Environment ready
Check that the runtime, system access, and required local dependencies are available. Once these basics are in place, the probe is ready for testing setup validation.
Common setup questions
Can I install API Probe locally and on a server?
Yes. The setup guide supports both local workstation installation and server-based deployment, so you can choose the environment that matches your workflow.
Do I need to prepare a separate workspace?
A separate workspace is recommended. It helps keep configuration files, project assets, and setup steps organized for repeatable testing preparation.
Which installation method should I use?
Use the method that aligns with your infrastructure and team process. Package, container, and server deployment options are all suitable depending on your environment.
How do I know setup is complete?
Setup is complete when the probe is installed, the workspace is organized, and the environment meets the required system and runtime conditions for testing.