MIMIC REST API

Name: MIMIC REST API API
Brand: MIMIC REST API
Availability: InStock

✓ Official Vendor SpecIOTDevice Managementbasic356 EndpointsREST

For Agents

Drive Gambit Communications' MIMIC network device simulator over 356 REST endpoints to spin up SNMP, IPMI, IoT, and Telnet simulated agents and orchestrate large lab scenarios from automation.

Connect the MIMIC REST API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the MIMIC REST API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with MIMIC REST API API.

Query simulator state including version, last log entries, and connected client list via /mimic/get/* operations

Inspect and modify simulator configuration through cfgfile and cfgfile_changed checks

Drive simulated SNMP, IPMI, IoT, and Telnet agents from CI by issuing /mimic/* control calls

Track per-client and per-session statistics via the /mimic/get/clients and related telemetry endpoints

GET STARTED

Start building with MIMIC REST API API

Explore with Jentic

View OpenAPI Document

The MIMIC REST API is the programmatic control surface for Gambit Communications' MIMIC simulator, the industry-standard tool for simulating thousands of SNMP, IPMI, NetFlow, sFlow, IoT, and Telnet/SSH devices for network management testing. The 356 endpoints under /mimic let test engineers create simulated agents, configure protocol behaviour, control logging and statistics, manage simulator clients, and orchestrate large-scale lab scenarios from CI pipelines. Authentication uses HTTP basic credentials and the simulator runs locally so the base URL points at 127.0.0.1. The API is targeted at NMS vendors, network operators, and IoT platform builders who need to validate management software against device populations far larger than physical lab inventory allows.

Use Cases

Patterns agents use MIMIC REST API API for, with concrete tasks.

★ Continuous Integration of NMS Software

Add simulated network device coverage to a CI pipeline by calling the MIMIC REST API to start, configure, and tear down simulated SNMP agents alongside the NMS software under test. The 356 control endpoints mean tests can replicate populations of thousands of devices without physical hardware, catching regressions earlier.

Call /mimic/get/version, then start the configured scenario, run the NMS test suite, and tear the simulator down via the matching control endpoint.

Large-Scale IoT Device Simulation

Spin up tens of thousands of simulated IoT and IPMI devices for performance and scale testing of an IoT platform by orchestrating MIMIC scenarios from a control plane. The REST surface lets engineers script the same scenario across multiple simulator hosts.

Issue control calls under /mimic to start the IoT scenario, then poll /mimic/get/clients to confirm the expected device count is online.

Lab Configuration Drift Detection

Detect drift in a long-running lab by polling /mimic/get/cfgfile_changed and /mimic/get/cfgfile so any unexpected configuration change in the simulator is logged and alerted. Catching drift early keeps test results reproducible across CI runs.

Poll GET /mimic/get/cfgfile_changed every minute and emit an alert when the response indicates a change since the last known checksum.

Agent-Driven Test Orchestration via Jentic

An NMS-test agent receives a request like 'spin up the 1000-device SNMP scenario and run the regression suite' and uses Jentic to discover the right /mimic control endpoints, load their schemas, and execute them with credentials from the vault. Jentic isolates the simulator credentials so the agent's prompt stays clean.

Search Jentic for 'list mimic clients', load /mimic/get/clients, and execute it after starting the scenario to confirm the simulated devices are connected.

Key Endpoints

356 endpoints — the mimic rest api is the programmatic control surface for gambit communications' mimic simulator, the industry-standard tool for simulating thousands of snmp, ipmi, netflow, sflow, iot, and telnet/ssh devices for network management testing.

METHOD

PATH

DESCRIPTION

GET

/mimic/get/version

Get the MIMIC simulator version

GET

/mimic/get/max

Get the maximum number of agents supported

GET

/mimic/get/clients

List currently connected simulator clients

GET

/mimic/get/cfgfile

Read the active simulator config file metadata

GET

/mimic/get/cfgfile_changed

Check whether the config file has changed

GET

/mimic/get/log

Read the simulator log buffer

GET

/mimic/get/return

Get the return code of the last simulator command

GET

/mimic/get/last

Read the last simulator action result

GET

/mimic/get/version

Get the MIMIC simulator version

GET

/mimic/get/max

Get the maximum number of agents supported

GET

/mimic/get/clients

List currently connected simulator clients

GET

/mimic/get/cfgfile

Read the active simulator config file metadata

GET

/mimic/get/cfgfile_changed

Check whether the config file has changed

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

MIMIC HTTP basic credentials are stored encrypted in the Jentic vault (MAXsystem) and injected into the Authorization header at execution time, keeping lab credentials out of the agent's prompt and CI logs.

Intent-based discovery

Agents search Jentic with intents like 'list mimic clients' or 'get mimic simulator version' and Jentic returns the matching /mimic/get/* operation with its parameter schema.

Time to first call

Direct integration: 1-2 days including basicAuth wiring and CI pipeline glue. Through Jentic: under 1 hour — search, load, execute against the vaulted credential.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

ngrok API

Tunnelling service often used to expose a local MIMIC simulator host to remote CI runners.

Choose this alongside MIMIC when the simulator host is on-prem and CI workers need authenticated remote access to the 127.0.0.1 endpoints.

Alternative

Microsoft Graph API

Real device and identity management API for Microsoft-managed endpoints, contrasting with MIMIC's simulator-only scope.

Pick this only when the workflow actually needs to manage live Microsoft-managed devices rather than simulated SNMP, IPMI, or IoT agents.

FAQs

Specific to using MIMIC REST API API through Jentic.

What authentication does the MIMIC REST API use?

MIMIC uses HTTP basic authentication (basicAuth in the spec) — every request carries an Authorization header with username and password configured on the simulator host. Through Jentic, the credentials are held encrypted in the vault so the agent never sees them.

Can I list connected clients on a running MIMIC simulator?

Yes. GET /mimic/get/clients returns the simulator's currently connected clients so test orchestration can confirm the expected device count is online before running assertions.

What are the rate limits for the MIMIC REST API?

MIMIC runs on a local lab host (the spec lists 127.0.0.1 as the server) and the OpenAPI document does not declare numeric rate limits across the 356 endpoints. Throughput is bounded by simulator host capacity rather than a published quota.

How do I check if a MIMIC config file has changed through Jentic?

Run a Jentic search for 'check mimic cfgfile changed', load GET /mimic/get/cfgfile_changed, and execute it on a polling loop to detect drift. Get started at https://app.jentic.com/sign-up.

Does MIMIC simulate protocols beyond SNMP?

Yes. The simulator covers SNMP, IPMI, NetFlow, sFlow, Telnet, SSH, and a broad set of IoT protocols, all controllable through the same /mimic REST surface so a single test harness can drive heterogeneous device populations.