CLICommand referenceapi

api

Commands, arguments, and options for openship api.

See the workflow guide for examples. Global flags such as --json go before the command; see global options.

openship api

Make an authenticated request to any Openship API route (like gh api)

openship api [options] <path>
ArgumentMeaning
pathPath under /api, e.g. /projects or /deployments/<id>
OptionMeaning
-X, --method <method>HTTP method (defaults to GET, or POST when --data is given)
-d, --data <json>Request body as a JSON string
-q, --query <kv...>Query parameter key=value (repeatable)

On this page