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

​
GET /api/v1/pod
endpoint
List all Pods from all namespaces
​
GET /api/v1/pod/{namespace}
endpoint
List Pods in a specific namespace
​
GET /api/v1/pod/{namespace}/{pod}
endpoint
Get detailed information about a specific Pod
​
GET /api/v1/pod/{namespace}/{pod}/container
endpoint
List containers in a Pod
​
GET /api/v1/pod/{namespace}/{pod}/event
endpoint
Get events related to a Pod
​
GET /api/v1/pod/{namespace}/{pod}/persistentvolumeclaim
endpoint
List PersistentVolumeClaims used by a Pod

​
Deployments

​
GET /api/v1/deployment
endpoint
List all Deployments from all namespaces
​
GET /api/v1/deployment/{namespace}
endpoint
List Deployments in a specific namespace
​
GET /api/v1/deployment/{namespace}/{deployment}
endpoint
Get detailed information about a Deployment
​
GET /api/v1/deployment/{namespace}/{deployment}/event
endpoint
Get events for a Deployment
​
GET /api/v1/deployment/{namespace}/{deployment}/oldreplicaset
endpoint
Get old ReplicaSets for a Deployment
​
GET /api/v1/deployment/{namespace}/{deployment}/newreplicaset
endpoint
Get the new ReplicaSet for a Deployment
​
PUT /api/v1/deployment/{namespace}/{deployment}/pause
endpoint
Pause a Deployment
​
PUT /api/v1/deployment/{namespace}/{deployment}/resume
endpoint
Resume a paused Deployment
​
PUT /api/v1/deployment/{namespace}/{deployment}/restart
endpoint
Rollout restart a Deployment
​
PUT /api/v1/deployment/{namespace}/{deployment}/rollback
endpoint
Rollback a Deployment to a previous revision

​
ReplicaSets

​
GET /api/v1/replicaset
endpoint
List all ReplicaSets from all namespaces
​
GET /api/v1/replicaset/{namespace}
endpoint
List ReplicaSets in a namespace
​
GET /api/v1/replicaset/{namespace}/{replicaSet}
endpoint
Get ReplicaSet details
​
GET /api/v1/replicaset/{namespace}/{replicaSet}/pod
endpoint
List Pods for a ReplicaSet
​
GET /api/v1/replicaset/{namespace}/{replicaSet}/service
endpoint
List Services for a ReplicaSet
​
GET /api/v1/replicaset/{namespace}/{replicaSet}/event
endpoint
Get events for a ReplicaSet

​
StatefulSets

​
GET /api/v1/statefulset
endpoint
List all StatefulSets from all namespaces
​
GET /api/v1/statefulset/{namespace}
endpoint
List StatefulSets in a namespace
​
GET /api/v1/statefulset/{namespace}/{statefulset}
endpoint
Get StatefulSet details
​
GET /api/v1/statefulset/{namespace}/{statefulset}/pod
endpoint
List Pods for a StatefulSet
​
GET /api/v1/statefulset/{namespace}/{statefulset}/event
endpoint
Get events for a StatefulSet
​
PUT /api/v1/statefulset/{namespace}/{statefulset}/restart
endpoint
Rollout restart a StatefulSet

​
DaemonSets

​
GET /api/v1/daemonset
endpoint
List all DaemonSets from all namespaces
​
GET /api/v1/daemonset/{namespace}
endpoint
List DaemonSets in a namespace
​
GET /api/v1/daemonset/{namespace}/{daemonSet}
endpoint
Get DaemonSet details
​
GET /api/v1/daemonset/{namespace}/{daemonSet}/pod
endpoint
List Pods for a DaemonSet
​
GET /api/v1/daemonset/{namespace}/{daemonSet}/service
endpoint
List Services for a DaemonSet
​
GET /api/v1/daemonset/{namespace}/{daemonSet}/event
endpoint
Get events for a DaemonSet
​
PUT /api/v1/daemonset/{namespace}/{daemonSet}/restart
endpoint
Rollout restart a DaemonSet

