Skip to main content

Overview

The Dashboard API provides comprehensive endpoints for managing and querying Kubernetes resources. All resource endpoints follow RESTful conventions and support common query parameters for filtering, sorting, and pagination.

Workload Resources

Pods

endpoint
List all Pods from all namespaces
endpoint
List Pods in a specific namespace
endpoint
Get detailed information about a specific Pod
endpoint
List containers in a Pod
endpoint
Get events related to a Pod
endpoint
List PersistentVolumeClaims used by a Pod

Deployments

endpoint
List all Deployments from all namespaces
endpoint
List Deployments in a specific namespace
endpoint
Get detailed information about a Deployment
endpoint
Get events for a Deployment
endpoint
Get old ReplicaSets for a Deployment
endpoint
Get the new ReplicaSet for a Deployment
endpoint
Pause a Deployment
endpoint
Resume a paused Deployment
endpoint
Rollout restart a Deployment
endpoint
Rollback a Deployment to a previous revision

ReplicaSets

endpoint
List all ReplicaSets from all namespaces
endpoint
List ReplicaSets in a namespace
endpoint
Get ReplicaSet details
endpoint
List Pods for a ReplicaSet
endpoint
List Services for a ReplicaSet
endpoint
Get events for a ReplicaSet

StatefulSets

endpoint
List all StatefulSets from all namespaces
endpoint
List StatefulSets in a namespace
endpoint
Get StatefulSet details
endpoint
List Pods for a StatefulSet
endpoint
Get events for a StatefulSet
endpoint
Rollout restart a StatefulSet

DaemonSets

endpoint
List all DaemonSets from all namespaces
endpoint
List DaemonSets in a namespace
endpoint
Get DaemonSet details
endpoint
List Pods for a DaemonSet
endpoint
List Services for a DaemonSet
endpoint
Get events for a DaemonSet
endpoint
Rollout restart a DaemonSet

Jobs

endpoint
List all Jobs from all namespaces
endpoint
List Jobs in a namespace
endpoint
Get Job details
endpoint
List Pods for a Job
endpoint
Get events for a Job

CronJobs

endpoint
List all CronJobs from all namespaces
endpoint
List CronJobs in a namespace
endpoint
Get CronJob details
endpoint
List Jobs for a CronJob
endpoint
Get events for a CronJob
endpoint
Manually trigger a CronJob

ReplicationControllers

endpoint
List all ReplicationControllers from all namespaces
endpoint
List ReplicationControllers in a namespace
endpoint
Get ReplicationController details
endpoint
Update replica count for a ReplicationController

Service Resources

Services

endpoint
List all Services from all namespaces
endpoint
List Services in a namespace
endpoint
Get Service details
endpoint
Get events for a Service
endpoint
List Pods behind a Service
endpoint
List Ingresses for a Service

Ingress

endpoint
List all Ingresses from all namespaces
endpoint
List Ingresses in a namespace
endpoint
Get Ingress details
endpoint
Get events for an Ingress

IngressClass

endpoint
List all IngressClasses
endpoint
Get IngressClass details

Configuration Resources

ConfigMaps

endpoint
List all ConfigMaps from all namespaces
endpoint
List ConfigMaps in a namespace
endpoint
Get ConfigMap details

Secrets

endpoint
List all Secrets from all namespaces
endpoint
List Secrets in a namespace
endpoint
Get Secret details
endpoint
Create an ImagePullSecret

Storage Resources

PersistentVolumes

endpoint
List all PersistentVolumes
endpoint
Get PersistentVolume details

PersistentVolumeClaims

endpoint
List all PersistentVolumeClaims
endpoint
List PersistentVolumeClaims in a namespace
endpoint
Get PersistentVolumeClaim details

StorageClass

endpoint
List all StorageClasses
endpoint
Get StorageClass details
endpoint
List PersistentVolumes for a StorageClass

Cluster Resources

Namespaces

endpoint
List all Namespaces
endpoint
Get Namespace details
endpoint
Create a new Namespace
endpoint
Get events for a Namespace

Nodes

endpoint
List all Nodes
endpoint
Get Node details
endpoint
Get events for a Node
endpoint
List Pods running on a Node
endpoint
Drain a Node

Events

endpoint
List all Events from all namespaces
endpoint
List Events in a namespace

RBAC Resources

Roles

endpoint
List all Roles from all namespaces
endpoint
List Roles in a namespace
endpoint
Get Role details

RoleBindings

endpoint
List all RoleBindings from all namespaces
endpoint
List RoleBindings in a namespace
endpoint
Get RoleBinding details

ClusterRoles

endpoint
List all ClusterRoles
endpoint
Get ClusterRole details

ClusterRoleBindings

endpoint
List all ClusterRoleBindings
endpoint
Get ClusterRoleBinding details

ServiceAccounts

endpoint
List all ServiceAccounts from all namespaces
endpoint
List ServiceAccounts in a namespace
endpoint
Get ServiceAccount details
endpoint
List Secrets for a ServiceAccount
endpoint
List ImagePullSecrets for a ServiceAccount

Policy Resources

NetworkPolicies

endpoint
List all NetworkPolicies from all namespaces
endpoint
List NetworkPolicies in a namespace
endpoint
Get NetworkPolicy details

PodDisruptionBudgets

endpoint
List all PodDisruptionBudgets
endpoint
List PodDisruptionBudgets in a namespace
endpoint
Get PodDisruptionBudget details

HorizontalPodAutoscalers

endpoint
List all HorizontalPodAutoscalers from all namespaces
endpoint
List HorizontalPodAutoscalers in a namespace
endpoint
Get HorizontalPodAutoscaler details
endpoint
List HorizontalPodAutoscalers for a specific resource

Custom Resources

CustomResourceDefinitions

endpoint
List all CustomResourceDefinitions
endpoint
Get CustomResourceDefinition details
endpoint
List custom resource objects
endpoint
Get custom resource object details
endpoint
Get events for a custom resource object

Generic Resource Operations

Raw Resource Access

endpoint
Get raw unstructured resource from a namespace
endpoint
Get raw unstructured non-namespaced resource
endpoint
Create or update a namespaced resource
endpoint
Create or update a non-namespaced resource
endpoint
Delete a namespaced resourceQuery Parameters:
  • deleteNow: Override graceful delete and enforce immediate deletion
  • propagation: Override default delete propagation policy
endpoint
Delete a non-namespaced resource

Scaling

endpoint
Get replica count for a namespaced resource
endpoint
Get replica count for a non-namespaced resource
endpoint
Scale a namespaced resourceQuery Parameters:
  • scaleBy: Desired number of replicas
endpoint
Scale a non-namespaced resource

Deployment Operations

App Deployment

endpoint
Deploy an application from deployment spec
endpoint
Deploy an application from YAML/JSON file
endpoint
Validate application name
endpoint
Validate image reference
endpoint
Validate service protocol
endpoint
Get available service protocols

Example: List Pods in a Namespace

Response