Kubernetes Resources
The platform manages all standard Kubernetes resource types through a comprehensive REST API. This page documents every resource type and the operations available for each.
Workload Resources
Deployments (/api/v1/workloads/deployments)
Manage stateless application deployments with full lifecycle support.
| Operation | Endpoint | Description |
|---|---|---|
| List | GET /deployments | List all deployments, optional namespace filter |
| Get | GET /deployments/{namespace}/{name} | Get deployment details |
| Create | POST /deployments | Create a new deployment |
| Update | PATCH /deployments/{namespace}/{name} | Patch deployment configuration |
| Delete | DELETE /deployments/{namespace}/{name} | Delete a deployment |
| Scale | POST /deployments/{namespace}/{name}/scale | Change replica count |
| Restart | POST /deployments/{namespace}/{name}/restart | Rolling restart |
| Pause | POST /deployments/{namespace}/{name}/pause | Pause rollout |
| Resume | POST /deployments/{namespace}/{name}/resume | Resume paused rollout |
| Rollback | POST /deployments/{namespace}/{name}/rollback | Rollback to previous revision |
| Update Image | POST /deployments/{namespace}/{name}/update-image | Change container image |
| Apply YAML | POST /deployments/{namespace}/{name}/apply | Apply YAML manifest |
| Metrics | GET /deployments/{namespace}/{name}/metrics | Resource utilization |
| Pods | GET /deployments/{namespace}/{name}/pods | List deployment pods |
| Revisions | GET /deployments/{namespace}/{name}/revisions | View revision history |
StatefulSets (/api/v1/workloads/statefulsets)
Manage stateful applications with stable identities and persistent storage.
| Operation | Endpoint | Description |
|---|---|---|
| List | GET /statefulsets | List all StatefulSets |
| Get | GET /statefulsets/{namespace}/{name} | Get StatefulSet details |
| Create | POST /statefulsets | Create a new StatefulSet |
| Update | PATCH /statefulsets/{namespace}/{name} | Patch configuration |
| Delete | DELETE /statefulsets/{namespace}/{name} | Delete a StatefulSet |
| Scale | POST /statefulsets/{namespace}/{name}/scale | Scale replicas |
| Ordered Scale | POST /statefulsets/{namespace}/{name}/ordered-scale | Scale with ordering |
| Restart | POST /statefulsets/{namespace}/{name}/restart | Rolling restart |
| Update Image | POST /statefulsets/{namespace}/{name}/update-image | Change container image |
| Pods | GET /statefulsets/{namespace}/{name}/pods | List pods |
| Pod by Index | GET /statefulsets/{namespace}/{name}/pods/{index} | Get specific pod |
| Pod Ordering | GET /statefulsets/{namespace}/{name}/pod-ordering | View pod sequence |
| Pod Sequence | GET /statefulsets/{namespace}/{name}/pod-sequence | Detailed sequence info |
| Network Identity | GET /statefulsets/{namespace}/{name}/network-identity | Stable DNS names |
| Volume Claims | GET /statefulsets/{namespace}/{name}/volume-claims | PVC bindings |
| Volume Templates | GET /statefulsets/{namespace}/{name}/volume-claim-templates | PVC templates |
| Storage Allocation | GET /statefulsets/{namespace}/{name}/storage-allocation | Storage usage |
| Storage Class Usage | GET /statefulsets/{namespace}/{name}/storage-class-usage | StorageClass info |
| PV Status | GET /statefulsets/{namespace}/{name}/persistent-volume-status | PV health |
| Versions | GET /statefulsets/{namespace}/{name}/versions | Version history |
| Version Detail | GET /statefulsets/{namespace}/{name}/versions/{version} | Specific version |
| Restore Version | POST /statefulsets/{namespace}/{name}/versions/{version}/restore | Rollback |
| YAML | GET /statefulsets/{namespace}/{name}/yaml | YAML definition |
| Settings | GET /statefulsets/{namespace}/{name}/settings | Configuration |
| Overview | GET /statefulsets/{namespace}/{name}/overview | Summary view |
| Identity Persistence | GET /statefulsets/{namespace}/{name}/identity-persistence | Identity info |
| Update Strategy | PATCH /statefulsets/{namespace}/{name}/update-strategy | Modify strategy |
| Partition | PATCH /statefulsets/{namespace}/{name}/partition | Set partition |
| Pod Mgmt Policy | PATCH /statefulsets/{namespace}/{name}/pod-management-policy | Change policy |
| Service Association | PATCH /statefulsets/{namespace}/{name}/service-association | Link service |
| Validate | POST /statefulsets/validate | Validate before create |
| Quota | GET /statefulsets/quota/{namespace} | Namespace quotas |
DaemonSets (/api/v1/workloads/daemonsets)
Manage pods that run on all or selected nodes.
| Operation | Endpoint | Description |
|---|---|---|
| List | GET /daemonsets | List all DaemonSets |
| Get | GET /daemonsets/{namespace}/{name} | Get details |
| Create | POST /daemonsets | Create a DaemonSet |
| Update | PATCH /daemonsets/{namespace}/{name} | Patch configuration |
| Delete | DELETE /daemonsets/{namespace}/{name} | Delete a DaemonSet |
| Restart | POST /daemonsets/{namespace}/{name}/restart | Rolling restart |
| Update Image | POST /daemonsets/{namespace}/{name}/update-image | Change image |
| Pods | GET /daemonsets/{namespace}/{name}/pods | List pods |
| Node Coverage | GET /daemonsets/{namespace}/{name}/node-coverage | Basic coverage |
| Full Coverage | GET /daemonsets/{namespace}/{name}/node-coverage-complete | Detailed coverage |
| Update Schema | GET /daemonsets/update-schema | Get update options |
Jobs (/api/v1/workloads/jobs)
Manage batch processing workloads.
| Operation | Endpoint | Description |
|---|---|---|
| List | GET /jobs | List all jobs |
| Get | GET /jobs/{namespace}/{name} | Get job details |
| Create | POST /jobs | Create a job |
| Update | PATCH /jobs/{namespace}/{name} | Patch configuration |
| Delete (GET) | DELETE /jobs/{namespace}/{name} | Delete a job |
| Delete (POST) | POST /jobs/{namespace}/{name}/delete | Delete (alternative) |
| Restart | POST /jobs/{namespace}/{name}/restart | Re-run a job |
| Suspend | POST /jobs/{namespace}/{name}/suspend | Suspend a job |
| Resume | POST /jobs/{namespace}/{name}/resume | Resume a job |
| Pods | GET /jobs/{namespace}/{name}/pods | List job pods |
| Events | GET /jobs/{namespace}/{name}/events | View events |
| Logs | GET /jobs/{namespace}/{name}/logs | View logs |
CronJobs (/api/v1/workloads/cronjobs)
Manage scheduled recurring tasks.
| Operation | Endpoint | Description |
|---|---|---|
| List | GET /cronjobs | List all CronJobs |
| Get | GET /cronjobs/{namespace}/{name} | Get details |
| Create | POST /cronjobs | Create a CronJob |
| Update | PATCH /cronjobs/{namespace}/{name} | Patch configuration |
| Delete (GET) | DELETE /cronjobs/{namespace}/{name} | Delete |
| Delete (POST) | POST /cronjobs/{namespace}/{name}/delete | Delete (alternative) |
| Trigger | POST /cronjobs/{namespace}/{name}/trigger | Manual trigger |
| Suspend | POST /cronjobs/{namespace}/{name}/suspend | Pause schedule |
| Resume | POST /cronjobs/{namespace}/{name}/resume | Resume schedule |
| Jobs | GET /cronjobs/{namespace}/{name}/jobs | View child jobs |
| Events | GET /cronjobs/{namespace}/{name}/events | View events |
ReplicaSets (/api/v1/workloads/replicasets)
View and manage ReplicaSets (typically managed by Deployments).
| Operation | Endpoint | Description |
|---|---|---|
| List | GET /replicasets | List all ReplicaSets |
| Get | GET /replicasets/{namespace}/{name} | Get details |
| Scale | POST /replicasets/{namespace}/{name}/scale | Change replicas |
| Delete | DELETE /replicasets/{namespace}/{name} | Delete |
| Pods | GET /replicasets/{namespace}/{name}/pods | List pods |
| Events | GET /replicasets/{namespace}/{name}/events | View events |
Horizontal Pod Autoscalers (/api/v1/workloads/hpas)
Manage automatic scaling based on metrics.
| Operation | Endpoint | Description |
|---|---|---|
| List | GET /hpas | List all HPAs |
| Get | GET /hpas/{namespace}/{name} | Get details |
| Create | POST /hpas | Create an HPA |
| Update | PATCH /hpas/{namespace}/{name} | Patch configuration |
| Delete | DELETE /hpas/{namespace}/{name} | Delete |
| Metrics History | GET /hpas/{namespace}/{name}/metrics-history | Historical metrics |
| Scaling Events | GET /hpas/{namespace}/{name}/scaling-events | Scaling decisions |
Pods (/api/v1/pods)
| Operation | Endpoint | Description |
|---|---|---|
| List | GET / | List all pods |
| Get | GET /{namespace}/{name} | Get pod details |
| Create | POST /create | Create a pod |
| Create from Template | POST /create-from-template | Create from template |
| Delete | DELETE /{namespace}/{name} | Delete a pod |
| Restart | POST /{namespace}/{name}/restart | Restart a pod |
| Bulk Delete | POST /bulk-delete | Delete multiple pods |
| Status | GET /{namespace}/{name}/status | Pod status |
| Metrics (all) | GET /metrics | All pod metrics |
| Metrics (one) | GET /{namespace}/{name}/metrics | Single pod metrics |
| Logs (GET) | GET /{namespace}/{name}/logs | View/stream logs |
| Logs (POST) | POST /{namespace}/{name}/logs | Advanced log query |
| YAML (GET) | GET /{namespace}/{name}/yaml | View YAML |
| YAML (PUT) | PUT /{namespace}/{name}/yaml | Edit YAML |
| Events | GET /{namespace}/{name}/events | Pod events |
| Containers | GET /{namespace}/{name}/containers | List containers |
| Container Detail | GET /{namespace}/{name}/containers/{container} | Container info |
| Environment | GET /{namespace}/{name}/environment | Env variables |
| Volumes | GET /{namespace}/{name}/volumes | List volumes |
| Volume Detail | GET /{namespace}/{name}/volumes/{volume} | Volume info |
| Volume Capacity | GET /{namespace}/{name}/volumes/capacity | Storage usage |
| Labels | PATCH /{namespace}/{name}/labels | Modify labels |
| Annotations | PATCH /{namespace}/{name}/annotations | Modify annotations |
| Shell Info | GET /{namespace}/{name}/shell-info | Get shell details |
| Shell | POST /{namespace}/{name}/shell | Open shell |
| Exec | POST /{namespace}/{name}/exec | Execute command |
| Exec Legacy | POST /{namespace}/{name}/exec/legacy | Legacy exec |
| Port Forward | POST /{namespace}/{name}/port-forward | Create port-forward |
| Port Forward List | GET /port-forward/sessions | List sessions |
| Port Forward Stop | DELETE /port-forward/{session_id} | Stop session |
| Files Browse | GET /{namespace}/{name}/files | Browse filesystem |
| Files Download | GET /{namespace}/{name}/files/download | Download file |
| Files Upload | POST /{namespace}/{name}/files/upload | Upload file |
| Files Edit | PUT /{namespace}/{name}/files | Edit file |
| Files Delete | DELETE /{namespace}/{name}/files | Delete file |
| Ephemeral Add | POST /{namespace}/{name}/ephemeralcontainers | Add debug container |
| Ephemeral List | GET /{namespace}/{name}/ephemeralcontainers | List containers |
| Ephemeral Delete | DELETE /{namespace}/{name}/ephemeralcontainers/{name} | Remove container |
| By Owner | GET /by-owner/{namespace}/{owner_name} | Pods by owner |
| Status Counts | GET /status-counts | Count by status |
| Templates | GET /templates | Pod templates |
| Validate YAML | POST /validate-yaml | Validate pod YAML |
Networking (/api/v1/networking)
Services
| Operation | Endpoint |
|---|---|
| List | GET /services |
| Get | GET /services/{namespace}/{name} |
| Create | POST /services |
| Update | PATCH /services/{namespace}/{name} |
| Delete | DELETE /services/{namespace}/{name} |
| Patch | PATCH /services/{namespace}/{name}/patch |
| Endpoints | GET /services/{namespace}/{name}/endpoints |
| Traffic | GET /services/{namespace}/{name}/traffic |
| Related | GET /services/{namespace}/{name}/related |
| Test Endpoint | POST /services/{namespace}/{name}/test-endpoint |
| Test All | POST /services/{namespace}/{name}/test-all-endpoints |
| All Endpoints | GET /endpoints |
| Service Types | GET /service-types |
| Session Options | GET /session-affinity-options |
Ingresses
| Operation | Endpoint |
|---|---|
| List | GET /ingresses |
| Get | GET /ingresses/{namespace}/{name} |
| Create | POST /ingresses |
| Update | PATCH /ingresses/{namespace}/{name} |
| Delete | DELETE /ingresses/{namespace}/{name} |
| Edit | PATCH /ingresses/{namespace}/{name}/edit |
| Patch | PATCH /ingresses/{namespace}/{name}/patch |
| Rules | GET /ingresses/{namespace}/{name}/rules |
| Backend Services | GET /ingresses/{namespace}/{name}/backend-services |
| Status | GET /ingresses/{namespace}/{name}/status |
| YAML | GET /ingresses/{namespace}/{name}/yaml |
| Ingress Classes | GET /ingress-classes |
Network Policies
| Operation | Endpoint |
|---|---|
| List | GET /network-policies |
| Get | GET /network-policies/{namespace}/{name} |
| Create | POST /network-policies |
| Update | PATCH /network-policies/{namespace}/{name} |
| Delete | DELETE /network-policies/{namespace}/{name} |
| Edit YAML | PUT /network-policies/{namespace}/{name}/yaml |
| Clone | POST /network-policies/{namespace}/{name}/clone |
| Affected Pods | GET /network-policies/{namespace}/{name}/affected-pods |
| Test Connectivity | POST /network-policies/test-connectivity |
| Visualization | GET /network-policies/visualization |
| Topology | GET /network-policies/topology |
| Impact Analysis | GET /network-policies/{namespace}/{name}/impact-analysis |
| Bulk Impact | POST /network-policies/bulk-impact-analysis |
| Cluster Impact | GET /network-policies/cluster-impact-summary |
| Rule Suggestions | GET /network-policies/rule-builder/suggestions |
| Validate Rule | POST /network-policies/validate-rule |
| Templates | GET /network-policies/templates |
| Preview | POST /network-policies/preview |
| Test Scenarios (GET) | GET /network-policies/{namespace}/{name}/test-scenarios |
| Test Scenarios (POST) | POST /network-policies/{namespace}/{name}/test-scenarios |
| Test Scenarios (DELETE) | DELETE /network-policies/{namespace}/{name}/test-scenarios/{id} |
| Global Test | POST /network-policies/test-scenarios |
Storage (/api/v1/storage)
ConfigMaps
| Operation | Endpoint |
|---|---|
| List | GET /configmaps |
| Get | GET /configmaps/{namespace}/{name} |
| Usage | GET /configmaps/{namespace}/{name}/usage |
| Delete | DELETE /configmaps/{namespace}/{name} |
Secrets
| Operation | Endpoint |
|---|---|
| List | GET /secrets |
| Get | GET /secrets/{namespace}/{name} |
| Data Key | GET /secrets/{namespace}/{name}/data/{key} |
| Usage | GET /secrets/{namespace}/{name}/usage |
| Delete | DELETE /secrets/{namespace}/{name} |
Persistent Volumes
| Operation | Endpoint |
|---|---|
| List | GET /persistent-volumes |
| Get | GET /persistent-volumes/{name} |
| Delete | DELETE /persistent-volumes/{name} |
Persistent Volume Claims
| Operation | Endpoint |
|---|---|
| List | GET /persistent-volume-claims |
| Get | GET /persistent-volume-claims/{namespace}/{name} |
| Usage | GET /persistent-volume-claims/{namespace}/{name}/usage |
| Delete | DELETE /persistent-volume-claims/{namespace}/{name} |
| Expand | PATCH /persistent-volume-claims/{namespace}/{name}/expand |
| Edit | PATCH /persistent-volume-claims/{namespace}/{name} |
| Validate Expansion | POST /persistent-volume-claims/{namespace}/{name}/validate-expansion |
| Expansion History | GET /persistent-volume-claims/{namespace}/{name}/expansion-history |
| Validate | POST /persistent-volume-claims/validate |
Volume Snapshots
| Operation | Endpoint |
|---|---|
| Snapshot Classes | GET /volume-snapshot-classes |
| Snapshot Class Detail | GET /volume-snapshot-classes/{name} |
| Create Class | POST /volume-snapshot-classes |
| Delete Class | DELETE /volume-snapshot-classes/{name} |
| List Snapshots | GET /volume-snapshots |
| Snapshots by NS | GET /volume-snapshots/{namespace} |
| Get Snapshot | GET /volume-snapshots/{namespace}/{name} |
| Create Snapshot | POST /volume-snapshots |
| Delete Snapshot | DELETE /volume-snapshots/{namespace}/{name} |
| Restore | POST /volume-snapshots/{namespace}/{name}/restore |
| Support Check | GET /snapshot-support |
| Statistics | GET /volume-snapshots/statistics |
Cluster Management (/api/v1/cluster)
| Operation | Endpoint |
|---|---|
| Cluster Health | GET /health |
| Capabilities | GET /capabilities |
| Resources | GET /resources |
| Components | GET /components |
| Namespaces | GET /namespaces |
| Admin Namespaces | GET /admin/namespaces |
| Storage Info | GET /storage-info |
| Storage Recommendations | POST /storage-recommendations |
| Service Recommendations | POST /service-recommendations |
| Clusters List | GET /clusters |
| Current Cluster | GET /clusters/current |
| Get Cluster | GET /clusters/{id} |
| Switch Cluster | POST /clusters/{id}/switch |
| Cluster Metrics | GET /clusters/{id}/metrics |
| Add Cluster | POST /clusters |
| Update Cluster | PUT /clusters/{id} |
| Delete Cluster | DELETE /clusters/{id} |
| Node List | GET /nodes |
| Node Metrics (all) | GET /nodes/metrics |
| Node Advanced | GET /nodes/advanced |
| Node Advanced (POST) | POST /nodes/advanced |
| Node Detail | GET /nodes/{name} |
| Node Metrics | GET /nodes/{name}/metrics |
| Node Pods | GET /nodes/{name}/pods |
| Node YAML | GET /nodes/{name}/yaml |
| Node Cordon | POST /nodes/{name}/cordon |
| Node Uncordon | POST /nodes/{name}/uncordon |
| Node Drain | POST /nodes/{name}/drain |
| Node Reboot | POST /nodes/{name}/reboot |
| Node Labels (PATCH) | PATCH /nodes/{name}/labels |
| Node Labels (PUT) | PUT /nodes/{name}/labels |
| Node Annotations (PATCH) | PATCH /nodes/{name}/annotations |
| Node Annotations (PUT) | PUT /nodes/{name}/annotations |
| Node Taints | PATCH /nodes/{name}/taints |
| Node Delete | DELETE /nodes/{name} |
| Node Conditions | GET /nodes/{name}/conditions |
| Node Conditions Summary | GET /nodes/{name}/conditions-summary |
| Conditions Overview | GET /nodes/conditions-overview |
| Node Health Check | GET /nodes/{name}/health-check |
RBAC (/api/v1/rbac)
| Operation | Endpoint |
|---|---|
| List Roles | GET /roles |
| Get Role | GET /roles/{name} |
| Create Role | POST /roles |
| Update Role | PUT /roles/{name} |
| Delete Role | DELETE /roles/{name} |
| List Bindings | GET /rolebindings |
| Get Binding | GET /rolebindings/{name} |
| Create Binding | POST /rolebindings |
| Update Binding | PUT /rolebindings/{name} |
| Delete Binding | DELETE /rolebindings/{name} |
| Access Review | POST /access-review |
Other Endpoints
Events (/api/v1/events)
| Operation | Endpoint |
|---|---|
| List All | GET / |
| Recent | GET /recent |
| By Resource | GET /resource/{kind}/{name} |
| Summary | GET /summary |
| StatefulSet Events | GET /statefulset/{name} |
| StatefulSet Summary | GET /statefulset/{name}/summary |
| StatefulSet Lifecycle | GET /statefulset/{name}/lifecycle |
| StatefulSet Pods | GET /statefulset/{name}/pods |
| StatefulSet Stream | GET /statefulset/{name}/stream |
| StatefulSet Volumes | GET /statefulset/{name}/volume-events |
| StatefulSet Correlated | GET /statefulset/{name}/correlated |
| StatefulSet Analytics | GET /statefulset/{name}/analytics |
| StatefulSet Realtime | GET /statefulset/{name}/stream-realtime |
Capacity (/api/v1/capacity)
| Operation | Endpoint |
|---|---|
| Analysis | GET /capacity/analysis |
| Recommendations | GET /capacity/recommendations |
Pod Disruption Budgets (/api/v1/pdb)
| Operation | Endpoint |
|---|---|
| List | GET / |
| Get | GET /{namespace}/{name} |
| Status | GET /{namespace}/{name}/status |
| Create | POST /{namespace} |
| Update | PUT /{namespace}/{name} |
| Delete | DELETE /{namespace}/{name} |
| StatefulSet PDB | GET /statefulset/{namespace}/{name} |
| Validate Config | POST /statefulset/{namespace}/validate-config |
Health (/api/v1/health)
| Operation | Endpoint |
|---|---|
| Health Check | GET /health |
| Node Management | GET /health/node-management |
tip
All endpoints return responses in the StandardResponse format with success, message, and data fields. Failed operations return success: false with detailed error information.