Skip to Content
CLI ReferenceBreakpoints

Breakpoints pause matching requests or responses mid-flight so you can inspect and modify them before they continue. Unlike mocks (which return a fixed response), breakpoints let you see the live request and decide what to do in the moment.

Pending breakpoints appear in the web UI and via breakpoint pending. Resolve them with breakpoint resolve or from the web UI.

apxy breakpoint

Create and manage breakpoint rules for the running proxy

Options

  -h, --help   help for breakpoint

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

apxy breakpoint add

Add a breakpoint rule

Synopsis

Add a breakpoint rule that pauses matching requests or responses for manual inspection.

Flags: —name breakpoint name (required) —match DSL match expression (required) —phase phase to intercept: request, response, or both (default: both) —timeout auto-resume timeout in milliseconds (default: 30000)

apxy breakpoint add [flags]

Examples

  apxy breakpoint add --name "pause-login" --match "path contains /login" --phase request
  apxy breakpoint add --name "inspect-errors" --match "status >= 500" --phase response --timeout 60000

Options

      --control-url string   control API URL (default "http://127.0.0.1:8081")
  -h, --help                 help for add
      --match string         DSL match expression
      --name string          breakpoint name
      --phase string         phase: request, response, or both (default "both")
      --timeout int          auto-resume timeout in milliseconds (default 30000)

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy breakpoint - Create and manage breakpoint rules for the running proxy

apxy breakpoint disable

Disable a breakpoint rule

Synopsis

Disable a breakpoint rule without removing it, or disable all breakpoint rules with —all. Disabled rules will not pause traffic.

Either —id or —all is required. Use “apxy breakpoint list” to find rule IDs.

apxy breakpoint disable [flags]

Examples

  apxy breakpoint disable --id abc123
  apxy breakpoint disable --all

Options

      --all                  apply to all resources
      --control-url string   control API URL (default "http://127.0.0.1:8081")
      --dry-run              preview what would happen without executing
  -h, --help                 help for disable
      --id string            breakpoint rule ID

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy breakpoint - Create and manage breakpoint rules for the running proxy

apxy breakpoint edit

Edit a breakpoint rule

Synopsis

Edit an existing breakpoint rule. Only the flags you supply are updated; all other fields remain unchanged.

Flags: —name breakpoint name —match DSL match expression —phase phase to intercept: request, response, or both —timeout auto-resume timeout in milliseconds

apxy breakpoint edit <id> [flags]

Examples

  apxy breakpoint edit abc123 --timeout 60000
  apxy breakpoint edit abc123 --phase response --match "status >= 500"

Options

      --control-url string   control API URL (default "http://127.0.0.1:8081")
  -h, --help                 help for edit
      --match string         DSL match expression
      --name string          breakpoint name
      --phase string         phase: request, response, or both
      --timeout int          auto-resume timeout in milliseconds

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy breakpoint - Create and manage breakpoint rules for the running proxy

apxy breakpoint enable

Enable a breakpoint rule

Synopsis

Re-enable a previously disabled breakpoint rule by its unique ID, or enable all breakpoint rules with —all.

Either —id or —all is required. Use “apxy breakpoint list” to find rule IDs.

apxy breakpoint enable [flags]

Examples

  apxy breakpoint enable --id abc123
  apxy breakpoint enable --all

Options

      --all                  apply to all resources
      --control-url string   control API URL (default "http://127.0.0.1:8081")
      --dry-run              preview what would happen without executing
  -h, --help                 help for enable
      --id string            breakpoint rule ID

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy breakpoint - Create and manage breakpoint rules for the running proxy

apxy breakpoint list

List breakpoint rules

Synopsis

List all configured breakpoint rules, including their IDs, names, match expressions, and phases.

Flags: —format output format: json or toon (default: json)

apxy breakpoint list [flags]

Examples

  apxy breakpoint list
  apxy breakpoint list --format toon

Options

      --control-url string   control API URL (default "http://127.0.0.1:8081")
      --format string        output format: json|toon (default "json")
  -h, --help                 help for list
  -q, --quiet                output only IDs, one per line

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy breakpoint - Create and manage breakpoint rules for the running proxy

apxy breakpoint pending

List requests currently paused at breakpoints

Synopsis

List all requests and responses that are currently paused at a breakpoint, waiting for resolution.

apxy breakpoint pending [flags]

Examples

  apxy breakpoint pending

Options

      --control-url string   control API URL (default "http://127.0.0.1:8081")
  -h, --help                 help for pending
  -q, --quiet                output only IDs, one per line

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy breakpoint - Create and manage breakpoint rules for the running proxy

apxy breakpoint remove

Remove a breakpoint rule by ID or all breakpoint rules

Synopsis

Remove a breakpoint rule by its unique ID, or remove all breakpoint rules with —all.

Either —id or —all is required. Use “apxy breakpoint list” to find rule IDs.

apxy breakpoint remove [flags]

Examples

  apxy breakpoint remove --id abc123
  apxy breakpoint remove --all

Options

      --all                  apply to all resources
      --control-url string   control API URL (default "http://127.0.0.1:8081")
      --dry-run              preview what would happen without executing
  -h, --help                 help for remove
      --id string            breakpoint rule ID

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy breakpoint - Create and manage breakpoint rules for the running proxy

apxy breakpoint resolve

Resume a paused request at a breakpoint

Synopsis

Resume a request or response that is currently paused at a breakpoint, optionally modifying it.

Flags: —id pending breakpoint ID (required) —status override the response status code —headers override headers as a JSON object (e.g. ’{“Content-Type”:“text/plain”}’) —body override the response body —drop drop the request/response instead of forwarding

apxy breakpoint resolve [flags]

Examples

  apxy breakpoint resolve --id abc123
  apxy breakpoint resolve --id abc123 --status 200 --body '{"ok":true}' --headers '{"Content-Type":"application/json"}'

Options

      --body string          override body
      --control-url string   control API URL (default "http://127.0.0.1:8081")
      --drop                 drop request/response instead of forwarding
      --dry-run              preview what would happen without executing
      --headers string       override headers as JSON object
  -h, --help                 help for resolve
      --id string            pending breakpoint ID
      --status int           override status code

Options inherited from parent commands

      --config string         config file (default is ./configs/default.yaml)
      --error-format string   error output format: text|json (default "text")
      --help-format string    help output format: default|agent (default "default")
      --output string         output format: agent|human (default: auto-detect via TTY)
      --verbose               enable verbose output

SEE ALSO

  • apxy breakpoint - Create and manage breakpoint rules for the running proxy
Last updated on
ScriptCaching