Skip to Content

apxy traffic

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

apxy logs

Read and manage captured traffic records.

apxy logs list

List captured HTTP traffic records from the proxy database.

apxy logs list [flags]

Examples:

apxy logs list apxy logs list --limit 10 --format markdown
FlagTypeDefaultDescription
--formatstringjsonOutput format: json, markdown, or toon
--limitint50Number of records
--offsetint0Pagination offset
-q, --quiet-falseOutput only IDs, one per line

apxy logs show

Show the full details of a single captured traffic record.

apxy logs show [flags]

Examples:

apxy logs show --id abc123
FlagTypeDefaultDescription
--formatstringjsonOutput format: json, markdown, or toon
--idstring-Record ID

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

apxy logs search [flags]

Examples:

apxy logs search --query "api.example.com" apxy logs search --query "error" --limit 5 --format markdown
FlagTypeDefaultDescription
--formatstringjsonOutput format: json, markdown, or toon
--limitint20Max results
--querystring-Search query
-q, --quiet-falseOutput only IDs, one per line

apxy logs search-bodies

Search request and response bodies in captured traffic.

apxy logs search-bodies [flags]
FlagTypeDefaultDescription
--formatstringjsonOutput format: json, markdown, or toon
--limitint20Max results
--patternstring-Text pattern to search
--scopestringbothSearch scope: request, response, or both

apxy logs stats

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

apxy logs stats [flags]

Examples:

apxy logs stats apxy logs stats --format toon
FlagTypeDefaultDescription
--formatstringjsonOutput format: json or toon

apxy logs clear

Delete ALL captured traffic records from the database.

Warning: This action cannot be undone.

apxy logs clear [flags]
FlagTypeDefaultDescription
--dry-run-falsePreview what would happen without executing

apxy logs diff

Compare two captured traffic records.

apxy logs diff [flags]
FlagTypeDefaultDescription
--id-astring-First record ID
--id-bstring-Second record ID
--scopestringbothWhat to diff: request, response, or both

apxy logs replay

Replay one captured request against the live upstream.

apxy logs replay [flags]
FlagTypeDefaultDescription
--idstring-Traffic record ID to replay
--portint8080Proxy port

apxy logs label

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

apxy logs label [flags]

Examples:

apxy logs label --id abc123 --color red --comment "investigate this 500 error"
FlagTypeDefaultDescription
--colorstring-Color label: red, green, blue, yellow, purple
--commentstring-Free-text comment
--idstring-Record ID

apxy logs jsonpath

Extract JSON fields from captured traffic bodies.

apxy logs jsonpath [flags]
FlagTypeDefaultDescription
--idstring-Traffic record ID
--pathstring-gjson path expression
--scopestringresponseWhich body: request or response

apxy logs graphql

Search captured GraphQL requests.

apxy logs graphql [flags]
FlagTypeDefaultDescription
--formatstringjsonOutput format: json, markdown, or toon
--limitint20Max results
--operation-namestring-Filter by operation name
--operation-typestring-Filter by type: query, mutation, subscription

apxy logs export-curl

Export one traffic record as a reusable client snippet.

apxy logs export-curl [flags]
FlagTypeDefaultDescription
--formatstringcurlExport format: curl, fetch, httpie, python
--idstring-Traffic record ID

apxy logs export-har

Export captured traffic as a HAR 1.2 file.

apxy logs export-har [flags]
FlagTypeDefaultDescription
--filestringstdoutOutput file path
--limitint10000Max records to export

See HAR Import & Export for details.

apxy logs import-har

Import traffic records from a HAR file.

apxy logs import-har [flags]
FlagTypeDefaultDescription
--filestring-HAR file to import

apxy traffic filter

Create and manage traffic filter rules for the running proxy.

apxy traffic filter set

Add a traffic filter rule that blocks or allows requests matching a domain pattern.

apxy traffic filter set [flags]

Examples:

apxy traffic filter set --type block --target "ads.example.com" apxy traffic filter set --type allow --target "*.internal.corp"
FlagTypeDefaultDescription
--control-urlstringhttp://localhost:8081Control API URL
--targetstring-Target domain pattern
--typestringblockFilter type: block or allow

apxy traffic filter list

List all configured traffic filter rules.

apxy traffic filter list [flags]
FlagTypeDefaultDescription
--control-urlstringhttp://localhost:8081Control API URL
--formatstringjsonOutput format: json or toon
-q, --quiet-falseOutput only IDs, one per line

apxy traffic filter remove

Remove a traffic filter rule by its unique ID, or remove all filter rules with --all.

apxy traffic filter remove [flags]

Examples:

apxy traffic filter remove --id abc123 apxy traffic filter remove --all
FlagTypeDefaultDescription
--all-falseApply to all resources
--control-urlstringhttp://localhost:8081Control API URL
--dry-run-falsePreview what would happen without executing
--idstring-Filter rule ID

See Filtering for details.


apxy recording

Start or stop traffic recording on the running proxy.

apxy recording start

Start capturing traffic on the running proxy.

apxy recording start [flags]
FlagTypeDefaultDescription
--control-urlstringhttp://localhost:8081Control API URL

apxy recording stop

Stop capturing traffic on the running proxy.

apxy recording stop [flags]
FlagTypeDefaultDescription
--control-urlstringhttp://localhost:8081Control API URL

apxy sql

Run read-only SQL queries against the APXY database.

apxy sql query

Run a read-only SQL SELECT query against the APXY SQLite database.

Available tables:

  • traffic_logs — id, timestamp, method, url, host, path, status_code, duration_ms, tls, mocked, …
  • mock_rules — id, name, priority, active, url_pattern, match_type, method, …
apxy sql query [SQL] [flags]

Examples:

apxy sql query "SELECT host, COUNT(*) FROM traffic_logs GROUP BY host"

See SQL Queries for table schemas and examples.


apxy traffic devices

List devices currently using the proxy.

apxy traffic devices list

List all devices currently connected through the proxy, showing IP, platform, client app, and request count.

apxy traffic devices list [flags]

Examples:

apxy devices list --format json apxy devices list --format toon
FlagTypeDefaultDescription
--formatstringmarkdownOutput format: json, markdown, or toon
--mobile-falseShow only mobile devices
-q, --quiet-falseOutput only IDs, one per line
--web-urlstringhttp://localhost:8082Web server URL

See Devices for details.


Inherited Options

FlagTypeDefaultDescription
--configstring./configs/default.yamlConfig file path
--error-formatstringtextError output format: text or json
--help-formatstringdefaultHelp output format: default or agent
--verbose-falseEnable verbose output
Last updated on