Skip to Content

Breakpoints

Breakpoints let you pause HTTP traffic mid-flight, inspect the request or response, make changes, and then resume or drop it entirely. This gives you interactive, real-time control over individual requests — useful for debugging authentication flows, testing edge cases, or manipulating specific API calls on the fly.

Paid feature — requires a license with breakpoint editing capability.

Concepts

A breakpoint rule defines which traffic to pause using the same DSL match expressions used by interceptors. Each rule specifies a phase:

PhaseWhat pauses
requestThe outgoing request is paused before it reaches the server
responseThe server response is paused before it reaches the client
bothBoth phases are paused independently

When a request matches a breakpoint rule, it becomes a pending breakpoint — held in memory until you resolve it (resume, modify, or drop).

Pending breakpoints have a configurable timeout. If not resolved before the timeout, the request is forwarded unchanged.

CLI

All apxy breakpoint … subcommands (add, list, remove, enable, disable, pending, resolve) are documented in CLI Reference → Breakpoints.

Quick example:

apxy breakpoint add \ --name "pause-auth" \ --match "path contains /api/auth" \ --phase request \ --timeout 30000

Web API

MethodEndpointDescription
GET/api/v1/breakpointsList all breakpoint rules
POST/api/v1/breakpointsCreate a new rule
PUT/api/v1/breakpoints/{id}/enableEnable a rule
PUT/api/v1/breakpoints/{id}/disableDisable a rule
DELETE/api/v1/breakpoints/{id}Delete a rule
GET/api/v1/breakpoints/pendingList pending (paused) requests
POST/api/v1/breakpoints/{id}/resolveResume or drop a pending request

Use Cases

Debug an authentication flow

Pause the login request, inspect the payload, and verify tokens before they reach the server — add a request-phase breakpoint whose match targets your login path (see the Breakpoints reference for resolve options).

Test error handling

Pause a response-phase breakpoint on a sensitive path, then resolve with an overridden status and body to simulate server errors.

Inspect a specific request before it fires

Pause traffic to a third-party host with a longer timeout if you need time to inspect outbound calls.

Last updated on