mimic-rest-api — quality + safety report

---
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. |
| PUT | /mimic/set/log | The current log file for the Simulator. |
| PUT | /mimic/set/netdev | The network address of the host where the MIMIC simulator is running. |
| PUT | /mimic/set/persistent | This operation flushes all global objects which need to be made persistent to disk. |
| PUT | /mimic/load/{cfgFile}/{firstAgentNum}/{lastAgentNum}/{startAgentNum} | Load the lab configuration file file. |
| PUT | /mimic/clear/{firstAgentNum}/{lastAgentNum} | Clear the lab configuration. |
| PUT | /mimic/saveas/{cfgFile}/{firstAgentNum}/{lastAgentNum} | Save the lab configuration in file. |
| PUT | /mimic/save | Save the lab configuration. |
| PUT | /mimic/start | Start MIMIC. |
| PUT | /mimic/stop | Stop MIMIC. |
| PUT | /mimic/terminate | Terminate the MIMIC daemon. |
| POST | /mimic/agent/{agentNum}/add/{IP} | Add an agent. |
| DELETE | /mimic/agent/{agentNum}/remove | Remove the current agent. |
| PUT | /mimic/agent/{agentNum}/start | Start the current agent. |
| PUT | /mimic/agent/{agentNum}/stop | Show the agent's primary IP address |
| PUT | /mimic/agent/{agentNum}/pause | Pause the current agent. |
| PUT | /mimic/agent/{agentNum}/halt | Halt the current agent. |
| PUT | /mimic/agent/{agentNum}/reload | Reload the current agent. |
| PUT | /mimic/agent/{agentNum}/resume | Resume the current agent. |
| GET | /mimic/agent/{agentNum}/get/interface | network interface card for the agent. |
| GET | /mimic/agent/{agentNum}/get/host | host address of the agent. |
| GET | /mimic/agent/{agentNum}/get/mask | subnet mask of the agent. |
| GET | /mimic/agent/{agentNum}/get/port | port number |
| GET | /mimic/agent/{agentNum}/get/protocol | protocols supported by agent |
| GET | /mimic/agent/{agentNum}/get/read | read community string |
| GET | /mimic/agent/{agentNum}/get/write | write community string |
| GET | /mimic/agent/{agentNum}/get/delay | one-way transit delay in msec. |
| GET | /mimic/agent/{agentNum}/get/start | relative start time |
| GET | /mimic/agent/{agentNum}/get/mibs | set of MIBs, simulations and scenarios |
| GET | /mimic/agent/{agentNum}/get/sim | first simulation name |
| GET | /mimic/agent/{agentNum}/get/scen | first scenario name |
| GET | /mimic/agent/{agentNum}/get/state | current running state of the agent |
| GET | /mimic/agent/{agentNum}/get/statistics | current statistics of the agent instance |
| GET | /mimic/agent/{agentNum}/get/changed | has the agent value space changed? |
| GET | /mimic/agent/{agentNum}/get/config_changed | has the lab configuration changed? |
| GET | /mimic/agent/{agentNum}/get/state_changed | has the agent state changed? |
| GET | /mimic/agent/{agentNum}/get/trace | SNMP PDU tracing |
| GET | /mimic/agent/{agentNum}/get/pdusize | maximum PDU size. |
| GET | /mimic/agent/{agentNum}/get/drops | drop rate (every N-th PDU). 0 means no drops. |
| GET | /mimic/agent/{agentNum}/get/owner | owner of the agent. |
| GET | /mimic/agent/{agentNum}/get/privdir | private directory of the agent. |
| GET | /mimic/agent/{agentNum}/get/oiddir | MIB directory of the agent. |
| GET | /mimic/agent/{agentNum}/get/validate | SNMP SET validation policy. |
| GET | /mimic/agent/{agentNum}/get/inform_timeout | timeout in seconds for retransmitting INFORM PDUs. |
| GET | /mimic/agent/{agentNum}/get/num_starts | number of starts for the agent. |
| PUT | /mimic/agent/{agentNum}/set/interface/{interface} | network interface card for the agent |
| PUT | /mimic/agent/{agentNum}/set/host/{host} | host address of the agent. |
| PUT | /mimic/agent/{agentNum}/set/mask/{mask} | subnet mask of the agent. |
| PUT | /mimic/agent/{agentNum}/set/port/{port} | port number |
| PUT | /mimic/agent/{agentNum}/set/protocol | protocols supported by agent as a comma-separated list |
| PUT | /mimic/agent/{agentNum}/set/read/{read} | read community string |
| PUT | /mimic/agent/{agentNum}/set/write/{write} | write community string |
| PUT | /mimic/agent/{agentNum}/set/delay/{delay} | one-way transit delay in msec |
| PUT | /mimic/agent/{agentNum}/set/start/{start} | relative start time |
| PUT | /mimic/agent/{agentNum}/set/mibs | set of MIBs, simulations and scenarios |
| PUT | /mimic/agent/{agentNum}/set/trace/{trace} | SNMP PDU tracing |
| PUT | /mimic/agent/{agentNum}/set/pdusize/{pdusize} | maximum PDU size |
| PUT | /mimic/agent/{agentNum}/set/drops/{drops} | drop rate (every N-th PDU) |
| PUT | /mimic/agent/{agentNum}/set/owner/{owner} | owner of the agent |
| PUT | /mimic/agent/{agentNum}/set/privdir/{privdir} | private directory of the agent. |
| PUT | /mimic/agent/{agentNum}/set/oiddir/{oiddir} | MIB directory of the agent. |
| PUT | /mimic/agent/{agentNum}/set/validate/{validate} | SNMP SET validation policy |
| PUT | /mimic/agent/{agentNum}/set/inform_timeout/{inform_timeout} | timeout in seconds for retransmitting INFORM PDUs |
| PUT | /mimic/agent/{agentNum}/save | Save agent MIB values. |
| GET | /mimic/agent/{agentNum}/ipalias/list | Lists all the additional ipaliases configured for the agent. |
| POST | /mimic/agent/{agentNum}/ipalias/add/{IP}/{port}/{mask}/{interface} | Adds a new ipalias for the agent. |
| DELETE | /mimic/agent/{agentNum}/ipalias/delete/{IP}/{port} | Deletes an existing ipalias from the agent. |
| PUT | /mimic/agent/{agentNum}/ipalias/start/{IP}/{port} | Starts an existing ipalias for the agent. |
| PUT | /mimic/agent/{agentNum}/ipalias/stop/{IP}/{port} | Stops an existing ipalias for the agent. |
| GET | /mimic/agent/{agentNum}/ipalias/status/{IP}/{port} | Returns the status (0=down, 1=up) of an existing ipalias for the agent. |
| GET | /mimic/agent/{agentNum}/trap/config/list | List the set of trap destinations for this agent instance. |
| POST | /mimic/agent/{agentNum}/trap/config/add/{IP}/{port} | Add a trap destination to the set of destinations. |
| DELETE | /mimic/agent/{agentNum}/trap/config/delete/{IP}/{port} | Remove a trap destination from the set of destinations. |
| GET | /mimic/agent/{agentNum}/trap/list | List the outstanding asynchronous traps for this agent instance. |
| GET | /mimic/agent/{agentNum}/from/list | List the source addresses that the agent will accept messages from. |
| POST | /mimic/agent/{agentNum}/from/add/{IP}/{port} | Add a source address that the agent will accept messages from. |
| DELETE | /mimic/agent/{agentNum}/from/delete/{IP}/{port} | delete a source address that the agent will accept messages from. |
| GET | /mimic/agent/{agentNum}/protocol/{prot}/get/config | Returns the protocol's configuration. |
| GET | /mimic/agent/{agentNum}/value/list/{OID} | Display the MIB objects below the current position |
| GET | /mimic/agent/{agentNum}/value/oid/{object} | Return the numeric OID of the specified object. |
| GET | /mimic/agent/{agentNum}/value/name/{OID} | Return the symbolic name of the specified object identifier. |
| GET | /mimic/agent/{agentNum}/value/mib/{object} | Return the MIB that defines the specified object. |
| GET | /mimic/agent/{agentNum}/value/info/{object} | Return the syntactical information for the specified object, such as type, size, range, enumerations, and ACCESS. |
| GET | /mimic/agent/{agentNum}/value/instances/{object} | Display the MIB object instances for the specified object. |
| GET | /mimic/agent/{agentNum}/value/eval/{object}/{instance} | Evaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests. |
| GET | /mimic/agent/{agentNum}/value/variables/{object}/{instance} | Display the variables for the specified instance instance for the specified MIB object object |
| GET | /mimic/agent/{agentNum}/value/split/{OID} | Split the numerical OID into the object OID and instance OID. |
| GET | /mimic/agent/{agentNum}/value/get/{object}/{instance}/{variable} | Get a variable in the Value Space. |
| PUT | /mimic/agent/{agentNum}/value/set/{object}/{instance}/{variable} | Set a variable in the Value Space. |
| GET | /mimic/agent/{agentNum}/value/meval/{objInsArray} | Evaluate the values of the specified instance instance for each specified MIB object object and return it as it would through SNMP requests. |
| PUT | /mimic/agent/{agentNum}/value/mset | Set multiple variables in the Value Space. |
| PUT | /mimic/agent/{agentNum}/value/munset | Unset multiple variables in the Value Space |
| GET | /mimic/agent/{agentNum}/value/mget/{objInsVarArray} | Get multiple variables in the Value Space. |
| PUT | /mimic/agent/{agentNum}/value/unset/{object}/{instance}/{variable} | Unset a variable in the Value Space in order to free its memory. |
| POST | /mimic/agent/{agentNum}/value/add/{object}/{instance} | Add an entry to a table. |
| DELETE | /mimic/agent/{agentNum}/value/remove/{object}/{instance} | Remove an entry from a table. |
| GET | /mimic/agent/{agentNum}/value/state/get/{object} | Get the state of a MIB object object. |
| PUT | /mimic/agent/{agentNum}/value/state/set/{object}/{state} | Set the state of a MIB object object |
| PUT | /mimic/store/set/{var}/{persist} | Set the variable store for the global storage |
| PUT | /mimic/agent/{agentNum}/store/set/{var}/{persist} | These commands allow the creation of a new variable, or changing an existing value. |
| PUT | /mimic/store/lreplace/{var}/{index} | These commands treat the variable as a list, and allow to replace an entry in the list at the specified index with the specified value. The variable has to already exist. |
| PUT | /mimic/agent/{agentNum}/store/lreplace/{var}/{index} | These commands treat the variable as a list, and allow to replace an entry in the list at the specified index with the sp

… (truncated)