Nimbu Developer Docs
CLI

Raw API

Use the API escape hatch for endpoints without dedicated CLI UX.

Prefer native commands. For unsupported endpoints, use the verb-first raw API interface:

nimbu api get /unsupported_resources --all
nimbu api patch /unsupported_resources/ID --data '{"enabled":true}'
nimbu api post /unsupported_resources --data @payload.json
cat payload.json | nimbu api put /unsupported_resources/ID --data -

The paths above are placeholders for endpoints without a dedicated command. Shipping rates and the complete consent configuration have dedicated commands; see Audited workflows. Do not use raw API calls for those resources unless you need behavior the native commands do not expose.

--all follows paginated JSON array responses. Binary responses use --output. Raw delete requests require --force, like native delete commands. The legacy --method and --path flags remain supported for compatibility.