Skip to main content
RocketFi follows common REST conventions. The exact paths and bodies are defined in the REST API reference (generated from OpenAPI).

​
Supported verbs

MethodMeaning
GETRead a resource or list. Query parameters carry filters, pagination, and ids unless the path uses path parameters.
POSTCreate a resource or submit an action (for example batch operations) when the API models it as a creation or command.
PATCHPartial update when an endpoint supports partial modification.
DELETERemove or cancel when supported by the route.
Not every resource exposes every verb. If a method is not documented for a path, assume it is not supported.

​
Request format

  • Prefer Content-Type: application/json for bodies unless an endpoint explicitly accepts something else (for example plain text on the health/ping route).
  • Send query parameters in standard ?name=value&name2=value2 form unless the OpenAPI entry shows a different style.

​
Responses

Successful responses usually return JSON with a documented schema. Failures return appropriate HTTP status codes and, when applicable, a structured error payload — see Error responses.