Getting startedGuidesReferenceChangelog
Apoxy:// Docs / Reference / EgressGateway

EgressGateway

API reference for Egress Gateways (compute.apoxy.dev/v1alpha1)

API Group: compute.apoxy.dev/v1alpha1

Operations

List EgressGateway

GET/apis/compute.apoxy.dev/v1alpha1/egressgateways

List EgressGateway

Response

  • 200: OK

Create EgressGateway

POST/apis/compute.apoxy.dev/v1alpha1/egressgateways

create an EgressGateway

Request Body

Spec fields (EgressGatewaySpec):

FieldTypeDescription
defaultPolicystringDefaultPolicy applies to traffic that matches no attached route. Defaults to deny-all: an explicitly created gateway fails closed. (The implicit built-in "default" gateway — which exists only when no object named "default" does — is allow-all; see DefaultEgressGatewayName.)
listenersEgressListener[]Listeners declare interception capabilities by protocol layer. Routes attach to a specific listener by name via parentRef.sectionName. (required)

Response

  • 200: OK
  • 201: Created
  • 202: Accepted

Delete All EgressGateway

DELETE/apis/compute.apoxy.dev/v1alpha1/egressgateways

Delete collection of EgressGateway

Response

  • 200: OK

Get EgressGateway

GET/apis/compute.apoxy.dev/v1alpha1/egressgateways/{name}

Get the specified EgressGateway

Response

  • 200: OK

Replace EgressGateway

PUT/apis/compute.apoxy.dev/v1alpha1/egressgateways/{name}

Replace the specified EgressGateway

Request Body

Spec fields (EgressGatewaySpec):

FieldTypeDescription
defaultPolicystringDefaultPolicy applies to traffic that matches no attached route. Defaults to deny-all: an explicitly created gateway fails closed. (The implicit built-in "default" gateway — which exists only when no object named "default" does — is allow-all; see DefaultEgressGatewayName.)
listenersEgressListener[]Listeners declare interception capabilities by protocol layer. Routes attach to a specific listener by name via parentRef.sectionName. (required)

Response

  • 200: OK
  • 201: Created

Update EgressGateway

PATCH/apis/compute.apoxy.dev/v1alpha1/egressgateways/{name}

Partially update the specified EgressGateway

Response

  • 200: OK
  • 201: Created

Delete EgressGateway

DELETE/apis/compute.apoxy.dev/v1alpha1/egressgateways/{name}

delete an EgressGateway

Response

  • 200: OK
  • 202: Accepted

Schema Reference

EgressListener

FieldTypeDescription
namestringName identifies this listener within the gateway. (required)
portinteger (int32)Port constrains interception to a single destination port. If unset, all ports are intercepted at this protocol layer.
protocolstringProtocol selects the interception layer. (required)
tlsEgressListenerTLSTLS configures TLS handling. Only meaningful when protocol=TLS (Passthrough vs Terminate); forbidden for TCP/HTTP/HTTPS.

EgressListenerTLS

FieldTypeDescription
caCertRefSecretKeyRefCACertRef names the SecretStore key holding the PEM-encoded CA certificate + key bundle used for on-the-fly certificate minting. Required when mode=Terminate; forbidden for Passthrough.
modestringMode controls TLS handling. Passthrough: SNI-route only, no termination. Terminate: MITM decrypt for L7 inspection, re-encrypt to upstream.

SecretKeyRef

FieldTypeDescription
keystringKey within the store's values map. (required)
storestringStore names the SecretStore. (required)