apxy tools

HTTP request tools, Protobuf decoding, and database management.

apxy tools request

Send manual requests and analyze request behavior.

apxy tools request compose

Send a single HTTP request through the proxy and display the response.


apxy tools request compose [flags]

Examples:


apxy tools request compose --url "https://api.example.com/health"
 
apxy tools request compose --method POST \
  --url "https://api.example.com/data" \
  --body '{"key":"value"}' \
  --headers '{"Authorization":"Bearer tok"}'

Flag	Type	Default	Description
`--body`	`string`	-	Request body
`--headers`	`string`	-	Request headers as `k=v,k2=v2`
`--method`	`string`	`GET`	HTTP method
`--url`	`string`	-	Request URL (required)

apxy tools request batch

Send multiple HTTP requests defined in a JSON file and report results. Optionally compare live results with historical traffic.


apxy tools request batch [flags]

Examples:


apxy tools request batch --file endpoints.json
apxy tools request batch --file endpoints.json --compare-history --format json

Flag	Type	Default	Description
`--compare-history`	-	`false`	Compare live results with historical traffic
`--file`	`string`	-	JSON file with endpoint specs (required)
`--format`	`string`	`markdown`	Output format: `json`, `markdown`, or `toon`
`--time-range`	`int`	`60`	History window in minutes
`--timeout`	`int`	`10000`	Default per-request timeout in ms

apxy tools request diagnose

Analyze historical traffic records for endpoints defined in a JSON file and produce a diagnostic report.


apxy tools request diagnose [flags]

Examples:


apxy tools request diagnose --file endpoints.json
apxy tools request diagnose --file endpoints.json --time-range 120 --match-mode exact

Flag	Type	Default	Description
`--file`	`string`	-	JSON file with endpoint specs (required)
`--format`	`string`	`markdown`	Output format: `json`, `markdown`, or `toon`
`--match-mode`	`string`	`contains`	URL matching: `exact`, `contains`, or `prefix`
`--time-range`	`int`	`60`	How many minutes of history to search

The request subgroup also inherits --port (default 8080) for commands that send live requests.

apxy tools protobuf

apxy tools protobuf add-schema


apxy tools protobuf add-schema [flags]

Flag	Type	Default	Description
`--content`	`string`	-	Inline proto content
`--file`	`string`	-	Path to `.proto` file
`--name`	`string`	-	Schema name

apxy tools protobuf list-schemas

List registered Protobuf schemas.


apxy tools protobuf list-schemas [flags]

apxy tools protobuf decode

Decode the Protobuf body of a traffic record.


apxy tools protobuf decode [flags]

Flag	Type	Default	Description
`--id`	`string`	-	Traffic record ID
`--scope`	`string`	`response`	Body scope: `request` or `response`

apxy tools protobuf remove-schema

Remove a registered Protobuf schema by ID.


apxy tools protobuf remove-schema [flags]

Flag	Type	Default	Description
`--id`	`string`	-	Schema ID

See Protobuf Support for details.

apxy tools db

Inspect and clean the APXY database.

apxy tools db info

Show APXY database information.


apxy tools db info [flags]

apxy tools db clean

Delete rows from APXY database tables.


apxy tools db clean [flags]

Flag	Type	Default	Description
`--all`	-	`false`	Clear everything
`--rules`	-	`false`	Clear mock rules
`--traffic`	-	`false`	Clear traffic logs

Inherited Options

Flag	Type	Default	Description
`--config`	`string`	`./configs/default.yaml`	Config file path
`--error-format`	`string`	`text`	Error output format: `text` or `json`
`--help-format`	`string`	`default`	Help output format: `default` or `agent`
`--verbose`	-	`false`	Enable verbose output