Urlbox

Any option with --json

Use --json to pass any Urlbox API option through the CLI, even ones without a dedicated flag.

The CLI gives the most common options their own flags, like --width and --full-page. For anything else, including newer options that don't have a flag yet, use --json.

Passing options as JSON

urlbox render --json '{"url":"https://example.com","width":1920,"full_page":true}' --output shot.png

Whatever you put in --json is sent to the Urlbox API exactly as written, so every API option is available this way, including ones added after your version of the CLI. If you also set a flag, the flag wins. You can keep options in a file and reference it too:

urlbox render --json @options.json --output shot.png

For the full list of options, their types and examples, see the render options reference.

On this page