​
Jobs

​
GET /api/v1/job
endpoint
List all Jobs from all namespaces
​
GET /api/v1/job/{namespace}
endpoint
List Jobs in a namespace
​
GET /api/v1/job/{namespace}/{name}
endpoint
Get Job details
​
GET /api/v1/job/{namespace}/{name}/pod
endpoint
List Pods for a Job
​
GET /api/v1/job/{namespace}/{name}/event
endpoint
Get events for a Job

​
CronJobs

​
GET /api/v1/cronjob
endpoint
List all CronJobs from all namespaces
​
GET /api/v1/cronjob/{namespace}
endpoint
List CronJobs in a namespace
​
GET /api/v1/cronjob/{namespace}/{name}
endpoint
Get CronJob details
​
GET /api/v1/cronjob/{namespace}/{name}/job
endpoint
List Jobs for a CronJob
​
GET /api/v1/cronjob/{namespace}/{name}/event
endpoint
Get events for a CronJob
​
PUT /api/v1/cronjob/{namespace}/{name}/trigger
endpoint
Manually trigger a CronJob

​
ReplicationControllers

​
GET /api/v1/replicationcontroller
endpoint
List all ReplicationControllers from all namespaces
​
GET /api/v1/replicationcontroller/{namespace}
endpoint
List ReplicationControllers in a namespace
​
GET /api/v1/replicationcontroller/{namespace}/{replicationController}
endpoint
Get ReplicationController details
​
POST /api/v1/replicationcontroller/{namespace}/{replicationController}/update/pod
endpoint
Update replica count for a ReplicationController

​
Service Resources

​
Services

​
GET /api/v1/service
endpoint
List all Services from all namespaces
​
GET /api/v1/service/{namespace}
endpoint
List Services in a namespace
​
GET /api/v1/service/{namespace}/{service}
endpoint
Get Service details
​
GET /api/v1/service/{namespace}/{service}/event
endpoint
Get events for a Service
​
GET /api/v1/service/{namespace}/{service}/pod
endpoint
List Pods behind a Service
​
GET /api/v1/service/{namespace}/{service}/ingress
endpoint
List Ingresses for a Service

​
Ingress

​
GET /api/v1/ingress
endpoint
List all Ingresses from all namespaces
​
GET /api/v1/ingress/{namespace}
endpoint
List Ingresses in a namespace
​
GET /api/v1/ingress/{namespace}/{name}
endpoint
Get Ingress details
​
GET /api/v1/ingress/{namespace}/{ingress}/event
endpoint
Get events for an Ingress

​
IngressClass

​
GET /api/v1/ingressclass
endpoint
List all IngressClasses
​
GET /api/v1/ingressclass/{ingressclass}
endpoint
Get IngressClass details

​
Configuration Resources

​
ConfigMaps

​
GET /api/v1/configmap
endpoint
List all ConfigMaps from all namespaces
​
GET /api/v1/configmap/{namespace}
endpoint
List ConfigMaps in a namespace
​
GET /api/v1/configmap/{namespace}/{configmap}
endpoint
Get ConfigMap details

​
Secrets

​
GET /api/v1/secret
endpoint
List all Secrets from all namespaces
​
GET /api/v1/secret/{namespace}
endpoint
List Secrets in a namespace
​
GET /api/v1/secret/{namespace}/{name}
endpoint
Get Secret details
​
POST /api/v1/secret
endpoint
Create an ImagePullSecret

​
Storage Resources

​
PersistentVolumes

​
GET /api/v1/persistentvolume
endpoint
List all PersistentVolumes
​
GET /api/v1/persistentvolume/{persistentvolume}
endpoint
Get PersistentVolume details

​
PersistentVolumeClaims

