Skip to Content
CLI ReferenceTraffic

apxy traffic

View, filter, query, and manage captured network traffic.

apxy logs

Read and manage captured traffic records

Options

  -h, --help   help for logs

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 logs clear

Delete all captured traffic records

Synopsis

Delete ALL captured traffic records from the database.

WARNING: This action cannot be undone.

apxy logs clear [flags]

Examples

  apxy logs clear

Options

      --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 clear

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 logs - Read and manage captured traffic records

apxy logs diff

Compare two captured traffic records

apxy logs diff [flags]

Options

  -h, --help           help for diff
      --id-a string    first record ID
      --id-b string    second record ID
      --scope string   what to diff: request|response|both (default "both")

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 logs - Read and manage captured traffic records

apxy logs export-curl

Export one traffic record as a reusable client snippet

apxy logs export-curl [flags]

Options

      --format string   export format: curl|fetch|httpie|python (default "curl")
  -h, --help            help for export-curl
      --id string       traffic record ID
      --redact          alias for --safe
      --safe            redact sensitive values before exporting

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 logs - Read and manage captured traffic records

apxy logs export-har

Export captured traffic as a HAR 1.2 file

apxy logs export-har [flags]

Options

      --file string   output file path (prints to stdout if omitted)
  -h, --help          help for export-har
      --limit int     max records to export (default 10000)
      --redact        alias for --safe
      --safe          redact sensitive values before exporting

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 logs - Read and manage captured traffic records

apxy logs graphql

Search captured GraphQL requests

apxy logs graphql [flags]

Options

      --format string           output format: json|markdown|toon (default "json")
  -h, --help                    help for graphql
      --limit int               max results (default 20)
      --operation-name string   filter by operation name
      --operation-type string   filter by type: query|mutation|subscription

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 logs - Read and manage captured traffic records

apxy logs import-har

Import traffic records from a HAR file

apxy logs import-har [flags]

Options

      --file string   HAR file to import
  -h, --help          help for import-har

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 logs - Read and manage captured traffic records

apxy logs jsonpath

Extract JSON fields from captured traffic bodies

apxy logs jsonpath [flags]

Options

  -h, --help           help for jsonpath
      --id string      traffic record ID
      --path string    gjson path expression
      --scope string   which body: request|response (default "response")

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 logs - Read and manage captured traffic records

apxy logs label

Add a label and comment to a traffic record

Synopsis

Add a color label and free-text comment to a captured traffic record for easy identification.

Flags: —id record ID (required) —color color label: red, green, blue, yellow, purple —comment free-text comment to attach

apxy logs label [flags]

Examples

  apxy logs label --id abc123 --color red --comment "investigate this 500 error"

Options

      --color string         color label: red, green, blue, yellow, purple
      --comment string       free-text comment
      --control-url string   control API URL (default "http://127.0.0.1:8081")
  -h, --help                 help for label
      --id string            record 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 logs - Read and manage captured traffic records

apxy logs list

List captured traffic records

Synopsis

List captured HTTP traffic records from the proxy database.

Flags: —limit number of records to return (default: 50) —offset pagination offset (default: 0) —format output format: json, markdown, or toon (default: json)

apxy logs list [flags]

Examples

  apxy logs list
  apxy logs list --limit 10 --format markdown

Options

      --format string   output format: json|markdown|toon (default "json")
  -h, --help            help for list
      --limit int       number of records (default 50)
      --offset int      pagination offset
  -q, --quiet           output only IDs, one per line
      --raw             show raw record values in JSON output

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 logs - Read and manage captured traffic records

apxy logs replay

Replay one captured request against the live upstream

apxy logs replay [flags]

Options

  -h, --help        help for replay
      --id string   traffic record ID to replay
      --port int    proxy port (default 8080)

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 logs - Read and manage captured traffic records

apxy logs search-bodies

Search request and response bodies in captured traffic

apxy logs search-bodies [flags]

Options

      --format string    output format: json|markdown|toon (default "json")
  -h, --help             help for search-bodies
      --limit int        max results (default 20)
      --pattern string   text pattern to search
      --scope string     search scope: request|response|both (default "both")

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 logs - Read and manage captured traffic records

Search captured traffic records

Synopsis

Search captured traffic records by URL, headers, or body content.

Flags: —query search query string —limit maximum number of results (default: 20) —format output format: json, markdown, or toon (default: json)

apxy logs search [flags]

Examples

  apxy logs search --query "api.example.com"
  apxy logs search --query "error" --limit 5 --format markdown

Options

      --format string   output format: json|markdown|toon (default "json")
  -h, --help            help for search
      --limit int       max results (default 20)
      --query string    search query
  -q, --quiet           output only IDs, one per line
      --raw             show raw record values in JSON output

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 logs - Read and manage captured traffic records

apxy logs show

Show one captured traffic record by ID

Synopsis

Show the full details of a single captured traffic record.

Flags: —id record ID (required) —format output format: json, markdown, or toon (default: json)

apxy logs show [flags]

Examples

  apxy logs show --id abc123

Options

      --format string   output format: json|markdown|toon (default "json")
  -h, --help            help for show
      --id string       record ID
      --raw             show raw record values in JSON output

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 logs - Read and manage captured traffic records

apxy logs sse-events

List parsed SSE events for a traffic record

apxy logs sse-events [flags]

Options

      --format string   output format: text or json (default "text")
  -h, --help            help for sse-events
      --id string       traffic record ID
      --limit int       max events to return (default 100)

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 logs - Read and manage captured traffic records

apxy logs sse-merge

Merge AI streaming SSE events into a single response

apxy logs sse-merge [flags]

Options

      --format string   output format: text or json (default "text")
  -h, --help            help for sse-merge
      --id string       traffic record 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 logs - Read and manage captured traffic records

apxy logs stats

Show summary statistics for captured traffic

Synopsis

Show aggregate statistics for captured traffic, including request counts, status code distribution, and top domains.

apxy logs stats [flags]

Examples

  apxy logs stats

Options

      --control-url string   control API URL (default "http://127.0.0.1:8081")
  -h, --help                 help for stats

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 logs - Read and manage captured traffic records

apxy logs tail

Live-tail traffic from a running apxy instance

Synopsis

Connects to a running apxy proxy’s SSE endpoint and prints traffic records in real-time.

apxy logs tail [flags]

Options

      --format string   output format: text or json (default "text")
  -h, --help            help for tail
      --host string     filter by host pattern
      --port int        port of the running apxy web API (default: proxy port + 2) (default 8082)
      --sse             show only SSE traffic and events

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 logs - Read and manage captured traffic records

apxy recording

Start or stop traffic recording on the running proxy

Options

  -h, --help   help for recording

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 recording start

Start capturing traffic on the running proxy

apxy recording start [flags]

Options

      --control-url string   control API URL (default "http://127.0.0.1:8081")
  -h, --help                 help for start

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 recording - Start or stop traffic recording on the running proxy

apxy recording stop

Stop capturing traffic on the running proxy

apxy recording stop [flags]

Options

      --control-url string   control API URL (default "http://127.0.0.1:8081")
  -h, --help                 help for stop

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 recording - Start or stop traffic recording on the running proxy
Last updated on
ProxyFilter