v17

latestOpenAPI 3.0.2MITraw.githubusercontent.com2026-08-03263343.4 KB

stubs

Getting a list of stubs

The list of stubs is required to view all added stubs. Use source query param to filter by source.

get/stubs

Query parameters

sourcestring

Filter by source (file, rest, mcp, proxy)

servicestring

Filter by service name (exact match)

methodstring

Filter by method name (exact match)

sessionstring

Filter by session ID (empty means global stubs)

qstring

Case-insensitive substring search over service, method and stub ID

matcherstring

Filter by matcher kind(s) present on the stub input. Comma-separated for OR semantics (e.g. "glob,anyOf"). Valid kinds: equals, contains, matches, glob, anyOf.

limitinteger

Maximum number of returned stubs

offsetinteger

Number of stubs to skip before returning results

sortstring

Sort order for result list

Response

Successful operation

idstring uuid

servicestring required

methodstring required

priorityinteger

Priority of the stub. Higher priority stubs are matched first.

usedboolean

Response-only — whether the stub has matched at least once. Ignored on input.

sourcestring

Source of the stub (file, rest, mcp, proxy)

Example response

[
  {
    "id": "51c50050-ec27-4dae-a583-a32ca71a1dd5",
    "service": "Gripmock",
    "method": "SayHello",
    "output": {
      "error": "Message not found",
      "code": 3,
      "delay": "1s"
    }
  }
]