Getting startedGuidesReferenceChangelog
Apoxy:// Docs / Reference / DaemonAgent

DaemonAgent

API reference for Daemon Agents (clrk.apoxy.dev/v1alpha1)

API Group: clrk.apoxy.dev/v1alpha1

Operations

List DaemonAgent

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

List DaemonAgent

Response

  • 200: OK

List DaemonAgent

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

List DaemonAgent

Response

  • 200: OK

Create DaemonAgent

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

Create a DaemonAgent

Request Body

Spec fields (DaemonAgentSpec):

FieldTypeDescription
egressRefsAgentEgressRef[]EgressRefs references EgressGateway objects for outbound access. Token budgets are configured on AIProviderRoute, not here.
maxLifetimeSecondsinteger (int32)MaxLifetimeSeconds caps how long the daemon can run before being terminated and optionally restarted. 0 = forever.
maxRestartsinteger (int32)MaxRestarts caps total restart attempts. 0 = unlimited.
resourcesExecutionResourcesResources defines per-execution CPU/memory limits.
restartPolicystringRestartPolicy controls what happens when the process exits.
templateAgentSandboxRevisionTemplateTemplate defines the sandbox revision template. Changes to this field trigger creation of a new AgentSandboxRevision. (required)
workerPoolRefstringWorkerPoolRef references a WorkerPool resource by name in the same namespace. (required)

Response

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

Delete All DaemonAgent

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

Delete collection of DaemonAgent

Response

  • 200: OK

Get DaemonAgent

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

Get the specified DaemonAgent

Response

  • 200: OK

Get DaemonAgent

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

read invocations of the specified DaemonAgent

Response

  • 200: OK

Get DaemonAgent

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

connect GET requests to logs of DaemonAgent

Response

  • 200: OK

Get DaemonAgent

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

connect GET requests to traces of DaemonAgent

Response

  • 200: OK

Create DaemonAgent

POST/apis/clrk.apoxy.dev/v1alpha1/namespaces/{namespace}/daemonagents/{name}/invocations

create invocations of a DaemonAgent

Request Body

Spec fields (InvocationSpec):

FieldTypeDescription
identityInvocationIdentityIdentity is the resolved identity asserted at ingress.
parentRefInvocationParentRefParentRef identifies the TaskAgent or DaemonAgent that owns this Invocation. Required. (required)
triggerInvocationTriggerTrigger describes how this invocation was initiated. (required)

Response

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

Replace DaemonAgent

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

Replace the specified DaemonAgent

Request Body

Spec fields (DaemonAgentSpec):

FieldTypeDescription
egressRefsAgentEgressRef[]EgressRefs references EgressGateway objects for outbound access. Token budgets are configured on AIProviderRoute, not here.
maxLifetimeSecondsinteger (int32)MaxLifetimeSeconds caps how long the daemon can run before being terminated and optionally restarted. 0 = forever.
maxRestartsinteger (int32)MaxRestarts caps total restart attempts. 0 = unlimited.
resourcesExecutionResourcesResources defines per-execution CPU/memory limits.
restartPolicystringRestartPolicy controls what happens when the process exits.
templateAgentSandboxRevisionTemplateTemplate defines the sandbox revision template. Changes to this field trigger creation of a new AgentSandboxRevision. (required)
workerPoolRefstringWorkerPoolRef references a WorkerPool resource by name in the same namespace. (required)

Response

  • 200: OK
  • 201: Created

Replace DaemonAgent

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

replace invocations of the specified DaemonAgent

Request Body

Spec fields (InvocationSpec):

FieldTypeDescription
identityInvocationIdentityIdentity is the resolved identity asserted at ingress.
parentRefInvocationParentRefParentRef identifies the TaskAgent or DaemonAgent that owns this Invocation. Required. (required)
triggerInvocationTriggerTrigger describes how this invocation was initiated. (required)

Response

  • 200: OK
  • 201: Created

Update DaemonAgent

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

Partially update the specified DaemonAgent

Response

  • 200: OK
  • 201: Created

Update DaemonAgent

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

partially update invocations of the specified DaemonAgent

Response

  • 200: OK
  • 201: Created

Delete DaemonAgent

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

Delete a DaemonAgent

Response

  • 200: OK
  • 202: Accepted

Schema Reference

AgentEgressRef

FieldTypeDescription
gatewayRefstringGatewayRef is the name of an EgressGateway in the same namespace. (required)

ExecutionResources

FieldTypeDescription
cpuQuantityCPU limit for a single execution, enforced via cgroup v2 cpu.max (CFS quota/period). Applies to the entire sandbox process tree. Default "1".
ephemeralStorageQuantityEphemeralStorage limit for a single execution. Currently advisory only — /tmp tmpfs sizing is controlled statically by the worker's OCI spec and per-sandbox cgroup enforcement is not yet wired through for this field.
memoryQuantityMemory limit for a single execution, enforced via cgroup v2 memory.max on the entire sandbox process tree. Budget ~32MB on top of the guest's working set for Sentry+gofer baseline overhead; guest pages mirrored into the Sentry's address space count against this limit too. Swap is pinned to zero so the OOM killer fires deterministically at memory.max. Default "512Mi".

AgentSandboxRevisionTemplate

FieldTypeDescription
specAgentSandboxRevisionSpecSpec is the desired state of the revision. (required)

AgentSandboxRevisionSpec

FieldTypeDescription
argsstring[]Args are arguments to the entrypoint.
commandstring[]Command overrides the image entrypoint.
envEnvVar[]Env is a list of environment variables to set in the sandbox.
imagestringImage is the OCI image reference for the agent. (required)