Request bodies
Pass the fields of a resource to create or update commands, as shorthand arguments or as JSON on stdin.
Commands that create or update a resource take its fields as their last arguments. Each command’s page in the command reference lists the fields, * marking the required ones.
Shorthand
Write the fields as name: value pairs, separated by commas, in one quoted argument:
kapten projects create 'name: storefront, description: "The online shop"'
- Nested fields use dots:
parent.child: value. []appends to a list:list[]: value.- Unquoted values become numbers,
true,falseornullwhen they look like one. Quote a value to keep it a string:port: "8080".
JSON
Pipe a JSON (or YAML) document to the command instead:
kapten projects create < project.json
echo '{"name": "storefront", "description": "The online shop"}' | kapten projects create
Shorthand arguments after a piped document change it before it is sent, which lets you reuse one file:
kapten projects create 'name: storefront-eu' < project.json
Check a body before sending it
--rsh-generate-body prints an example body for the command, with every field, and sends nothing. --rsh-validate checks the body against the API’s schema before sending it.