Search skmtc
⌘K
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
auth
3
backup
2
custom_templates
9
docker
3
edge_agent
3
edge_groups
5
edge_jobs
11
edge_stacks
9
endpoint_groups
7
endpoints
19
gitops
14
helm
11
kubernetes
107
get
/kubernetes/{id}/applications
Get a list of applications across all namespaces in the cluster. If the nodeName is provided, it will return the applications running on that node.
get
/kubernetes/{id}/applications/count
Get Applications count
post
/kubernetes/{id}/cluster_role_bindings/delete
Delete cluster role bindings
post
/kubernetes/{id}/cluster_roles/delete
Delete cluster roles
get
/kubernetes/{id}/clusterrolebindings
Get a list of kubernetes cluster role bindings
get
/kubernetes/{id}/clusterroles
Get a list of kubernetes cluster roles
get
/kubernetes/{id}/configmaps
Get a list of ConfigMaps
get
/kubernetes/{id}/configmaps/count
Get ConfigMaps count
get
/kubernetes/{id}/cron_jobs
Get a list of kubernetes Cron Jobs
post
/kubernetes/{id}/cron_jobs/delete
Delete Cron Jobs
get
/kubernetes/{id}/dashboard
Get the dashboard summary data
get
/kubernetes/{id}/deployments
Get Kubernetes deployments
get
/kubernetes/{id}/describe
Get a description of a kubernetes resource
get
/kubernetes/{id}/events
Gets kubernetes events
get
/kubernetes/{id}/ingressclasses
Get Kubernetes ingress classes
get
/kubernetes/{id}/ingresscontrollers
Get a list of ingress controllers
put
/kubernetes/{id}/ingresscontrollers
Update (block/unblock) ingress controllers
get
/kubernetes/{id}/ingresses
Get kubernetes ingresses at the cluster level
get
/kubernetes/{id}/ingresses/count
Get Ingresses count
post
/kubernetes/{id}/ingresses/delete
Delete one or more Ingresses
get
/kubernetes/{id}/jobs
Get a list of kubernetes Jobs
post
/kubernetes/{id}/jobs/delete
Delete Jobs
post
/kubernetes/{id}/manifests/dry_run
Validate Kubernetes manifests without applying them
get
/kubernetes/{id}/max_resource_limits
Get max CPU and memory limits of all nodes within k8s cluster
get
/kubernetes/{id}/metrics/applications_resources
Get the total resource requests and limits of all applications
get
/kubernetes/{id}/metrics/nodes
Get a list of nodes with their live metrics
get
/kubernetes/{id}/metrics/nodes/{name}
Get live metrics for a node
get
/kubernetes/{id}/metrics/pods/{namespace}/{name}
Get live metrics for a pod
get
/kubernetes/{id}/metrics/pods/namespace/{namespace}
Get a list of pods with their live metrics
get
/kubernetes/{id}/namespaces
Get a list of namespaces
put
/kubernetes/{id}/namespaces
Update a namespace
post
/kubernetes/{id}/namespaces
Create a namespace
delete
/kubernetes/{id}/namespaces
Delete kubernetes namespaces
get
/kubernetes/{id}/namespaces/{namespace}
Get namespace details
put
/kubernetes/{id}/namespaces/{namespace}
Update a namespace
post
/kubernetes/{id}/namespaces/{namespace}/configmaps
Create a ConfigMap
get
/kubernetes/{id}/namespaces/{namespace}/configmaps/{configmap}
Get a ConfigMap
put
/kubernetes/{id}/namespaces/{namespace}/configmaps/{configmap}
Update a ConfigMap
delete
/kubernetes/{id}/namespaces/{namespace}/configmaps/{configmap}
Delete a ConfigMap
get
/kubernetes/{id}/namespaces/{namespace}/deployments
Get Kubernetes deployments within a namespace
post
/kubernetes/{id}/namespaces/{namespace}/deployments
Create a Kubernetes deployment
get
/kubernetes/{id}/namespaces/{namespace}/deployments/{name}
Get a Kubernetes deployment
put
/kubernetes/{id}/namespaces/{namespace}/deployments/{name}
Update a Kubernetes deployment
delete
/kubernetes/{id}/namespaces/{namespace}/deployments/{name}
Delete a Kubernetes deployment
patch
/kubernetes/{id}/namespaces/{namespace}/deployments/{name}
Annotate a Kubernetes deployment
post
/kubernetes/{id}/namespaces/{namespace}/deployments/{name}/rollback
Roll a Kubernetes deployment back
put
/kubernetes/{id}/namespaces/{namespace}/deployments/{name}/scale
Scale a Kubernetes deployment
get
/kubernetes/{id}/namespaces/{namespace}/events
Gets kubernetes events for namespace
get
/kubernetes/{id}/namespaces/{namespace}/ingresscontrollers
Get a list ingress controllers by namespace
put
/kubernetes/{id}/namespaces/{namespace}/ingresscontrollers
Update (block/unblock) ingress controllers by namespace
get
/kubernetes/{id}/namespaces/{namespace}/ingresses
Get a list of Ingresses
put
/kubernetes/{id}/namespaces/{namespace}/ingresses
Update an Ingress
post
/kubernetes/{id}/namespaces/{namespace}/ingresses
Create an Ingress
get
/kubernetes/{id}/namespaces/{namespace}/ingresses/{ingress}
Get an Ingress by name
get
/kubernetes/{id}/namespaces/{namespace}/persistent_volume_claims
Get PersistentVolumeClaims in a namespace
post
/kubernetes/{id}/namespaces/{namespace}/persistent_volume_claims
Create a PersistentVolumeClaim
get
/kubernetes/{id}/namespaces/{namespace}/persistent_volume_claims/{name}
Get a specific PersistentVolumeClaim
get
/kubernetes/{id}/namespaces/{namespace}/pods
Get Kubernetes pods within a namespace
delete
/kubernetes/{id}/namespaces/{namespace}/pods/{name}
Delete a kubernetes pod
get
/kubernetes/{id}/namespaces/{namespace}/pods/{name}/log
Get logs for a Kubernetes pod
post
/kubernetes/{id}/namespaces/{namespace}/pods/{name}/restart
Restart all containers in a Kubernetes pod
get
/kubernetes/{id}/namespaces/{namespace}/replicasets
Get Kubernetes replica sets within a namespace
get
/kubernetes/{id}/namespaces/{namespace}/resource_quotas
Get Kubernetes resource quotas within a namespace
post
/kubernetes/{id}/namespaces/{namespace}/secrets
Create a Secret
get
/kubernetes/{id}/namespaces/{namespace}/secrets/{secret}
Get a Secret
put
/kubernetes/{id}/namespaces/{namespace}/secrets/{secret}
Update a Secret
delete
/kubernetes/{id}/namespaces/{namespace}/secrets/{secret}
Delete a Secret
get
/kubernetes/{id}/namespaces/{namespace}/service_accounts/{name}
Get a kubernetes service account
put
/kubernetes/{id}/namespaces/{namespace}/service_accounts/{name}/image_pull_secrets
Update image pull secrets for a service account
get
/kubernetes/{id}/namespaces/{namespace}/services
Get a list of services for a given namespace
put
/kubernetes/{id}/namespaces/{namespace}/services
Update a service
post
/kubernetes/{id}/namespaces/{namespace}/services
Create a service
put
/kubernetes/{id}/namespaces/{namespace}/system
Toggle the system state for a namespace
get
/kubernetes/{id}/namespaces/{namespace}/volumes
Get Kubernetes volumes within a namespace in the given Portainer environment
get
/kubernetes/{id}/namespaces/count
Get the total number of kubernetes namespaces within the given Portainer environment.
get
/kubernetes/{id}/nodes
Get Kubernetes cluster nodes
post
/kubernetes/{id}/nodes/{name}/drain
Drain a Kubernetes node
get
/kubernetes/{id}/nodes_limits
Get CPU and memory limits of all nodes within k8s cluster
get
/kubernetes/{id}/persistent_volume_claims
Get all PersistentVolumeClaims
post
/kubernetes/{id}/persistent_volume_claims/delete
Delete PersistentVolumeClaims
put
/kubernetes/{id}/persistent_volume_claims/resize
Resize a PersistentVolumeClaim
get
/kubernetes/{id}/persistent_volumes
Get all PersistentVolumes in the cluster
get
/kubernetes/{id}/persistent_volumes/{name}
Get a specific PersistentVolume
post
/kubernetes/{id}/persistent_volumes/delete
Delete PersistentVolumes
put
/kubernetes/{id}/persistent_volumes/reclaim_policy
Update reclaim policy of a PersistentVolume
get
/kubernetes/{id}/pods
Get Kubernetes pods
get
/kubernetes/{id}/rbac_enabled
Check if RBAC is enabled
post
/kubernetes/{id}/role_bindings/delete
Delete role bindings
get
/kubernetes/{id}/rolebindings
Get a list of kubernetes role bindings
get
/kubernetes/{id}/roles
Get a list of kubernetes roles
post
/kubernetes/{id}/roles/delete
Delete roles
get
/kubernetes/{id}/secrets
Get a list of Secrets
get
/kubernetes/{id}/secrets/count
Get Secrets count
post
/kubernetes/{id}/service_accounts/delete
Delete service accounts
get
/kubernetes/{id}/serviceaccounts
Get a list of kubernetes service accounts
get
/kubernetes/{id}/services
Get a list of services
get
/kubernetes/{id}/services/count
Get services count
post
/kubernetes/{id}/services/delete
Delete services
get
/kubernetes/{id}/storage_classes
Get all StorageClasses
get
/kubernetes/{id}/storage_classes/{name}
Get a specific StorageClass
put
/kubernetes/{id}/storage_classes/{name}/default
Set a StorageClass as default
post
/kubernetes/{id}/storage_classes/delete
Delete StorageClasses
get
/kubernetes/{id}/version
Get the Kubernetes cluster version and Portainer-relevant capabilities
get
/kubernetes/{id}/volumes
Get Kubernetes volumes within the given Portainer environment
get
/kubernetes/{id}/volumes/{namespace}/{volume}
Get a Kubernetes volume within the given Portainer environment
get
/kubernetes/{id}/volumes/count
Get the total number of kubernetes volumes within the given Portainer environment.
get
/kubernetes/config
Generate a kubeconfig file
ldap
1
motd
1
registries
7
resource_controls
3
roles
1
settings
3
ssl
2
stacks
22
status
1
system
5
tags
3
team_memberships
5
teams
5
templates
2
upload
1
users
14
webhooks
5
websocket
4
kubernetes
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Annotate a Kubernetes deployment
patch
/kubernetes/{id}/namespaces/{namespace}/deployments/{name}
Aug 7, 2026
ec51a8194ac0
Revision changes
info
endpoint added