{"@context": "https://schema.org", "@type": "WebAPI", "name": "MIMIC REST API API", "description": "This is the API for MIMIC client to connect to MIMIC daemon.", "provider": {"@type": "Organization", "name": "gambitcomm.local"}, "documentation": "https://www.gambitcomm.com/docs/mimic.yaml"}
Index / APIs / gambitcomm.local

MIMIC REST API API

This is the API for MIMIC client to connect to MIMIC daemon.

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: http://gambitcomm.local http://127.0.0.1

auth: b a s i c

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

MIMIC REST API v21.00

This is the API for MIMIC client to connect to MIMIC daemon.

methodpathwhat the vendor says it does
POST/mimic/access/add/{user}/{agents}/{mask}Adds/Overwrites the user entry in the access control database. Adds/Overwrites the user entry in the access co
DELETE/mimic/access/del/{user}Clears a users entry from access control database. Using '*' for user clears all the users. Access
GET/mimic/access/get/acldbReturns the current access control database in use. If nothing is specified then this returns "". Access
GET/mimic/access/get/admindirReturns the current admin directory. If nothing is specified in admin/settings.cfg then returns "". If no admi
GET/mimic/access/get/adminuserReturns the current administrator. If nothing is specified in admin/settings.cfg then returns "". Access
GET/mimic/access/get/enabledReturns the state of access control checking. 0 indicates that it is disabled, 1 indicates it is enabled. Acce
GET/mimic/access/listReturns an array of entries. Each entry consists of user, agents (in minimal range representation) and access
PUT/mimic/access/load/{filename}Loads the specified file for access control data. If filename is not specified then the currently set 'acldb'
PUT/mimic/access/save/{filename}Saves current access control data in specified file. If filename is not specified then the currently set 'acld
PUT/mimic/access/set/acldb/{databaseName}Allows setting the name of the current access control database. This will be used for subsequent load and save
PUT/mimic/access/set/enabled/{enabledOrNot}Allows the user to enable/disable the access control check. 0 indicates disabled, 1 indicates enabled. Access
POST/mimic/agent/{agentNum}/add/{IP}Add an agent. Add an agent. Agent
POST/mimic/agent/{agentNum}/from/add/{IP}/{port}Add a source address that the agent will accept messages from. An empty ipaddress or 0.0.0.0 both imply any ad
DELETE/mimic/agent/{agentNum}/from/delete/{IP}/{port}delete a source address that the agent will accept messages from. An empty ipaddress or 0.0.0.0 both imply any
GET/mimic/agent/{agentNum}/from/listList the source addresses that the agent will accept messages from. This in effect implements source-address-i
GET/mimic/agent/{agentNum}/get/changedhas the agent value space changed? has the agent value space changed? Agent
GET/mimic/agent/{agentNum}/get/config_changedhas the lab configuration changed? has the lab configuration changed? Agent
GET/mimic/agent/{agentNum}/get/delayone-way transit delay in msec. The minimum granularity is 10 msec. Agent
GET/mimic/agent/{agentNum}/get/dropsdrop rate (every N-th PDU). 0 means no drops. drop rate (every N-th PDU). 0 means no drops. Agent
GET/mimic/agent/{agentNum}/get/hosthost address of the agent. Currently, only IPv4 addresses are allowed as the main address of the agent, but bo
GET/mimic/agent/{agentNum}/get/inform_timeouttimeout in seconds for retransmitting INFORM PDUs. The agent will retransmit INFORM PDUs at this interval unti
GET/mimic/agent/{agentNum}/get/interfacenetwork interface card for the agent. network interface card for the agent. Agent
GET/mimic/agent/{agentNum}/get/masksubnet mask of the agent. subnet mask of the agent. Agent
GET/mimic/agent/{agentNum}/get/mibsset of MIBs, simulations and scenarios set of MIBs, simulations and scenarios Agent
GET/mimic/agent/{agentNum}/get/num_startsnumber of starts for the agent. This count is incremented each time an agent starts. It affects the SNMPv3 Eng
GET/mimic/agent/{agentNum}/get/oiddirMIB directory of the agent. MIB directory of the agent. Agent
GET/mimic/agent/{agentNum}/get/ownerowner of the agent. owner of the agent. Agent
GET/mimic/agent/{agentNum}/get/pdusizemaximum PDU size. The limit for this configurable is 65536. Agent
GET/mimic/agent/{agentNum}/get/portport number port number Agent
GET/mimic/agent/{agentNum}/get/privdirprivate directory of the agent. private directory of the agent. Agent
GET/mimic/agent/{agentNum}/get/protocolprotocols supported by agent protocols supported by agent as an array of strings Agent
GET/mimic/agent/{agentNum}/get/readread community string read community string Agent
GET/mimic/agent/{agentNum}/get/scenfirst scenario name first scenario name Agent
GET/mimic/agent/{agentNum}/get/simfirst simulation name first simulation name Agent
GET/mimic/agent/{agentNum}/get/startrelative start time relative start time Agent
GET/mimic/agent/{agentNum}/get/statecurrent running state of the agent 0-Unknown 1-Running 2-Stopped 3-Halted 4-Paused 5-Deleted 6-Stopping Agent
GET/mimic/agent/{agentNum}/get/state_changedhas the agent state changed? has the agent state changed? Agent
GET/mimic/agent/{agentNum}/get/statisticscurrent statistics of the agent instance The statistics are returned as 64-bit decimal numbers for the followi
GET/mimic/agent/{agentNum}/get/traceSNMP PDU tracing SNMP PDU tracing Agent
GET/mimic/agent/{agentNum}/get/validateSNMP SET validation policy. Is a bitmask in which with the following bits (from LSB) check for type, length, r

and 160 more operation(s) in this specification, all searchable.

specification origin: https://www.gambitcomm.com/docs/mimic.yaml

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.