API Reference

API Reference

Podex exposes a local HTTP REST and WebSocket API from the backend daemon (default port: 3457).

REST Endpoints

Cluster Statistics

GET /api/stats

Returns total node count, pod count, deployment count, service count, and namespace status.

Combined Resource Discovery

GET /api/resources?namespace=<ns>&show_system=<bool>

Returns all 9 resource types in one response: pods, deployments, services, nodes, configmaps, secrets, statefulsets, daemonsets, events.

Per-Type Resource Lists

GET /api/pods
GET /api/deployments
GET /api/services
GET /api/nodes
GET /api/configmaps
GET /api/secrets
GET /api/statefulsets
GET /api/daemonsets
GET /api/events

Resource Details

GET /api/{type}/{namespace}/{name}/details
GET /api/{type}/{namespace}/{name}/yaml
GET /api/node/{name}/yaml
GET /api/{type}/{namespace}/{name}/logs?tail=<n>&timestamps=<bool>
GET /api/{type}/{namespace}/{name}/events

Port Forwarding

POST /api/kube/port-forward
  Body: { kind, name, namespace, port, target_port? }
  Returns: { pid, port, target_port, is_docker }

DELETE /api/kube/port-forward/{pid}

Workload Operations

POST /api/deployments/{namespace}/{name}/restart
POST /api/deployments/{namespace}/{name}/scale?replicas=<n>
POST /api/kube/delete
  Body: { kind, name, namespace }
POST /api/apply-yaml

Kubeconfig Context Management

GET /api/kube/contexts
POST /api/kube/switch
  Body: { context }

AI Integration

POST /api/investigate
  Body: { namespace, pod_name, container_name }
  Returns: Diagnosis report with root cause, evidence, and fix

POST /api/learn
  Body: { concept }
  Returns: Explanation with analogies and gotchas

POST /api/pods/generate-command
  Body: { prompt }
  Returns: Generated kubectl command

WebSocket Endpoints

Resource Updates Stream

WS /api/ws/updates

Pushes real-time resource updates (pods, deployments, services, nodes, configmaps, secrets, statefulsets, daemonsets, events) to the frontend.

Interactive Terminal Shell

WS /api/ws/terminal/{namespace}/{pod_name}/{container_name}

Binds browser terminal inputs directly to /bin/sh or /bin/bash processes in the container.