mimic-rest-api

name	mimic-rest-api
description	MIMIC REST API skill. Use when working with MIMIC REST for mimic. Covers 356 endpoints.
version	1.0.0
generator	lapsh

MIMIC REST API

API version: 21.00

Auth

Bearer basic

Base URL

http://127.0.0.1

Setup

1. Set Authorization header with your Bearer token
2. GET /mimic/get/max -- verify access
3. POST /mimic/agent/{agentNum}/add/{IP} -- create first add

Endpoints

356 endpoints across 1 groups. See references/api-spec.lap for full details.

mimic

Method	Path	Description
GET	/mimic/get/max	The maximum number of agent instances.
GET	/mimic/get/last	The last configured agent instance.
GET	/mimic/get/version	The version of the MIMIC command interface.
GET	/mimic/get/clients	The number of clients currently connected to the daemon.
GET	/mimic/get/cfgfile	The currently loaded lab configuration file for the particular user.
GET	/mimic/get/cfgfile_changed	This predicate indicates if the currently loaded agent configuration file has changed.
GET	/mimic/get/return	The return mode.
GET	/mimic/get/log	The current log file for the Simulator.
GET	/mimic/get/protocols	The set of protocols supported by the Simulator.
GET	/mimic/get/interfaces	The set of network interfaces that can be used for simulations.
GET	/mimic/get/product	The product number that is licensed.
GET	/mimic/get/netaddr	The network address of the host where the MIMIC simulator is running.
GET	/mimic/get/netdev	The default network device to be used for agent addresses.
GET	/mimic/get/configured_list	The list of {agentnum} that are currently configured.
GET	/mimic/get/active_list	The list of {agentnum} that are currently active (running or paused).
GET	/mimic/get/active_data_list	The list of {agentnum {statistics}} for agents that are currently active and whose statistics have changed since the last invocation of this command.
GET	/mimic/get/changed_config_list	The list of {agentnum} for which a configurable parameter changed.
GET	/mimic/get/changed_state_list	The list of {agentnum state} for which the state changed.
GET	/mimic/mget/{infoArray}	Get multiple sets of information about MIMIC, where infoArray is one of the parameters defined in the mimic get command.

Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:

• "List all max?" -> GET /mimic/get/max
• "List all last?" -> GET /mimic/get/last
• "List all version?" -> GET /mimic/get/version
• "List all clients?" -> GET /mimic/get/clients
• "List all cfgfile?" -> GET /mimic/get/cfgfile
• "List all cfgfile_changed?" -> GET /mimic/get/cfgfile_changed
• "List all return?" -> GET /mimic/get/return
• "List all log?" -> GET /mimic/get/log
• "List all protocols?" -> GET /mimic/get/protocols
• "List all interfaces?" -> GET /mimic/get/interfaces
• "List all product?" -> GET /mimic/get/product
• "List all netaddr?" -> GET /mimic/get/netaddr
• "List all netdev?" -> GET /mimic/get/netdev
• "List all configured_list?" -> GET /mimic/get/configured_list
• "List all active_list?" -> GET /mimic/get/active_list
• "List all active_data_list?" -> GET /mimic/get/active_data_list
• "List all changed_config_list?" -> GET /mimic/get/changed_config_list
• "List all changed_state_list?" -> GET /mimic/get/changed_state_list
• "Get mget details?" -> GET /mimic/mget/{infoArray}
• "Update a load?" -> PUT /mimic/load/{cfgFile}/{firstAgentNum}/{lastAgentNum}/{startAgentNum}
• "Update a clear?" -> PUT /mimic/clear/{firstAgentNum}/{lastAgentNum}
• "Update a savea?" -> PUT /mimic/saveas/{cfgFile}/{firstAgentNum}/{lastAgentNum}
• "List all interface?" -> GET /mimic/agent/{agentNum}/get/interface
• "List all host?" -> GET /mimic/agent/{agentNum}/get/host
• "List all mask?" -> GET /mimic/agent/{agentNum}/get/mask
• "List all port?" -> GET /mimic/agent/{agentNum}/get/port
• "List all protocol?" -> GET /mimic/agent/{agentNum}/get/protocol
• "List all read?" -> GET /mimic/agent/{agentNum}/get/read
• "List all write?" -> GET /mimic/agent/{agentNum}/get/write
• "List all delay?" -> GET /mimic/agent/{agentNum}/get/delay
• "List all start?" -> GET /mimic/agent/{agentNum}/get/start
• "List all mibs?" -> GET /mimic/agent/{agentNum}/get/mibs
• "List all sim?" -> GET /mimic/agent/{agentNum}/get/sim
• "List all scen?" -> GET /mimic/agent/{agentNum}/get/scen
• "List all state?" -> GET /mimic/agent/{agentNum}/get/state
• "List all statistics?" -> GET /mimic/agent/{agentNum}/get/statistics
• "List all changed?" -> GET /mimic/agent/{agentNum}/get/changed
• "List all config_changed?" -> GET /mimic/agent/{agentNum}/get/config_changed
• "List all state_changed?" -> GET /mimic/agent/{agentNum}/get/state_changed
• "List all trace?" -> GET /mimic/agent/{agentNum}/get/trace

Response Tips

• Check response schemas in references/api-spec.lap for field details
• Create/update endpoints typically return the created/updated object

References

• Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

Generated from the official API spec by LAP