Skip to main content

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.

OperationEndpointDescription
ListGET /deploymentsList all deployments, optional namespace filter
GetGET /deployments/{namespace}/{name}Get deployment details
CreatePOST /deploymentsCreate a new deployment
UpdatePATCH /deployments/{namespace}/{name}Patch deployment configuration
DeleteDELETE /deployments/{namespace}/{name}Delete a deployment
ScalePOST /deployments/{namespace}/{name}/scaleChange replica count
RestartPOST /deployments/{namespace}/{name}/restartRolling restart
PausePOST /deployments/{namespace}/{name}/pausePause rollout
ResumePOST /deployments/{namespace}/{name}/resumeResume paused rollout
RollbackPOST /deployments/{namespace}/{name}/rollbackRollback to previous revision
Update ImagePOST /deployments/{namespace}/{name}/update-imageChange container image
Apply YAMLPOST /deployments/{namespace}/{name}/applyApply YAML manifest
MetricsGET /deployments/{namespace}/{name}/metricsResource utilization
PodsGET /deployments/{namespace}/{name}/podsList deployment pods
RevisionsGET /deployments/{namespace}/{name}/revisionsView revision history

StatefulSets (/api/v1/workloads/statefulsets)

Manage stateful applications with stable identities and persistent storage.

OperationEndpointDescription
ListGET /statefulsetsList all StatefulSets
GetGET /statefulsets/{namespace}/{name}Get StatefulSet details
CreatePOST /statefulsetsCreate a new StatefulSet
UpdatePATCH /statefulsets/{namespace}/{name}Patch configuration
DeleteDELETE /statefulsets/{namespace}/{name}Delete a StatefulSet
ScalePOST /statefulsets/{namespace}/{name}/scaleScale replicas
Ordered ScalePOST /statefulsets/{namespace}/{name}/ordered-scaleScale with ordering
RestartPOST /statefulsets/{namespace}/{name}/restartRolling restart
Update ImagePOST /statefulsets/{namespace}/{name}/update-imageChange container image
PodsGET /statefulsets/{namespace}/{name}/podsList pods
Pod by IndexGET /statefulsets/{namespace}/{name}/pods/{index}Get specific pod
Pod OrderingGET /statefulsets/{namespace}/{name}/pod-orderingView pod sequence
Pod SequenceGET /statefulsets/{namespace}/{name}/pod-sequenceDetailed sequence info
Network IdentityGET /statefulsets/{namespace}/{name}/network-identityStable DNS names
Volume ClaimsGET /statefulsets/{namespace}/{name}/volume-claimsPVC bindings
Volume TemplatesGET /statefulsets/{namespace}/{name}/volume-claim-templatesPVC templates
Storage AllocationGET /statefulsets/{namespace}/{name}/storage-allocationStorage usage
Storage Class UsageGET /statefulsets/{namespace}/{name}/storage-class-usageStorageClass info
PV StatusGET /statefulsets/{namespace}/{name}/persistent-volume-statusPV health
VersionsGET /statefulsets/{namespace}/{name}/versionsVersion history
Version DetailGET /statefulsets/{namespace}/{name}/versions/{version}Specific version
Restore VersionPOST /statefulsets/{namespace}/{name}/versions/{version}/restoreRollback
YAMLGET /statefulsets/{namespace}/{name}/yamlYAML definition
SettingsGET /statefulsets/{namespace}/{name}/settingsConfiguration
OverviewGET /statefulsets/{namespace}/{name}/overviewSummary view
Identity PersistenceGET /statefulsets/{namespace}/{name}/identity-persistenceIdentity info
Update StrategyPATCH /statefulsets/{namespace}/{name}/update-strategyModify strategy
PartitionPATCH /statefulsets/{namespace}/{name}/partitionSet partition
Pod Mgmt PolicyPATCH /statefulsets/{namespace}/{name}/pod-management-policyChange policy
Service AssociationPATCH /statefulsets/{namespace}/{name}/service-associationLink service
ValidatePOST /statefulsets/validateValidate before create
QuotaGET /statefulsets/quota/{namespace}Namespace quotas

DaemonSets (/api/v1/workloads/daemonsets)

Manage pods that run on all or selected nodes.

OperationEndpointDescription
ListGET /daemonsetsList all DaemonSets
GetGET /daemonsets/{namespace}/{name}Get details
CreatePOST /daemonsetsCreate a DaemonSet
UpdatePATCH /daemonsets/{namespace}/{name}Patch configuration
DeleteDELETE /daemonsets/{namespace}/{name}Delete a DaemonSet
RestartPOST /daemonsets/{namespace}/{name}/restartRolling restart
Update ImagePOST /daemonsets/{namespace}/{name}/update-imageChange image
PodsGET /daemonsets/{namespace}/{name}/podsList pods
Node CoverageGET /daemonsets/{namespace}/{name}/node-coverageBasic coverage
Full CoverageGET /daemonsets/{namespace}/{name}/node-coverage-completeDetailed coverage
Update SchemaGET /daemonsets/update-schemaGet update options

