Getting startedGuidesReferenceChangelog
Apoxy:// Docs / Reference / EgressRoute

EgressRoute

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

API Group: compute.apoxy.dev/v1alpha1

Operations

List EgressRoute

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

List EgressRoute

Response

  • 200: OK

Create EgressRoute

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

create an EgressRoute

Request Body

Spec fields (EgressRouteSpec):

FieldTypeDescription
parentRefsParentReference[]ParentRefs attaches this route to EgressGateway listeners. Group and kind default to compute.apoxy.dev/EgressGateway and, when set, must be exactly that; namespace must be unset (all compute kinds are cluster-scoped). sectionName selects a single listener by name; absent attaches to every listener. (required)
rulesEgressRouteRule[](required)

Response

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

Delete All EgressRoute

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

Delete collection of EgressRoute

Response

  • 200: OK

Get EgressRoute

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

Get the specified EgressRoute

Response

  • 200: OK

Replace EgressRoute

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

Replace the specified EgressRoute

Request Body

Spec fields (EgressRouteSpec):

FieldTypeDescription
parentRefsParentReference[]ParentRefs attaches this route to EgressGateway listeners. Group and kind default to compute.apoxy.dev/EgressGateway and, when set, must be exactly that; namespace must be unset (all compute kinds are cluster-scoped). sectionName selects a single listener by name; absent attaches to every listener. (required)
rulesEgressRouteRule[](required)

Response

  • 200: OK
  • 201: Created

Update EgressRoute

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

Partially update the specified EgressRoute

Response

  • 200: OK
  • 201: Created

Delete EgressRoute

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

delete an EgressRoute

Response

  • 200: OK
  • 202: Accepted

Schema Reference

EgressRouteRule

FieldTypeDescription
matchesEgressRouteMatch[]Matches lists the destinations this rule admits. (required)

EgressRouteMatch

FieldTypeDescription
destinationCIDRsstring[]DestinationCIDRs matches by IP range. Single IPs as /32 or /128. IPv4 and IPv6 CIDRs are both honored.
destinationHostnamesstring[]DestinationHostnames matches by hostname. Exact (api.openai.com) and wildcard (*.openai.com) forms are accepted (gwapiv1.Hostname semantics — a wildcard matches exactly one prefix label). On TLS-terminated listeners the match runs against SNI.
portsEgressPortMatch[]Ports restricts to specific destination ports or port ranges.
protocolstringProtocol selects TCP or UDP. If unset, inherits from the parent listener. UDP is not yet supported.

EgressPortMatch

FieldTypeDescription
endPortinteger (int32)
portinteger (int32)Port matches a single destination port.
startPortinteger (int32)StartPort + EndPort define an inclusive range. Both must be set together. Mutually exclusive with Port.