⌘K
DocsSign in
  • Docs
  • History
  • Schema
  • Generate
auth3
backup2
custom_templates9
docker3
edge_agent3
edge_groups5
edge_jobs11
edge_stacks9
endpoint_groups7
endpoints19
gitops14
helm11
kubernetes107
  • get/kubernetes/{id}/applicationsGet 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/countGet Applications count
  • post/kubernetes/{id}/cluster_role_bindings/deleteDelete cluster role bindings
  • post/kubernetes/{id}/cluster_roles/deleteDelete cluster roles
  • get/kubernetes/{id}/clusterrolebindingsGet a list of kubernetes cluster role bindings
  • get/kubernetes/{id}/clusterrolesGet a list of kubernetes cluster roles
  • get/kubernetes/{id}/configmapsGet a list of ConfigMaps
  • get/kubernetes/{id}/configmaps/countGet ConfigMaps count
  • get/kubernetes/{id}/cron_jobsGet a list of kubernetes Cron Jobs
  • post/kubernetes/{id}/cron_jobs/deleteDelete Cron Jobs
  • get/kubernetes/{id}/dashboardGet the dashboard summary data
  • get/kubernetes/{id}/deploymentsGet Kubernetes deployments
  • get/kubernetes/{id}/describeGet a description of a kubernetes resource
  • get/kubernetes/{id}/eventsGets kubernetes events
  • get/kubernetes/{id}/ingressclassesGet Kubernetes ingress classes
  • get/kubernetes/{id}/ingresscontrollersGet a list of ingress controllers
  • put/kubernetes/{id}/ingresscontrollersUpdate (block/unblock) ingress controllers
  • get/kubernetes/{id}/ingressesGet kubernetes ingresses at the cluster level
  • get/kubernetes/{id}/ingresses/countGet Ingresses count
  • post/kubernetes/{id}/ingresses/deleteDelete one or more Ingresses
  • get/kubernetes/{id}/jobsGet a list of kubernetes Jobs
  • post/kubernetes/{id}/jobs/deleteDelete Jobs
  • post/kubernetes/{id}/manifests/dry_runValidate Kubernetes manifests without applying them
  • get/kubernetes/{id}/max_resource_limitsGet max CPU and memory limits of all nodes within k8s cluster
  • get/kubernetes/{id}/metrics/applications_resourcesGet the total resource requests and limits of all applications
  • get/kubernetes/{id}/metrics/nodesGet 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}/namespacesGet a list of namespaces
  • put/kubernetes/{id}/namespacesUpdate a namespace
  • post/kubernetes/{id}/namespacesCreate a namespace
  • delete/kubernetes/{id}/namespacesDelete kubernetes namespaces
  • get/kubernetes/{id}/namespaces/{namespace}Get namespace details
  • put/kubernetes/{id}/namespaces/{namespace}Update a namespace
  • post/kubernetes/{id}/namespaces/{namespace}/configmapsCreate 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}/deploymentsGet Kubernetes deployments within a namespace
  • post/kubernetes/{id}/namespaces/{namespace}/deploymentsCreate 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}/rollbackRoll a Kubernetes deployment back
  • put/kubernetes/{id}/namespaces/{namespace}/deployments/{name}/scaleScale a Kubernetes deployment
  • get/kubernetes/{id}/namespaces/{namespace}/eventsGets kubernetes events for namespace
  • get/kubernetes/{id}/namespaces/{namespace}/ingresscontrollersGet a list ingress controllers by namespace
  • put/kubernetes/{id}/namespaces/{namespace}/ingresscontrollersUpdate (block/unblock) ingress controllers by namespace
  • get/kubernetes/{id}/namespaces/{namespace}/ingressesGet a list of Ingresses
  • put/kubernetes/{id}/namespaces/{namespace}/ingressesUpdate an Ingress
  • post/kubernetes/{id}/namespaces/{namespace}/ingressesCreate an Ingress
  • get/kubernetes/{id}/namespaces/{namespace}/ingresses/{ingress}Get an Ingress by name
  • get/kubernetes/{id}/namespaces/{namespace}/persistent_volume_claimsGet PersistentVolumeClaims in a namespace
  • post/kubernetes/{id}/namespaces/{namespace}/persistent_volume_claimsCreate a PersistentVolumeClaim
  • get/kubernetes/{id}/namespaces/{namespace}/persistent_volume_claims/{name}Get a specific PersistentVolumeClaim
  • get/kubernetes/{id}/namespaces/{namespace}/podsGet Kubernetes pods within a namespace
  • delete/kubernetes/{id}/namespaces/{namespace}/pods/{name}Delete a kubernetes pod
  • get/kubernetes/{id}/namespaces/{namespace}/pods/{name}/logGet logs for a Kubernetes pod
  • post/kubernetes/{id}/namespaces/{namespace}/pods/{name}/restartRestart all containers in a Kubernetes pod
  • get/kubernetes/{id}/namespaces/{namespace}/replicasetsGet Kubernetes replica sets within a namespace
  • get/kubernetes/{id}/namespaces/{namespace}/resource_quotasGet Kubernetes resource quotas within a namespace
  • post/kubernetes/{id}/namespaces/{namespace}/secretsCreate 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_secretsUpdate image pull secrets for a service account
  • get/kubernetes/{id}/namespaces/{namespace}/servicesGet a list of services for a given namespace
  • put/kubernetes/{id}/namespaces/{namespace}/servicesUpdate a service
  • post/kubernetes/{id}/namespaces/{namespace}/servicesCreate a service
  • put/kubernetes/{id}/namespaces/{namespace}/systemToggle the system state for a namespace
  • get/kubernetes/{id}/namespaces/{namespace}/volumesGet Kubernetes volumes within a namespace in the given Portainer environment
  • get/kubernetes/{id}/namespaces/countGet the total number of kubernetes namespaces within the given Portainer environment.
  • get/kubernetes/{id}/nodesGet Kubernetes cluster nodes
  • post/kubernetes/{id}/nodes/{name}/drainDrain a Kubernetes node
  • get/kubernetes/{id}/nodes_limitsGet CPU and memory limits of all nodes within k8s cluster
  • get/kubernetes/{id}/persistent_volume_claimsGet all PersistentVolumeClaims
  • post/kubernetes/{id}/persistent_volume_claims/deleteDelete PersistentVolumeClaims
  • put/kubernetes/{id}/persistent_volume_claims/resizeResize a PersistentVolumeClaim
  • get/kubernetes/{id}/persistent_volumesGet all PersistentVolumes in the cluster
  • get/kubernetes/{id}/persistent_volumes/{name}Get a specific PersistentVolume
  • post/kubernetes/{id}/persistent_volumes/deleteDelete PersistentVolumes
  • put/kubernetes/{id}/persistent_volumes/reclaim_policyUpdate reclaim policy of a PersistentVolume
  • get/kubernetes/{id}/podsGet Kubernetes pods
  • get/kubernetes/{id}/rbac_enabledCheck if RBAC is enabled
  • post/kubernetes/{id}/role_bindings/deleteDelete role bindings
  • get/kubernetes/{id}/rolebindingsGet a list of kubernetes role bindings
  • get/kubernetes/{id}/rolesGet a list of kubernetes roles
  • post/kubernetes/{id}/roles/deleteDelete roles
  • get/kubernetes/{id}/secretsGet a list of Secrets
  • get/kubernetes/{id}/secrets/countGet Secrets count
  • post/kubernetes/{id}/service_accounts/deleteDelete service accounts
  • get/kubernetes/{id}/serviceaccountsGet a list of kubernetes service accounts
  • get/kubernetes/{id}/servicesGet a list of services
  • get/kubernetes/{id}/services/countGet services count
  • post/kubernetes/{id}/services/deleteDelete services
  • get/kubernetes/{id}/storage_classesGet all StorageClasses
  • get/kubernetes/{id}/storage_classes/{name}Get a specific StorageClass
  • put/kubernetes/{id}/storage_classes/{name}/defaultSet a StorageClass as default
  • post/kubernetes/{id}/storage_classes/deleteDelete StorageClasses
  • get/kubernetes/{id}/versionGet the Kubernetes cluster version and Portainer-relevant capabilities
  • get/kubernetes/{id}/volumesGet 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/countGet the total number of kubernetes volumes within the given Portainer environment.
  • get/kubernetes/configGenerate a kubeconfig file
ldap1
motd1
registries7
resource_controls3
roles1
settings3
ssl2
stacks22
status1
system5
tags3
team_memberships5
teams5
templates2
upload1
users14
webhooks5
websocket4