Jobs (/api/v1/workloads/jobs)

Manage batch processing workloads.

OperationEndpointDescription
ListGET /jobsList all jobs
GetGET /jobs/{namespace}/{name}Get job details
CreatePOST /jobsCreate a job
UpdatePATCH /jobs/{namespace}/{name}Patch configuration
Delete (GET)DELETE /jobs/{namespace}/{name}Delete a job
Delete (POST)POST /jobs/{namespace}/{name}/deleteDelete (alternative)
RestartPOST /jobs/{namespace}/{name}/restartRe-run a job
SuspendPOST /jobs/{namespace}/{name}/suspendSuspend a job
ResumePOST /jobs/{namespace}/{name}/resumeResume a job
PodsGET /jobs/{namespace}/{name}/podsList job pods
EventsGET /jobs/{namespace}/{name}/eventsView events
LogsGET /jobs/{namespace}/{name}/logsView logs

CronJobs (/api/v1/workloads/cronjobs)

Manage scheduled recurring tasks.

OperationEndpointDescription
ListGET /cronjobsList all CronJobs
GetGET /cronjobs/{namespace}/{name}Get details
CreatePOST /cronjobsCreate a CronJob
UpdatePATCH /cronjobs/{namespace}/{name}Patch configuration
Delete (GET)DELETE /cronjobs/{namespace}/{name}Delete
Delete (POST)POST /cronjobs/{namespace}/{name}/deleteDelete (alternative)
TriggerPOST /cronjobs/{namespace}/{name}/triggerManual trigger
SuspendPOST /cronjobs/{namespace}/{name}/suspendPause schedule
ResumePOST /cronjobs/{namespace}/{name}/resumeResume schedule
JobsGET /cronjobs/{namespace}/{name}/jobsView child jobs
EventsGET /cronjobs/{namespace}/{name}/eventsView events

ReplicaSets (/api/v1/workloads/replicasets)

View and manage ReplicaSets (typically managed by Deployments).

OperationEndpointDescription
ListGET /replicasetsList all ReplicaSets
GetGET /replicasets/{namespace}/{name}Get details
ScalePOST /replicasets/{namespace}/{name}/scaleChange replicas
DeleteDELETE /replicasets/{namespace}/{name}Delete
PodsGET /replicasets/{namespace}/{name}/podsList pods
EventsGET /replicasets/{namespace}/{name}/eventsView events

Horizontal Pod Autoscalers (/api/v1/workloads/hpas)

Manage automatic scaling based on metrics.

OperationEndpointDescription
ListGET /hpasList all HPAs
GetGET /hpas/{namespace}/{name}Get details
CreatePOST /hpasCreate an HPA
UpdatePATCH /hpas/{namespace}/{name}Patch configuration
DeleteDELETE /hpas/{namespace}/{name}Delete
Metrics HistoryGET /hpas/{namespace}/{name}/metrics-historyHistorical metrics
Scaling EventsGET /hpas/{namespace}/{name}/scaling-eventsScaling decisions

Pods (/api/v1/pods)

OperationEndpointDescription
ListGET /List all pods
GetGET /{namespace}/{name}Get pod details
CreatePOST /createCreate a pod
Create from TemplatePOST /create-from-templateCreate from template
DeleteDELETE /{namespace}/{name}Delete a pod
RestartPOST /{namespace}/{name}/restartRestart a pod
Bulk DeletePOST /bulk-deleteDelete multiple pods
StatusGET /{namespace}/{name}/statusPod status
Metrics (all)GET /metricsAll pod metrics
Metrics (one)GET /{namespace}/{name}/metricsSingle pod metrics
Logs (GET)GET /{namespace}/{name}/logsView/stream logs
Logs (POST)POST /{namespace}/{name}/logsAdvanced log query
YAML (GET)GET /{namespace}/{name}/yamlView YAML
YAML (PUT)PUT /{namespace}/{name}/yamlEdit YAML
EventsGET /{namespace}/{name}/eventsPod events
ContainersGET /{namespace}/{name}/containersList containers
Container DetailGET /{namespace}/{name}/containers/{container}Container info
EnvironmentGET /{namespace}/{name}/environmentEnv variables
VolumesGET /{namespace}/{name}/volumesList volumes
Volume DetailGET /{namespace}/{name}/volumes/{volume}Volume info
Volume CapacityGET /{namespace}/{name}/volumes/capacityStorage usage
LabelsPATCH /{namespace}/{name}/labelsModify labels
AnnotationsPATCH /{namespace}/{name}/annotationsModify annotations
Shell InfoGET /{namespace}/{name}/shell-infoGet shell details
ShellPOST /{namespace}/{name}/shellOpen shell
ExecPOST /{namespace}/{name}/execExecute command
Exec LegacyPOST /{namespace}/{name}/exec/legacyLegacy exec
Port ForwardPOST /{namespace}/{name}/port-forwardCreate port-forward
Port Forward ListGET /port-forward/sessionsList sessions
Port Forward StopDELETE /port-forward/{session_id}Stop session
Files BrowseGET /{namespace}/{name}/filesBrowse filesystem
Files DownloadGET /{namespace}/{name}/files/downloadDownload file
Files UploadPOST /{namespace}/{name}/files/uploadUpload file
Files EditPUT /{namespace}/{name}/filesEdit file
Files DeleteDELETE /{namespace}/{name}/filesDelete file
Ephemeral AddPOST /{namespace}/{name}/ephemeralcontainersAdd debug container
Ephemeral ListGET /{namespace}/{name}/ephemeralcontainersList containers
Ephemeral DeleteDELETE /{namespace}/{name}/ephemeralcontainers/{name}Remove container
By OwnerGET /by-owner/{namespace}/{owner_name}Pods by owner
Status CountsGET /status-countsCount by status
TemplatesGET /templatesPod templates
Validate YAMLPOST /validate-yamlValidate pod YAML