​
GET /api/v1/persistentvolumeclaim
endpoint
List all PersistentVolumeClaims
​
GET /api/v1/persistentvolumeclaim/{namespace}
endpoint
List PersistentVolumeClaims in a namespace
​
GET /api/v1/persistentvolumeclaim/{namespace}/{name}
endpoint
Get PersistentVolumeClaim details

​
StorageClass

​
GET /api/v1/storageclass
endpoint
List all StorageClasses
​
GET /api/v1/storageclass/{storageclass}
endpoint
Get StorageClass details
​
GET /api/v1/storageclass/{storageclass}/persistentvolume
endpoint
List PersistentVolumes for a StorageClass

​
Cluster Resources

​
Namespaces

​
GET /api/v1/namespace
endpoint
List all Namespaces
​
GET /api/v1/namespace/{name}
endpoint
Get Namespace details
​
POST /api/v1/namespace
endpoint
Create a new Namespace
​
GET /api/v1/namespace/{name}/event
endpoint
Get events for a Namespace

​
Nodes

​
GET /api/v1/node
endpoint
List all Nodes
​
GET /api/v1/node/{name}
endpoint
Get Node details
​
GET /api/v1/node/{name}/event
endpoint
Get events for a Node
​
GET /api/v1/node/{name}/pod
endpoint
List Pods running on a Node
​
PUT /api/v1/node/{name}/drain
endpoint
Drain a Node

​
Events

​
GET /api/v1/event
endpoint
List all Events from all namespaces
​
GET /api/v1/event/{namespace}
endpoint
List Events in a namespace

​
RBAC Resources

​
Roles

​
GET /api/v1/role
endpoint
List all Roles from all namespaces
​
GET /api/v1/role/{namespace}
endpoint
List Roles in a namespace
​
GET /api/v1/role/{namespace}/{name}
endpoint
Get Role details

​
RoleBindings

​
GET /api/v1/rolebinding
endpoint
List all RoleBindings from all namespaces
​
GET /api/v1/rolebinding/{namespace}
endpoint
List RoleBindings in a namespace
​
GET /api/v1/rolebinding/{namespace}/{name}
endpoint
Get RoleBinding details

​
ClusterRoles

​
GET /api/v1/clusterrole
endpoint
List all ClusterRoles
​
GET /api/v1/clusterrole/{name}
endpoint
Get ClusterRole details

​
ClusterRoleBindings

​
GET /api/v1/clusterrolebinding
endpoint
List all ClusterRoleBindings
​
GET /api/v1/clusterrolebinding/{name}
endpoint
Get ClusterRoleBinding details

​
ServiceAccounts

​
GET /api/v1/serviceaccount
endpoint
List all ServiceAccounts from all namespaces
​
GET /api/v1/serviceaccount/{namespace}
endpoint
List ServiceAccounts in a namespace
​
GET /api/v1/serviceaccount/{namespace}/{serviceaccount}
endpoint
Get ServiceAccount details
​
GET /api/v1/serviceaccount/{namespace}/{serviceaccount}/secret
endpoint
List Secrets for a ServiceAccount
​
GET /api/v1/serviceaccount/{namespace}/{serviceaccount}/imagepullsecret
endpoint
List ImagePullSecrets for a ServiceAccount

​
Policy Resources

​
NetworkPolicies

​
GET /api/v1/networkpolicy
endpoint
List all NetworkPolicies from all namespaces
​
GET /api/v1/networkpolicy/{namespace}
endpoint
List NetworkPolicies in a namespace
​
GET /api/v1/networkpolicy/{namespace}/{networkpolicy}
endpoint
Get NetworkPolicy details

​
PodDisruptionBudgets

​
GET /api/v1/poddisruptionbudget
endpoint
List all PodDisruptionBudgets
​
GET /api/v1/poddisruptionbudget/{namespace}
endpoint
List PodDisruptionBudgets in a namespace
​
GET /api/v1/poddisruptionbudget/{namespace}/{name}
endpoint
Get PodDisruptionBudget details

​
HorizontalPodAutoscalers

