opschain api routes
Included from Basic tier
Lists every route the API serves, from the same OpenAPI document
opschain api spec prints: the targeted server's routes, or this binary's
embedded inventory with --local. Rows are sorted by path then method and
rendered as a table (METHOD PATH AUTH SUMMARY); -o json|yaml emits the
rows as {method, path, auth, summary} documents instead. When nothing
matches the filters it prints no matching routes.
Flags
| Flag | Meaning |
|---|---|
--method <verb> | Only routes with this HTTP method (e.g. GET); case-insensitive. |
--contains <text> | Only routes whose path or summary contains this text (case-insensitive). Combines with --method as AND. |
Exit codes
| Code | Meaning |
|---|---|
| 0 | Routes listed (an empty match is still 0). |
| 1 | The OpenAPI document could not be fetched or parsed. |
| 2 | Usage error. |
Examples
All artifact routes on the targeted server:
opschain api routes --contains artifact
The embedded inventory's write surface:
opschain api routes --local --method POST
See also
opschain docs cli/api-spec— the full OpenAPI document these rows come from.