Networking (/api/v1/networking)

Services

OperationEndpoint
ListGET /services
GetGET /services/{namespace}/{name}
CreatePOST /services
UpdatePATCH /services/{namespace}/{name}
DeleteDELETE /services/{namespace}/{name}
PatchPATCH /services/{namespace}/{name}/patch
EndpointsGET /services/{namespace}/{name}/endpoints
TrafficGET /services/{namespace}/{name}/traffic
RelatedGET /services/{namespace}/{name}/related
Test EndpointPOST /services/{namespace}/{name}/test-endpoint
Test AllPOST /services/{namespace}/{name}/test-all-endpoints
All EndpointsGET /endpoints
Service TypesGET /service-types
Session OptionsGET /session-affinity-options

Ingresses

OperationEndpoint
ListGET /ingresses
GetGET /ingresses/{namespace}/{name}
CreatePOST /ingresses
UpdatePATCH /ingresses/{namespace}/{name}
DeleteDELETE /ingresses/{namespace}/{name}
EditPATCH /ingresses/{namespace}/{name}/edit
PatchPATCH /ingresses/{namespace}/{name}/patch
RulesGET /ingresses/{namespace}/{name}/rules
Backend ServicesGET /ingresses/{namespace}/{name}/backend-services
StatusGET /ingresses/{namespace}/{name}/status
YAMLGET /ingresses/{namespace}/{name}/yaml
Ingress ClassesGET /ingress-classes

Network Policies

OperationEndpoint
ListGET /network-policies
GetGET /network-policies/{namespace}/{name}
CreatePOST /network-policies
UpdatePATCH /network-policies/{namespace}/{name}
DeleteDELETE /network-policies/{namespace}/{name}
Edit YAMLPUT /network-policies/{namespace}/{name}/yaml
ClonePOST /network-policies/{namespace}/{name}/clone
Affected PodsGET /network-policies/{namespace}/{name}/affected-pods
Test ConnectivityPOST /network-policies/test-connectivity
VisualizationGET /network-policies/visualization
TopologyGET /network-policies/topology
Impact AnalysisGET /network-policies/{namespace}/{name}/impact-analysis
Bulk ImpactPOST /network-policies/bulk-impact-analysis
Cluster ImpactGET /network-policies/cluster-impact-summary
Rule SuggestionsGET /network-policies/rule-builder/suggestions
Validate RulePOST /network-policies/validate-rule
TemplatesGET /network-policies/templates
PreviewPOST /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 TestPOST /network-policies/test-scenarios

Storage (/api/v1/storage)

ConfigMaps

OperationEndpoint
ListGET /configmaps
GetGET /configmaps/{namespace}/{name}
UsageGET /configmaps/{namespace}/{name}/usage
DeleteDELETE /configmaps/{namespace}/{name}

Secrets

OperationEndpoint
ListGET /secrets
GetGET /secrets/{namespace}/{name}
Data KeyGET /secrets/{namespace}/{name}/data/{key}
UsageGET /secrets/{namespace}/{name}/usage
DeleteDELETE /secrets/{namespace}/{name}

Persistent Volumes

OperationEndpoint
ListGET /persistent-volumes
GetGET /persistent-volumes/{name}
DeleteDELETE /persistent-volumes/{name}

Persistent Volume Claims

