rig api

Available local and workspace. Reference source: CLI 0.13.0-rc.5 (824aefd6ad16). Sends an authenticated request to the Rigbox API and prints the JSON response. --body takes inline JSON, a path to a JSON file, or - for standard input; a body that is not valid JSON fails before anything is sent. When the server answers with an error, the response body is printed as it was sent and the command exits non-zero; with --output json, the error event carries status and body. Inside a workspace, requests go through the workspace bridge, which serves only that workspace’s routes.

Examples

Run from your local terminal. Replace uppercase placeholders with your own values. This invocation performs the operation described above.

rig api GET /v1/workspaces

Send an inline JSON body. Replace APP_ID with an app ID from rig app ls.

rig api PATCH /v1/apps/APP_ID --body '{"name":"web"}'

Inspect the supported arguments before running this command. Help is offline and does not modify resources.

rig api --help

Local syntax

Usage: rigbox api [OPTIONS] <METHOD> <PATH>

Arguments and flags

Argument	Description	Details
`method`	HTTP method (GET, POST, PUT, PATCH, DELETE)	Required; Value: METHOD
`path`	API path, e.g. /v1/workspaces	Required; Value: PATH
`--body`	Request body (non-GET): inline JSON such as ’{“name”:“web”}’, a JSON file path, or ’-’ for stdin	Value: JSON\|FILE
`--output`	Output format [default: human, or `rig config set output …`]	Global; Value: OUTPUT; Choices: human, json, yaml, text, table
`--query`	Filter output with a JMESPath expression	Global; Value: JMESPATH
`--cli-input-json`	Read inputs from a JSON file or ’-’ (stdin)	Global; Value: FILE
`--cli-input-yaml`	Read inputs from a YAML file or ’-’ (stdin)	Global; Value: FILE; Conflicts: cli_input_json
`--generate-cli-skeleton`	Print a fillable input template, then exit	Global; Default: false
`--no-pager`	Do not pipe help output through a pager	Global; Default: false
`-v, --verbose`	Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`	Global; Default: false
`-h, --help`	Print help

Complete command help

Send a raw authenticated request to the Rigbox API

Usage: rigbox api [OPTIONS] <METHOD> <PATH>

Arguments:
  <METHOD>
          HTTP method (GET, POST, PUT, PATCH, DELETE)

  <PATH>
          API path, e.g. /v1/workspaces

Options:
      --body <JSON|FILE>
          Request body (non-GET): inline JSON such as '{"name":"web"}', a JSON file path, or '-' for stdin

      --output <OUTPUT>
          Output format [default: human, or `rig config set output …`]
          
          [possible values: human, json, yaml, text, table]

      --query <JMESPATH>
          Filter output with a JMESPath expression

      --cli-input-json <FILE>
          Read inputs from a JSON file or '-' (stdin)

      --cli-input-yaml <FILE>
          Read inputs from a YAML file or '-' (stdin)

      --generate-cli-skeleton
          Print a fillable input template, then exit

      --no-pager
          Do not pipe help output through a pager

  -v, --verbose
          Verbose diagnostics on stderr: per-phase deploy tracing, job-poll status, and transport commands. Useful for debugging a slow or stuck `rig deploy`

  -h, --help
          Print help

Workspace syntax

Usage: rigbox api [OPTIONS] <METHOD> <PATH>

Arguments and flags

Argument	Description	Details
`method`	HTTP method (GET, POST, PUT, PATCH, DELETE)	Required; Value: METHOD
`path`	API path, e.g. /v1/workspaces	Required; Value: PATH
`--body`	Request body (non-GET): inline JSON such as ’{“name”:“web”}’, a JSON file path, or ’-’ for stdin	Value: JSON\|FILE
`--output`	Output format [default: human, or `rig config set output …`]	Global; Value: OUTPUT; Choices: human, json, yaml, text, table
`--query`	Filter output with a JMESPath expression	Global; Value: JMESPATH
`--no-pager`	Do not pipe help output through a pager	Global; Default: false
`-v, --verbose`	Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status)	Global; Default: false
`-h, --help`	Print help

Complete command help

Send a raw request to the Rigbox API (through the workspace bridge)

Usage: rigbox api [OPTIONS] <METHOD> <PATH>

Options:
      --output <OUTPUT>
          Output format [default: human, or `rig config set output …`]
          
          [possible values: human, json, yaml, text, table]

      --query <JMESPATH>
          Filter output with a JMESPath expression

      --no-pager
          Do not pipe help output through a pager

  -v, --verbose
          Verbose diagnostics on stderr (per-phase deploy tracing, job-poll status)

  -h, --help
          Print help

CLI:
      --body <JSON|FILE>
          Request body (non-GET): inline JSON such as '{"name":"web"}', a JSON file path, or '-' for stdin

  <METHOD>
          HTTP method (GET, POST, PUT, PATCH, DELETE)

  <PATH>
          API path, e.g. /v1/workspaces

Start here

Deploy applications

Configure applications

Workspaces and storage

AI and tools

Operate and troubleshoot

Examples

CLI reference

Build on Rigbox

Examples

Local syntax

Arguments and flags

Workspace syntax

Arguments and flags

​Examples

​Local syntax

​Arguments and flags

​Workspace syntax

​Arguments and flags

Examples

Local syntax

Arguments and flags

Workspace syntax

Arguments and flags