{"@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"}
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.
This is the API for MIMIC client to connect to MIMIC daemon.
| method | path | what 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/acldb | Returns the current access control database in use. If nothing is specified then this returns "". Access |
GET | /mimic/access/get/admindir | Returns the current admin directory. If nothing is specified in admin/settings.cfg then returns "". If no admi |
GET | /mimic/access/get/adminuser | Returns the current administrator. If nothing is specified in admin/settings.cfg then returns "". Access |
GET | /mimic/access/get/enabled | Returns the state of access control checking. 0 indicates that it is disabled, 1 indicates it is enabled. Acce |
GET | /mimic/access/list | Returns 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/list | List the source addresses that the agent will accept messages from. This in effect implements source-address-i |
GET | /mimic/agent/{agentNum}/get/changed | has the agent value space changed? has the agent value space changed? Agent |
GET | /mimic/agent/{agentNum}/get/config_changed | has the lab configuration changed? has the lab configuration changed? Agent |
GET | /mimic/agent/{agentNum}/get/delay | one-way transit delay in msec. The minimum granularity is 10 msec. Agent |
GET | /mimic/agent/{agentNum}/get/drops | drop 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/host | host 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_timeout | timeout in seconds for retransmitting INFORM PDUs. The agent will retransmit INFORM PDUs at this interval unti |
GET | /mimic/agent/{agentNum}/get/interface | network interface card for the agent. network interface card for the agent. Agent |
GET | /mimic/agent/{agentNum}/get/mask | subnet mask of the agent. subnet mask of the agent. Agent |
GET | /mimic/agent/{agentNum}/get/mibs | set of MIBs, simulations and scenarios set of MIBs, simulations and scenarios Agent |
GET | /mimic/agent/{agentNum}/get/num_starts | number of starts for the agent. This count is incremented each time an agent starts. It affects the SNMPv3 Eng |
GET | /mimic/agent/{agentNum}/get/oiddir | MIB directory of the agent. MIB directory of the agent. Agent |
GET | /mimic/agent/{agentNum}/get/owner | owner of the agent. owner of the agent. Agent |
GET | /mimic/agent/{agentNum}/get/pdusize | maximum PDU size. The limit for this configurable is 65536. Agent |
GET | /mimic/agent/{agentNum}/get/port | port number port number Agent |
GET | /mimic/agent/{agentNum}/get/privdir | private directory of the agent. private directory of the agent. Agent |
GET | /mimic/agent/{agentNum}/get/protocol | protocols supported by agent protocols supported by agent as an array of strings Agent |
GET | /mimic/agent/{agentNum}/get/read | read community string read community string Agent |
GET | /mimic/agent/{agentNum}/get/scen | first scenario name first scenario name Agent |
GET | /mimic/agent/{agentNum}/get/sim | first simulation name first simulation name Agent |
GET | /mimic/agent/{agentNum}/get/start | relative start time relative start time Agent |
GET | /mimic/agent/{agentNum}/get/state | current 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_changed | has the agent state changed? has the agent state changed? Agent |
GET | /mimic/agent/{agentNum}/get/statistics | current statistics of the agent instance The statistics are returned as 64-bit decimal numbers for the followi |
GET | /mimic/agent/{agentNum}/get/trace | SNMP PDU tracing SNMP PDU tracing Agent |
GET | /mimic/agent/{agentNum}/get/validate | SNMP 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.