Backend

API Group: clrk.apoxy.dev/v1alpha1

Operations

List Backend

GET/apis/clrk.apoxy.dev/v1alpha1/backends

List Backend

Response

200: OK

List Backend

GET/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/backends

List Backend

Response

200: OK

Create Backend

POST/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/backends

Create a Backend

Request Body

Spec fields (BackendSpec):

Field	Type	Description
`bodyMutation`	BackendBodyMutation	BodyMutation configures request-body rewrites applied at RequestBody end-of-stream when this backend is selected.
`inferencePoolRef`	LocalObjectReference	InferencePoolRef references a Gateway API Inference Extension InferencePool in the same namespace. Required when Type=InferencePool. Accepted but not yet served by the data plane.
`modelRewrites`	ModelRewrite[]	ModelRewrites remap the request model ID before it reaches the upstream; the first entry whose From glob matches wins.
`schema`	BackendSchema	Schema declares the wire schema the upstream speaks. (required)
`type`	string	Type selects the destination kind. (required)
`upstream`	BackendUpstream	Upstream is the external host:port destination. Required when Type=Upstream.

Response

200: OK
201: Created
202: Accepted

Delete All Backend

DELETE/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/backends

Delete collection of Backend

Response

200: OK

Get Backend

GET/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/backends/{name}

Get the specified Backend

Response

200: OK

Replace Backend

PUT/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/backends/{name}

Replace the specified Backend

Request Body

Spec fields (BackendSpec):

Field	Type	Description
`bodyMutation`	BackendBodyMutation	BodyMutation configures request-body rewrites applied at RequestBody end-of-stream when this backend is selected.
`inferencePoolRef`	LocalObjectReference	InferencePoolRef references a Gateway API Inference Extension InferencePool in the same namespace. Required when Type=InferencePool. Accepted but not yet served by the data plane.
`modelRewrites`	ModelRewrite[]	ModelRewrites remap the request model ID before it reaches the upstream; the first entry whose From glob matches wins.
`schema`	BackendSchema	Schema declares the wire schema the upstream speaks. (required)
`type`	string	Type selects the destination kind. (required)
`upstream`	BackendUpstream	Upstream is the external host:port destination. Required when Type=Upstream.

Response

200: OK
201: Created

Update Backend

PATCH/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/backends/{name}

Partially update the specified Backend

Response

200: OK
201: Created

Delete Backend

DELETE/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/backends/{name}

Delete a Backend

Response

200: OK
202: Accepted

Schema Reference

BackendBodyMutation

Field	Type	Description
`ensureStreamUsage`	boolean	EnsureStreamUsage forces stream_options.include_usage=true on OpenAI-shaped streaming requests so streamed responses always emit terminal token usage. No-op for non-OpenAI schemas.

ModelRewrite

Field	Type	Description
`from`	string	From is a glob (path.Match shape) over the request's model ID. (required)
`to`	string	To is the literal model ID substituted on the wire. (required)

BackendSchema

Field	Type	Description
`name`	string	Name is the wire schema the upstream speaks. (required)

BackendUpstream

Field	Type	Description
`host`	string	Host is the upstream DNS name (or IP literal) the egress proxy dials. SNI and certificate SAN validation are derived from it. (required)
`port`	integer (int32)	Port is the upstream TCP port. Defaults to 443 (the egress data plane is TLS-terminating MITM, so backends are HTTPS).