​
GET /api/v1/horizontalpodautoscaler
endpoint
List all HorizontalPodAutoscalers from all namespaces
​
GET /api/v1/horizontalpodautoscaler/{namespace}
endpoint
List HorizontalPodAutoscalers in a namespace
​
GET /api/v1/horizontalpodautoscaler/{namespace}/{horizontalpodautoscaler}
endpoint
Get HorizontalPodAutoscaler details
​
GET /api/v1/{kind}/{namespace}/{name}/horizontalpodautoscaler
endpoint
List HorizontalPodAutoscalers for a specific resource

​
Custom Resources

​
CustomResourceDefinitions

​
GET /api/v1/crd
endpoint
List all CustomResourceDefinitions
​
GET /api/v1/crd/{crd}
endpoint
Get CustomResourceDefinition details
​
GET /api/v1/crd/{namespace}/{crd}/object
endpoint
List custom resource objects
​
GET /api/v1/crd/{namespace}/{crd}/{object}
endpoint
Get custom resource object details
​
GET /api/v1/crd/{namespace}/{crd}/{object}/event
endpoint
Get events for a custom resource object

​
Generic Resource Operations

​
Raw Resource Access

​
GET /api/v1/_raw/{kind}/namespace/{namespace}/name/{name}
endpoint
Get raw unstructured resource from a namespace
​
GET /api/v1/_raw/{kind}/name/{name}
endpoint
Get raw unstructured non-namespaced resource
​
PUT /api/v1/_raw/{kind}/namespace/{namespace}/name/{name}
endpoint
Create or update a namespaced resource
​
PUT /api/v1/_raw/{kind}/name/{name}
endpoint
Create or update a non-namespaced resource
​
DELETE /api/v1/_raw/{kind}/namespace/{namespace}/name/{name}
endpoint
Delete a namespaced resourceQuery Parameters:
  • deleteNow: Override graceful delete and enforce immediate deletion
  • propagation: Override default delete propagation policy
​
DELETE /api/v1/_raw/{kind}/name/{name}
endpoint
Delete a non-namespaced resource

​
Scaling

​
GET /api/v1/scale/{kind}/{namespace}/{name}
endpoint
Get replica count for a namespaced resource
​
GET /api/v1/scale/{kind}/{name}
endpoint
Get replica count for a non-namespaced resource
​
PUT /api/v1/scale/{kind}/{namespace}/{name}
endpoint
Scale a namespaced resourceQuery Parameters:
  • scaleBy: Desired number of replicas
​
PUT /api/v1/scale/{kind}/{name}
endpoint
Scale a non-namespaced resource

​
Deployment Operations

​
App Deployment

​
POST /api/v1/appdeployment
endpoint
Deploy an application from deployment spec
​
POST /api/v1/appdeploymentfromfile
endpoint
Deploy an application from YAML/JSON file
​
POST /api/v1/appdeployment/validate/name
endpoint
Validate application name
​
POST /api/v1/appdeployment/validate/imagereference
endpoint
Validate image reference
​
POST /api/v1/appdeployment/validate/protocol
endpoint
Validate service protocol
​
GET /api/v1/appdeployment/protocols
endpoint
Get available service protocols

​
Example: List Pods in a Namespace

curl -X GET \
  'https://dashboard.example.com/api/v1/pod/default?itemsPerPage=10&page=1' \
  -H 'Authorization: Bearer <token>' \
  -H 'Accept: application/json'

​
Response

{
  "listMeta": {
    "totalItems": 25
  },
  "items": [
    {
      "objectMeta": {
        "name": "nginx-deployment-66b6c48dd5-8xpkr",
        "namespace": "default",
        "creationTimestamp": "2026-03-01T10:30:00Z"
      },
      "typeMeta": {
        "kind": "Pod"
      },
      "status": "Running",
      "restartCount": 0
    }
  ]
}

Build docs developers (and LLMs) love

Get started for freeTalk to us