OperationEndpoint
ListGET /persistent-volume-claims
GetGET /persistent-volume-claims/{namespace}/{name}
UsageGET /persistent-volume-claims/{namespace}/{name}/usage
DeleteDELETE /persistent-volume-claims/{namespace}/{name}
ExpandPATCH /persistent-volume-claims/{namespace}/{name}/expand
EditPATCH /persistent-volume-claims/{namespace}/{name}
Validate ExpansionPOST /persistent-volume-claims/{namespace}/{name}/validate-expansion
Expansion HistoryGET /persistent-volume-claims/{namespace}/{name}/expansion-history
ValidatePOST /persistent-volume-claims/validate

Volume Snapshots

OperationEndpoint
Snapshot ClassesGET /volume-snapshot-classes
Snapshot Class DetailGET /volume-snapshot-classes/{name}
Create ClassPOST /volume-snapshot-classes
Delete ClassDELETE /volume-snapshot-classes/{name}
List SnapshotsGET /volume-snapshots
Snapshots by NSGET /volume-snapshots/{namespace}
Get SnapshotGET /volume-snapshots/{namespace}/{name}
Create SnapshotPOST /volume-snapshots
Delete SnapshotDELETE /volume-snapshots/{namespace}/{name}
RestorePOST /volume-snapshots/{namespace}/{name}/restore
Support CheckGET /snapshot-support
StatisticsGET /volume-snapshots/statistics

Cluster Management (/api/v1/cluster)

OperationEndpoint
Cluster HealthGET /health
CapabilitiesGET /capabilities
ResourcesGET /resources
ComponentsGET /components
NamespacesGET /namespaces
Admin NamespacesGET /admin/namespaces
Storage InfoGET /storage-info
Storage RecommendationsPOST /storage-recommendations
Service RecommendationsPOST /service-recommendations
Clusters ListGET /clusters
Current ClusterGET /clusters/current
Get ClusterGET /clusters/{id}
Switch ClusterPOST /clusters/{id}/switch
Cluster MetricsGET /clusters/{id}/metrics
Add ClusterPOST /clusters
Update ClusterPUT /clusters/{id}
Delete ClusterDELETE /clusters/{id}
Node ListGET /nodes
Node Metrics (all)GET /nodes/metrics
Node AdvancedGET /nodes/advanced
Node Advanced (POST)POST /nodes/advanced
Node DetailGET /nodes/{name}
Node MetricsGET /nodes/{name}/metrics
Node PodsGET /nodes/{name}/pods
Node YAMLGET /nodes/{name}/yaml
Node CordonPOST /nodes/{name}/cordon
Node UncordonPOST /nodes/{name}/uncordon
Node DrainPOST /nodes/{name}/drain
Node RebootPOST /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 TaintsPATCH /nodes/{name}/taints
Node DeleteDELETE /nodes/{name}
Node ConditionsGET /nodes/{name}/conditions
Node Conditions SummaryGET /nodes/{name}/conditions-summary
Conditions OverviewGET /nodes/conditions-overview
Node Health CheckGET /nodes/{name}/health-check

RBAC (/api/v1/rbac)

OperationEndpoint
List RolesGET /roles
Get RoleGET /roles/{name}
Create RolePOST /roles
Update RolePUT /roles/{name}
Delete RoleDELETE /roles/{name}
List BindingsGET /rolebindings
Get BindingGET /rolebindings/{name}
Create BindingPOST /rolebindings
Update BindingPUT /rolebindings/{name}
Delete BindingDELETE /rolebindings/{name}
Access ReviewPOST /access-review

Other Endpoints

Events (/api/v1/events)

OperationEndpoint
List AllGET /
RecentGET /recent
By ResourceGET /resource/{kind}/{name}
SummaryGET /summary
StatefulSet EventsGET /statefulset/{name}
StatefulSet SummaryGET /statefulset/{name}/summary
StatefulSet LifecycleGET /statefulset/{name}/lifecycle
StatefulSet PodsGET /statefulset/{name}/pods
StatefulSet StreamGET /statefulset/{name}/stream
StatefulSet VolumesGET /statefulset/{name}/volume-events
StatefulSet CorrelatedGET /statefulset/{name}/correlated
StatefulSet AnalyticsGET /statefulset/{name}/analytics
StatefulSet RealtimeGET /statefulset/{name}/stream-realtime

Capacity (/api/v1/capacity)

OperationEndpoint
AnalysisGET /capacity/analysis
RecommendationsGET /capacity/recommendations

Pod Disruption Budgets (/api/v1/pdb)

OperationEndpoint
ListGET /
GetGET /{namespace}/{name}
StatusGET /{namespace}/{name}/status
CreatePOST /{namespace}
UpdatePUT /{namespace}/{name}
DeleteDELETE /{namespace}/{name}
StatefulSet PDBGET /statefulset/{namespace}/{name}
Validate ConfigPOST /statefulset/{namespace}/validate-config

Health (/api/v1/health)

OperationEndpoint
Health CheckGET /health
Node ManagementGET /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.