naftiko: 1.0.0-alpha2 info: label: PortainerCE API — kubernetes description: 'PortainerCE API — kubernetes. 65 operations. Lead operation: Generate a kubeconfig file. Self-contained Naftiko capability covering one Portainer business surface.' tags: - Portainer - kubernetes created: '2026-05-19' modified: '2026-05-19' binds: - namespace: env keys: PORTAINER_API_KEY: PORTAINER_API_KEY capability: consumes: - type: http namespace: portainer-kubernetes baseUri: '' description: PortainerCE API — kubernetes business capability. Self-contained, no shared references. resources: - name: kubernetes-config path: /kubernetes/config operations: - name: getkubernetesconfig method: GET description: Generate a kubeconfig file outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: ids in: query type: array description: will include only these environments(endpoints) - name: excludeIds in: query type: array description: will exclude these environments(endpoints) - name: kubernetes-id-applications path: /kubernetes/{id}/applications operations: - name: getallkubernetesapplications method: GET description: 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. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment(Endpoint) identifier required: true - name: namespace in: query type: string description: Namespace name required: true - name: nodeName in: query type: string description: Node name required: true - name: kubernetes-id-applications-count path: /kubernetes/{id}/applications/count operations: - name: getallkubernetesapplicationscount method: GET description: Get Applications count outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-cluster_role_bindings-delete path: /kubernetes/{id}/cluster_role_bindings/delete operations: - name: deleteclusterrolebindings method: POST description: Delete cluster role bindings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: payload in: body type: array description: A list of cluster role bindings to delete required: true - name: kubernetes-id-cluster_roles-delete path: /kubernetes/{id}/cluster_roles/delete operations: - name: deleteclusterroles method: POST description: Delete cluster roles outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: payload in: body type: array description: A list of cluster roles to delete required: true - name: kubernetes-id-clusterrolebindings path: /kubernetes/{id}/clusterrolebindings operations: - name: getallkubernetesclusterrolebindings method: GET description: Get a list of kubernetes cluster role bindings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-clusterroles path: /kubernetes/{id}/clusterroles operations: - name: getallkubernetesclusterroles method: GET description: Get a list of kubernetes cluster roles outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-configmaps path: /kubernetes/{id}/configmaps operations: - name: getallkubernetesconfigmaps method: GET description: Get a list of ConfigMaps outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: isUsed in: query type: boolean description: Set to true to include information about applications that use the ConfigMaps in the response required: true - name: kubernetes-id-configmaps-count path: /kubernetes/{id}/configmaps/count operations: - name: getallkubernetesconfigmapscount method: GET description: Get ConfigMaps count outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-cron_jobs path: /kubernetes/{id}/cron_jobs operations: - name: getkubernetescronjobs method: GET description: Get a list of kubernetes Cron Jobs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-cron_jobs-delete path: /kubernetes/{id}/cron_jobs/delete operations: - name: deletecronjobs method: POST description: Delete Cron Jobs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: payload in: body type: string description: A map where the key is the namespace and the value is an array of Cron Jobs to delete required: true - name: kubernetes-id-dashboard path: /kubernetes/{id}/dashboard operations: - name: getkubernetesdashboard method: GET description: Get the dashboard summary data outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment (Endpoint) identifier required: true - name: kubernetes-id-describe path: /kubernetes/{id}/describe operations: - name: describeresource method: GET description: Get a description of a kubernetes resource outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: name in: query type: string description: Resource name required: true - name: kind in: query type: string description: Resource kind required: true - name: namespace in: query type: string description: Namespace - name: kubernetes-id-events path: /kubernetes/{id}/events operations: - name: getallkubernetesevents method: GET description: Gets kubernetes events outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: resourceId in: query type: string description: The resource id of the involved kubernetes object - name: kubernetes-id-ingresscontrollers path: /kubernetes/{id}/ingresscontrollers operations: - name: getallkubernetesingresscontrollers method: GET description: Get a list of ingress controllers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: allowedOnly in: query type: boolean description: Only return allowed ingress controllers - name: updatekubernetesingresscontrollers method: PUT description: Update (block/unblock) ingress controllers outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: body in: body type: array description: Ingress controllers required: true - name: kubernetes-id-ingresses path: /kubernetes/{id}/ingresses operations: - name: getallkubernetesclusteringresses method: GET description: Get kubernetes ingresses at the cluster level outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: withServices in: query type: boolean description: Lookup services associated with each ingress - name: kubernetes-id-ingresses-count path: /kubernetes/{id}/ingresses/count operations: - name: getallkubernetesclusteringressescount method: GET description: Get Ingresses count outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-ingresses-delete path: /kubernetes/{id}/ingresses/delete operations: - name: deletekubernetesingresses method: POST description: Delete one or more Ingresses outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: body in: body type: string description: Ingress details required: true - name: kubernetes-id-jobs path: /kubernetes/{id}/jobs operations: - name: getkubernetesjobs method: GET description: Get a list of kubernetes Jobs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: includeCronJobChildren in: query type: boolean description: Whether to include Jobs that have a cronjob owner - name: kubernetes-id-jobs-delete path: /kubernetes/{id}/jobs/delete operations: - name: deletejobs method: POST description: Delete Jobs outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: payload in: body type: string description: A map where the key is the namespace and the value is an array of Jobs to delete required: true - name: kubernetes-id-max_resource_limits path: /kubernetes/{id}/max_resource_limits operations: - name: getkubernetesmaxresourcelimits method: GET description: Get max CPU and memory limits of all nodes within k8s cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment(Endpoint) identifier required: true - name: kubernetes-id-metrics-applications_resources path: /kubernetes/{id}/metrics/applications_resources operations: - name: getapplicationsresources method: GET description: Get the total resource requests and limits of all applications outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment(Endpoint) identifier required: true - name: node in: query type: string description: Node name required: true - name: kubernetes-id-metrics-nodes path: /kubernetes/{id}/metrics/nodes operations: - name: getkubernetesmetricsforallnodes method: GET description: Get a list of nodes with their live metrics outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-metrics-nodes-name path: /kubernetes/{id}/metrics/nodes/{name} operations: - name: getkubernetesmetricsfornode method: GET description: Get live metrics for a node outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: name in: path type: string description: Node identifier required: true - name: kubernetes-id-metrics-pods-namespace path: /kubernetes/{id}/metrics/pods/{namespace} operations: - name: getkubernetesmetricsforallpods method: GET description: Get a list of pods with their live metrics outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace required: true - name: kubernetes-id-metrics-pods-namespace-name path: /kubernetes/{id}/metrics/pods/{namespace}/{name} operations: - name: getkubernetesmetricsforpod method: GET description: Get live metrics for a pod outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace required: true - name: name in: path type: string description: Pod identifier required: true - name: kubernetes-id-namespaces path: /kubernetes/{id}/namespaces operations: - name: deletekubernetesnamespace method: DELETE description: Delete a kubernetes namespace outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: getkubernetesnamespaces method: GET description: Get a list of namespaces outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: withResourceQuota in: query type: boolean description: When set to true, include the resource quota information as part of the Namespace information. Default is false required: true - name: withUnhealthyEvents in: query type: boolean description: When set to true, include the unhealthy events information as part of the Namespace information. Default is false required: true - name: createkubernetesnamespace method: POST description: Create a namespace outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: body in: body type: string description: Namespace configuration details required: true - name: updatekubernetesnamespacedeprecated method: PUT description: Update a namespace outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace required: true - name: body in: body type: string description: Namespace details required: true - name: kubernetes-id-namespaces-count path: /kubernetes/{id}/namespaces/count operations: - name: getkubernetesnamespacescount method: GET description: Get the total number of kubernetes namespaces within the given Portainer environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-namespaces-namespace path: /kubernetes/{id}/namespaces/{namespace} operations: - name: getkubernetesnamespace method: GET description: Get namespace details outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: The namespace name to get details for required: true - name: withResourceQuota in: query type: boolean description: When set to true, include the resource quota information as part of the Namespace information. Default is false required: true - name: updatekubernetesnamespace method: PUT description: Update a namespace outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace required: true - name: body in: body type: string description: Namespace details required: true - name: kubernetes-id-namespaces-namespace-configmaps-configmap path: /kubernetes/{id}/namespaces/{namespace}/configmaps/{configmap} operations: - name: getkubernetesconfigmap method: GET description: Get a ConfigMap outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: The namespace name where the configmap is located required: true - name: configmap in: path type: string description: The configmap name to get details for required: true - name: kubernetes-id-namespaces-namespace-events path: /kubernetes/{id}/namespaces/{namespace}/events operations: - name: getkuberneteseventsfornamespace method: GET description: Gets kubernetes events for namespace outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: The namespace name the events are associated to required: true - name: resourceId in: query type: string description: The resource id of the involved kubernetes object - name: kubernetes-id-namespaces-namespace-ingresscontrollers path: /kubernetes/{id}/namespaces/{namespace}/ingresscontrollers operations: - name: getkubernetesingresscontrollersbynamespace method: GET description: Get a list ingress controllers by namespace outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace required: true - name: updatekubernetesingresscontrollersbynamespace method: PUT description: Update (block/unblock) ingress controllers by namespace outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace name required: true - name: body in: body type: array description: Ingress controllers required: true - name: kubernetes-id-namespaces-namespace-ingresses path: /kubernetes/{id}/namespaces/{namespace}/ingresses operations: - name: getallkubernetesingresses method: GET description: Get a list of Ingresses outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace name required: true - name: createkubernetesingress method: POST description: Create an Ingress outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace name required: true - name: body in: body type: string description: Ingress details required: true - name: updatekubernetesingress method: PUT description: Update an Ingress outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace name required: true - name: body in: body type: string description: Ingress details required: true - name: kubernetes-id-namespaces-namespace-ingresses-ingress path: /kubernetes/{id}/namespaces/{namespace}/ingresses/{ingress} operations: - name: getkubernetesingress method: GET description: Get an Ingress by name outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace name required: true - name: ingress in: path type: string description: Ingress name required: true - name: kubernetes-id-namespaces-namespace-secrets-secret path: /kubernetes/{id}/namespaces/{namespace}/secrets/{secret} operations: - name: getkubernetessecret method: GET description: Get a Secret outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: The namespace name where the secret is located required: true - name: secret in: path type: string description: The secret name to get details for required: true - name: kubernetes-id-namespaces-namespace-services path: /kubernetes/{id}/namespaces/{namespace}/services operations: - name: getkubernetesservicesbynamespace method: GET description: Get a list of services for a given namespace outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace name required: true - name: createkubernetesservice method: POST description: Create a service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace name required: true - name: body in: body type: string description: Service definition required: true - name: updatekubernetesservice method: PUT description: Update a service outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace name required: true - name: body in: body type: string description: Service definition required: true - name: kubernetes-id-namespaces-namespace-system path: /kubernetes/{id}/namespaces/{namespace}/system operations: - name: kubernetesnamespacestogglesystem method: PUT description: Toggle the system state for a namespace outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace name required: true - name: body in: body type: string description: Update details required: true - name: kubernetes-id-namespaces-namespace-volumes path: /kubernetes/{id}/namespaces/{namespace}/volumes operations: - name: getkubernetesvolumesinnamespace method: GET description: Get Kubernetes volumes within a namespace in the given Portainer environment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace identifier required: true - name: withApplications in: query type: boolean description: When set to True, include the applications that are using the volumes. It is set to false by default - name: kubernetes-id-nodes-name-drain path: /kubernetes/{id}/nodes/{name}/drain operations: - name: drainnode method: POST description: Drain a Kubernetes node outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment(Endpoint) identifier required: true - name: name in: path type: string description: Name of the node to drain required: true - name: kubernetes-id-nodes_limits path: /kubernetes/{id}/nodes_limits operations: - name: getkubernetesnodeslimits method: GET description: Get CPU and memory limits of all nodes within k8s cluster outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment(Endpoint) identifier required: true - name: kubernetes-id-rbac_enabled path: /kubernetes/{id}/rbac_enabled operations: - name: getkubernetesrbacstatus method: GET description: Check if RBAC is enabled outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment(Endpoint) identifier required: true - name: kubernetes-id-role_bindings-delete path: /kubernetes/{id}/role_bindings/delete operations: - name: deleterolebindings method: POST description: Delete role bindings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: payload in: body type: string description: A map where the key is the namespace and the value is an array of role bindings to delete required: true - name: kubernetes-id-rolebindings path: /kubernetes/{id}/rolebindings operations: - name: getkubernetesrolebindings method: GET description: Get a list of kubernetes role bindings outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-roles path: /kubernetes/{id}/roles operations: - name: getkubernetesroles method: GET description: Get a list of kubernetes roles outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-roles-delete path: /kubernetes/{id}/roles/delete operations: - name: deleteroles method: POST description: Delete roles outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: payload in: body type: string description: A map where the key is the namespace and the value is an array of roles to delete required: true - name: kubernetes-id-secrets path: /kubernetes/{id}/secrets operations: - name: getkubernetessecrets method: GET description: Get a list of Secrets outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: isUsed in: query type: boolean description: When set to true, associate the Secrets with the applications that use them required: true - name: kubernetes-id-secrets-count path: /kubernetes/{id}/secrets/count operations: - name: getkubernetessecretscount method: GET description: Get Secrets count outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-service_accounts-delete path: /kubernetes/{id}/service_accounts/delete operations: - name: deleteserviceaccounts method: POST description: Delete service accounts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: payload in: body type: string description: A map where the key is the namespace and the value is an array of service accounts to delete required: true - name: kubernetes-id-serviceaccounts path: /kubernetes/{id}/serviceaccounts operations: - name: getkubernetesserviceaccounts method: GET description: Get a list of kubernetes service accounts outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-services path: /kubernetes/{id}/services operations: - name: getkubernetesservices method: GET description: Get a list of services outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: withApplications in: query type: boolean description: Lookup applications associated with each service - name: kubernetes-id-services-count path: /kubernetes/{id}/services/count operations: - name: getallkubernetesservicescount method: GET description: Get services count outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-services-delete path: /kubernetes/{id}/services/delete operations: - name: deletekubernetesservices method: POST description: Delete services outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: body in: body type: string description: A map where the key is the namespace and the value is an array of services to delete required: true - name: kubernetes-id-volumes path: /kubernetes/{id}/volumes operations: - name: getallkubernetesvolumes method: GET description: Get Kubernetes volumes within the given Portainer environment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: withApplications in: query type: boolean description: When set to True, include the applications that are using the volumes. It is set to false by default - name: kubernetes-id-volumes-count path: /kubernetes/{id}/volumes/count operations: - name: getallkubernetesvolumescount method: GET description: Get the total number of kubernetes volumes within the given Portainer environment. outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: kubernetes-id-volumes-namespace-volume path: /kubernetes/{id}/volumes/{namespace}/{volume} operations: - name: getkubernetesvolume method: GET description: Get a Kubernetes volume within the given Portainer environment outputRawFormat: json outputParameters: - name: result type: object value: $. inputParameters: - name: id in: path type: integer description: Environment identifier required: true - name: namespace in: path type: string description: Namespace identifier required: true - name: volume in: path type: string description: Volume name required: true exposes: - type: rest namespace: portainer-kubernetes-rest port: 8080 description: REST adapter for PortainerCE API — kubernetes. One Spectral-compliant resource per consumed operation, prefixed with /v1. resources: - path: /v1/kubernetes/config name: kubernetes-config description: REST surface for kubernetes-config. operations: - method: GET name: getkubernetesconfig description: Generate a kubeconfig file call: portainer-kubernetes.getkubernetesconfig with: ids: rest.ids excludeIds: rest.excludeIds outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/applications name: kubernetes-id-applications description: REST surface for kubernetes-id-applications. operations: - method: GET name: getallkubernetesapplications description: 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. call: portainer-kubernetes.getallkubernetesapplications with: id: rest.id namespace: rest.namespace nodeName: rest.nodeName outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/applications/count name: kubernetes-id-applications-count description: REST surface for kubernetes-id-applications-count. operations: - method: GET name: getallkubernetesapplicationscount description: Get Applications count call: portainer-kubernetes.getallkubernetesapplicationscount with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/cluster-role-bindings/delete name: kubernetes-id-cluster-role-bindings-delete description: REST surface for kubernetes-id-cluster_role_bindings-delete. operations: - method: POST name: deleteclusterrolebindings description: Delete cluster role bindings call: portainer-kubernetes.deleteclusterrolebindings with: id: rest.id payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/cluster-roles/delete name: kubernetes-id-cluster-roles-delete description: REST surface for kubernetes-id-cluster_roles-delete. operations: - method: POST name: deleteclusterroles description: Delete cluster roles call: portainer-kubernetes.deleteclusterroles with: id: rest.id payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/clusterrolebindings name: kubernetes-id-clusterrolebindings description: REST surface for kubernetes-id-clusterrolebindings. operations: - method: GET name: getallkubernetesclusterrolebindings description: Get a list of kubernetes cluster role bindings call: portainer-kubernetes.getallkubernetesclusterrolebindings with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/clusterroles name: kubernetes-id-clusterroles description: REST surface for kubernetes-id-clusterroles. operations: - method: GET name: getallkubernetesclusterroles description: Get a list of kubernetes cluster roles call: portainer-kubernetes.getallkubernetesclusterroles with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/configmaps name: kubernetes-id-configmaps description: REST surface for kubernetes-id-configmaps. operations: - method: GET name: getallkubernetesconfigmaps description: Get a list of ConfigMaps call: portainer-kubernetes.getallkubernetesconfigmaps with: id: rest.id isUsed: rest.isUsed outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/configmaps/count name: kubernetes-id-configmaps-count description: REST surface for kubernetes-id-configmaps-count. operations: - method: GET name: getallkubernetesconfigmapscount description: Get ConfigMaps count call: portainer-kubernetes.getallkubernetesconfigmapscount with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/cron-jobs name: kubernetes-id-cron-jobs description: REST surface for kubernetes-id-cron_jobs. operations: - method: GET name: getkubernetescronjobs description: Get a list of kubernetes Cron Jobs call: portainer-kubernetes.getkubernetescronjobs with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/cron-jobs/delete name: kubernetes-id-cron-jobs-delete description: REST surface for kubernetes-id-cron_jobs-delete. operations: - method: POST name: deletecronjobs description: Delete Cron Jobs call: portainer-kubernetes.deletecronjobs with: id: rest.id payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/dashboard name: kubernetes-id-dashboard description: REST surface for kubernetes-id-dashboard. operations: - method: GET name: getkubernetesdashboard description: Get the dashboard summary data call: portainer-kubernetes.getkubernetesdashboard with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/describe name: kubernetes-id-describe description: REST surface for kubernetes-id-describe. operations: - method: GET name: describeresource description: Get a description of a kubernetes resource call: portainer-kubernetes.describeresource with: id: rest.id name: rest.name kind: rest.kind namespace: rest.namespace outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/events name: kubernetes-id-events description: REST surface for kubernetes-id-events. operations: - method: GET name: getallkubernetesevents description: Gets kubernetes events call: portainer-kubernetes.getallkubernetesevents with: id: rest.id resourceId: rest.resourceId outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/ingresscontrollers name: kubernetes-id-ingresscontrollers description: REST surface for kubernetes-id-ingresscontrollers. operations: - method: GET name: getallkubernetesingresscontrollers description: Get a list of ingress controllers call: portainer-kubernetes.getallkubernetesingresscontrollers with: id: rest.id allowedOnly: rest.allowedOnly outputParameters: - type: object mapping: $. - method: PUT name: updatekubernetesingresscontrollers description: Update (block/unblock) ingress controllers call: portainer-kubernetes.updatekubernetesingresscontrollers with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/ingresses name: kubernetes-id-ingresses description: REST surface for kubernetes-id-ingresses. operations: - method: GET name: getallkubernetesclusteringresses description: Get kubernetes ingresses at the cluster level call: portainer-kubernetes.getallkubernetesclusteringresses with: id: rest.id withServices: rest.withServices outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/ingresses/count name: kubernetes-id-ingresses-count description: REST surface for kubernetes-id-ingresses-count. operations: - method: GET name: getallkubernetesclusteringressescount description: Get Ingresses count call: portainer-kubernetes.getallkubernetesclusteringressescount with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/ingresses/delete name: kubernetes-id-ingresses-delete description: REST surface for kubernetes-id-ingresses-delete. operations: - method: POST name: deletekubernetesingresses description: Delete one or more Ingresses call: portainer-kubernetes.deletekubernetesingresses with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/jobs name: kubernetes-id-jobs description: REST surface for kubernetes-id-jobs. operations: - method: GET name: getkubernetesjobs description: Get a list of kubernetes Jobs call: portainer-kubernetes.getkubernetesjobs with: id: rest.id includeCronJobChildren: rest.includeCronJobChildren outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/jobs/delete name: kubernetes-id-jobs-delete description: REST surface for kubernetes-id-jobs-delete. operations: - method: POST name: deletejobs description: Delete Jobs call: portainer-kubernetes.deletejobs with: id: rest.id payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/max-resource-limits name: kubernetes-id-max-resource-limits description: REST surface for kubernetes-id-max_resource_limits. operations: - method: GET name: getkubernetesmaxresourcelimits description: Get max CPU and memory limits of all nodes within k8s cluster call: portainer-kubernetes.getkubernetesmaxresourcelimits with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/metrics/applications-resources name: kubernetes-id-metrics-applications-resources description: REST surface for kubernetes-id-metrics-applications_resources. operations: - method: GET name: getapplicationsresources description: Get the total resource requests and limits of all applications call: portainer-kubernetes.getapplicationsresources with: id: rest.id node: rest.node outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/metrics/nodes name: kubernetes-id-metrics-nodes description: REST surface for kubernetes-id-metrics-nodes. operations: - method: GET name: getkubernetesmetricsforallnodes description: Get a list of nodes with their live metrics call: portainer-kubernetes.getkubernetesmetricsforallnodes with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/metrics/nodes/{name} name: kubernetes-id-metrics-nodes-name description: REST surface for kubernetes-id-metrics-nodes-name. operations: - method: GET name: getkubernetesmetricsfornode description: Get live metrics for a node call: portainer-kubernetes.getkubernetesmetricsfornode with: id: rest.id name: rest.name outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/metrics/pods/{namespace} name: kubernetes-id-metrics-pods-namespace description: REST surface for kubernetes-id-metrics-pods-namespace. operations: - method: GET name: getkubernetesmetricsforallpods description: Get a list of pods with their live metrics call: portainer-kubernetes.getkubernetesmetricsforallpods with: id: rest.id namespace: rest.namespace outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/metrics/pods/{namespace}/{name} name: kubernetes-id-metrics-pods-namespace-name description: REST surface for kubernetes-id-metrics-pods-namespace-name. operations: - method: GET name: getkubernetesmetricsforpod description: Get live metrics for a pod call: portainer-kubernetes.getkubernetesmetricsforpod with: id: rest.id namespace: rest.namespace name: rest.name outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces name: kubernetes-id-namespaces description: REST surface for kubernetes-id-namespaces. operations: - method: DELETE name: deletekubernetesnamespace description: Delete a kubernetes namespace call: portainer-kubernetes.deletekubernetesnamespace with: id: rest.id outputParameters: - type: object mapping: $. - method: GET name: getkubernetesnamespaces description: Get a list of namespaces call: portainer-kubernetes.getkubernetesnamespaces with: id: rest.id withResourceQuota: rest.withResourceQuota withUnhealthyEvents: rest.withUnhealthyEvents outputParameters: - type: object mapping: $. - method: POST name: createkubernetesnamespace description: Create a namespace call: portainer-kubernetes.createkubernetesnamespace with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: updatekubernetesnamespacedeprecated description: Update a namespace call: portainer-kubernetes.updatekubernetesnamespacedeprecated with: id: rest.id namespace: rest.namespace body: rest.body outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/count name: kubernetes-id-namespaces-count description: REST surface for kubernetes-id-namespaces-count. operations: - method: GET name: getkubernetesnamespacescount description: Get the total number of kubernetes namespaces within the given Portainer environment. call: portainer-kubernetes.getkubernetesnamespacescount with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/{namespace} name: kubernetes-id-namespaces-namespace description: REST surface for kubernetes-id-namespaces-namespace. operations: - method: GET name: getkubernetesnamespace description: Get namespace details call: portainer-kubernetes.getkubernetesnamespace with: id: rest.id namespace: rest.namespace withResourceQuota: rest.withResourceQuota outputParameters: - type: object mapping: $. - method: PUT name: updatekubernetesnamespace description: Update a namespace call: portainer-kubernetes.updatekubernetesnamespace with: id: rest.id namespace: rest.namespace body: rest.body outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/{namespace}/configmaps/{configmap} name: kubernetes-id-namespaces-namespace-configmaps-configmap description: REST surface for kubernetes-id-namespaces-namespace-configmaps-configmap. operations: - method: GET name: getkubernetesconfigmap description: Get a ConfigMap call: portainer-kubernetes.getkubernetesconfigmap with: id: rest.id namespace: rest.namespace configmap: rest.configmap outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/{namespace}/events name: kubernetes-id-namespaces-namespace-events description: REST surface for kubernetes-id-namespaces-namespace-events. operations: - method: GET name: getkuberneteseventsfornamespace description: Gets kubernetes events for namespace call: portainer-kubernetes.getkuberneteseventsfornamespace with: id: rest.id namespace: rest.namespace resourceId: rest.resourceId outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/{namespace}/ingresscontrollers name: kubernetes-id-namespaces-namespace-ingresscontrollers description: REST surface for kubernetes-id-namespaces-namespace-ingresscontrollers. operations: - method: GET name: getkubernetesingresscontrollersbynamespace description: Get a list ingress controllers by namespace call: portainer-kubernetes.getkubernetesingresscontrollersbynamespace with: id: rest.id namespace: rest.namespace outputParameters: - type: object mapping: $. - method: PUT name: updatekubernetesingresscontrollersbynamespace description: Update (block/unblock) ingress controllers by namespace call: portainer-kubernetes.updatekubernetesingresscontrollersbynamespace with: id: rest.id namespace: rest.namespace body: rest.body outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/{namespace}/ingresses name: kubernetes-id-namespaces-namespace-ingresses description: REST surface for kubernetes-id-namespaces-namespace-ingresses. operations: - method: GET name: getallkubernetesingresses description: Get a list of Ingresses call: portainer-kubernetes.getallkubernetesingresses with: id: rest.id namespace: rest.namespace outputParameters: - type: object mapping: $. - method: POST name: createkubernetesingress description: Create an Ingress call: portainer-kubernetes.createkubernetesingress with: id: rest.id namespace: rest.namespace body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: updatekubernetesingress description: Update an Ingress call: portainer-kubernetes.updatekubernetesingress with: id: rest.id namespace: rest.namespace body: rest.body outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/{namespace}/ingresses/{ingress} name: kubernetes-id-namespaces-namespace-ingresses-ingress description: REST surface for kubernetes-id-namespaces-namespace-ingresses-ingress. operations: - method: GET name: getkubernetesingress description: Get an Ingress by name call: portainer-kubernetes.getkubernetesingress with: id: rest.id namespace: rest.namespace ingress: rest.ingress outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/{namespace}/secrets/{secret} name: kubernetes-id-namespaces-namespace-secrets-secret description: REST surface for kubernetes-id-namespaces-namespace-secrets-secret. operations: - method: GET name: getkubernetessecret description: Get a Secret call: portainer-kubernetes.getkubernetessecret with: id: rest.id namespace: rest.namespace secret: rest.secret outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/{namespace}/services name: kubernetes-id-namespaces-namespace-services description: REST surface for kubernetes-id-namespaces-namespace-services. operations: - method: GET name: getkubernetesservicesbynamespace description: Get a list of services for a given namespace call: portainer-kubernetes.getkubernetesservicesbynamespace with: id: rest.id namespace: rest.namespace outputParameters: - type: object mapping: $. - method: POST name: createkubernetesservice description: Create a service call: portainer-kubernetes.createkubernetesservice with: id: rest.id namespace: rest.namespace body: rest.body outputParameters: - type: object mapping: $. - method: PUT name: updatekubernetesservice description: Update a service call: portainer-kubernetes.updatekubernetesservice with: id: rest.id namespace: rest.namespace body: rest.body outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/{namespace}/system name: kubernetes-id-namespaces-namespace-system description: REST surface for kubernetes-id-namespaces-namespace-system. operations: - method: PUT name: kubernetesnamespacestogglesystem description: Toggle the system state for a namespace call: portainer-kubernetes.kubernetesnamespacestogglesystem with: id: rest.id namespace: rest.namespace body: rest.body outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/namespaces/{namespace}/volumes name: kubernetes-id-namespaces-namespace-volumes description: REST surface for kubernetes-id-namespaces-namespace-volumes. operations: - method: GET name: getkubernetesvolumesinnamespace description: Get Kubernetes volumes within a namespace in the given Portainer environment call: portainer-kubernetes.getkubernetesvolumesinnamespace with: id: rest.id namespace: rest.namespace withApplications: rest.withApplications outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/nodes/{name}/drain name: kubernetes-id-nodes-name-drain description: REST surface for kubernetes-id-nodes-name-drain. operations: - method: POST name: drainnode description: Drain a Kubernetes node call: portainer-kubernetes.drainnode with: id: rest.id name: rest.name outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/nodes-limits name: kubernetes-id-nodes-limits description: REST surface for kubernetes-id-nodes_limits. operations: - method: GET name: getkubernetesnodeslimits description: Get CPU and memory limits of all nodes within k8s cluster call: portainer-kubernetes.getkubernetesnodeslimits with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/rbac-enabled name: kubernetes-id-rbac-enabled description: REST surface for kubernetes-id-rbac_enabled. operations: - method: GET name: getkubernetesrbacstatus description: Check if RBAC is enabled call: portainer-kubernetes.getkubernetesrbacstatus with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/role-bindings/delete name: kubernetes-id-role-bindings-delete description: REST surface for kubernetes-id-role_bindings-delete. operations: - method: POST name: deleterolebindings description: Delete role bindings call: portainer-kubernetes.deleterolebindings with: id: rest.id payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/rolebindings name: kubernetes-id-rolebindings description: REST surface for kubernetes-id-rolebindings. operations: - method: GET name: getkubernetesrolebindings description: Get a list of kubernetes role bindings call: portainer-kubernetes.getkubernetesrolebindings with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/roles name: kubernetes-id-roles description: REST surface for kubernetes-id-roles. operations: - method: GET name: getkubernetesroles description: Get a list of kubernetes roles call: portainer-kubernetes.getkubernetesroles with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/roles/delete name: kubernetes-id-roles-delete description: REST surface for kubernetes-id-roles-delete. operations: - method: POST name: deleteroles description: Delete roles call: portainer-kubernetes.deleteroles with: id: rest.id payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/secrets name: kubernetes-id-secrets description: REST surface for kubernetes-id-secrets. operations: - method: GET name: getkubernetessecrets description: Get a list of Secrets call: portainer-kubernetes.getkubernetessecrets with: id: rest.id isUsed: rest.isUsed outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/secrets/count name: kubernetes-id-secrets-count description: REST surface for kubernetes-id-secrets-count. operations: - method: GET name: getkubernetessecretscount description: Get Secrets count call: portainer-kubernetes.getkubernetessecretscount with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/service-accounts/delete name: kubernetes-id-service-accounts-delete description: REST surface for kubernetes-id-service_accounts-delete. operations: - method: POST name: deleteserviceaccounts description: Delete service accounts call: portainer-kubernetes.deleteserviceaccounts with: id: rest.id payload: rest.payload outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/serviceaccounts name: kubernetes-id-serviceaccounts description: REST surface for kubernetes-id-serviceaccounts. operations: - method: GET name: getkubernetesserviceaccounts description: Get a list of kubernetes service accounts call: portainer-kubernetes.getkubernetesserviceaccounts with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/services name: kubernetes-id-services description: REST surface for kubernetes-id-services. operations: - method: GET name: getkubernetesservices description: Get a list of services call: portainer-kubernetes.getkubernetesservices with: id: rest.id withApplications: rest.withApplications outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/services/count name: kubernetes-id-services-count description: REST surface for kubernetes-id-services-count. operations: - method: GET name: getallkubernetesservicescount description: Get services count call: portainer-kubernetes.getallkubernetesservicescount with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/services/delete name: kubernetes-id-services-delete description: REST surface for kubernetes-id-services-delete. operations: - method: POST name: deletekubernetesservices description: Delete services call: portainer-kubernetes.deletekubernetesservices with: id: rest.id body: rest.body outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/volumes name: kubernetes-id-volumes description: REST surface for kubernetes-id-volumes. operations: - method: GET name: getallkubernetesvolumes description: Get Kubernetes volumes within the given Portainer environment call: portainer-kubernetes.getallkubernetesvolumes with: id: rest.id withApplications: rest.withApplications outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/volumes/count name: kubernetes-id-volumes-count description: REST surface for kubernetes-id-volumes-count. operations: - method: GET name: getallkubernetesvolumescount description: Get the total number of kubernetes volumes within the given Portainer environment. call: portainer-kubernetes.getallkubernetesvolumescount with: id: rest.id outputParameters: - type: object mapping: $. - path: /v1/kubernetes/{id}/volumes/{namespace}/{volume} name: kubernetes-id-volumes-namespace-volume description: REST surface for kubernetes-id-volumes-namespace-volume. operations: - method: GET name: getkubernetesvolume description: Get a Kubernetes volume within the given Portainer environment call: portainer-kubernetes.getkubernetesvolume with: id: rest.id namespace: rest.namespace volume: rest.volume outputParameters: - type: object mapping: $. - type: mcp namespace: portainer-kubernetes-mcp port: 9090 transport: http description: MCP adapter for PortainerCE API — kubernetes. One tool per consumed operation, routed inline through this capability's consumes block. tools: - name: generate-kubeconfig-file description: Generate a kubeconfig file hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesconfig with: ids: tools.ids excludeIds: tools.excludeIds outputParameters: - type: object mapping: $. - name: get-list-applications-across-all description: 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. hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesapplications with: id: tools.id namespace: tools.namespace nodeName: tools.nodeName outputParameters: - type: object mapping: $. - name: get-applications-count description: Get Applications count hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesapplicationscount with: id: tools.id outputParameters: - type: object mapping: $. - name: delete-cluster-role-bindings description: Delete cluster role bindings hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.deleteclusterrolebindings with: id: tools.id payload: tools.payload outputParameters: - type: object mapping: $. - name: delete-cluster-roles description: Delete cluster roles hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.deleteclusterroles with: id: tools.id payload: tools.payload outputParameters: - type: object mapping: $. - name: get-list-kubernetes-cluster-role description: Get a list of kubernetes cluster role bindings hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesclusterrolebindings with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-kubernetes-cluster-roles description: Get a list of kubernetes cluster roles hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesclusterroles with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-configmaps description: Get a list of ConfigMaps hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesconfigmaps with: id: tools.id isUsed: tools.isUsed outputParameters: - type: object mapping: $. - name: get-configmaps-count description: Get ConfigMaps count hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesconfigmapscount with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-kubernetes-cron-jobs description: Get a list of kubernetes Cron Jobs hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetescronjobs with: id: tools.id outputParameters: - type: object mapping: $. - name: delete-cron-jobs description: Delete Cron Jobs hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.deletecronjobs with: id: tools.id payload: tools.payload outputParameters: - type: object mapping: $. - name: get-dashboard-summary-data description: Get the dashboard summary data hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesdashboard with: id: tools.id outputParameters: - type: object mapping: $. - name: get-description-kubernetes-resource description: Get a description of a kubernetes resource hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.describeresource with: id: tools.id name: tools.name kind: tools.kind namespace: tools.namespace outputParameters: - type: object mapping: $. - name: gets-kubernetes-events description: Gets kubernetes events hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesevents with: id: tools.id resourceId: tools.resourceId outputParameters: - type: object mapping: $. - name: get-list-ingress-controllers description: Get a list of ingress controllers hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesingresscontrollers with: id: tools.id allowedOnly: tools.allowedOnly outputParameters: - type: object mapping: $. - name: update-block-unblock-ingress-controllers description: Update (block/unblock) ingress controllers hints: readOnly: false destructive: false idempotent: true call: portainer-kubernetes.updatekubernetesingresscontrollers with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-kubernetes-ingresses-cluster-level description: Get kubernetes ingresses at the cluster level hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesclusteringresses with: id: tools.id withServices: tools.withServices outputParameters: - type: object mapping: $. - name: get-ingresses-count description: Get Ingresses count hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesclusteringressescount with: id: tools.id outputParameters: - type: object mapping: $. - name: delete-one-more-ingresses description: Delete one or more Ingresses hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.deletekubernetesingresses with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-list-kubernetes-jobs description: Get a list of kubernetes Jobs hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesjobs with: id: tools.id includeCronJobChildren: tools.includeCronJobChildren outputParameters: - type: object mapping: $. - name: delete-jobs description: Delete Jobs hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.deletejobs with: id: tools.id payload: tools.payload outputParameters: - type: object mapping: $. - name: get-max-cpu-and-memory description: Get max CPU and memory limits of all nodes within k8s cluster hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesmaxresourcelimits with: id: tools.id outputParameters: - type: object mapping: $. - name: get-total-resource-requests-and description: Get the total resource requests and limits of all applications hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getapplicationsresources with: id: tools.id node: tools.node outputParameters: - type: object mapping: $. - name: get-list-nodes-their-live description: Get a list of nodes with their live metrics hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesmetricsforallnodes with: id: tools.id outputParameters: - type: object mapping: $. - name: get-live-metrics-node description: Get live metrics for a node hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesmetricsfornode with: id: tools.id name: tools.name outputParameters: - type: object mapping: $. - name: get-list-pods-their-live description: Get a list of pods with their live metrics hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesmetricsforallpods with: id: tools.id namespace: tools.namespace outputParameters: - type: object mapping: $. - name: get-live-metrics-pod description: Get live metrics for a pod hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesmetricsforpod with: id: tools.id namespace: tools.namespace name: tools.name outputParameters: - type: object mapping: $. - name: delete-kubernetes-namespace description: Delete a kubernetes namespace hints: readOnly: false destructive: true idempotent: true call: portainer-kubernetes.deletekubernetesnamespace with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-namespaces description: Get a list of namespaces hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesnamespaces with: id: tools.id withResourceQuota: tools.withResourceQuota withUnhealthyEvents: tools.withUnhealthyEvents outputParameters: - type: object mapping: $. - name: create-namespace description: Create a namespace hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.createkubernetesnamespace with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: update-namespace description: Update a namespace hints: readOnly: false destructive: false idempotent: true call: portainer-kubernetes.updatekubernetesnamespacedeprecated with: id: tools.id namespace: tools.namespace body: tools.body outputParameters: - type: object mapping: $. - name: get-total-number-kubernetes-namespaces description: Get the total number of kubernetes namespaces within the given Portainer environment. hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesnamespacescount with: id: tools.id outputParameters: - type: object mapping: $. - name: get-namespace-details description: Get namespace details hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesnamespace with: id: tools.id namespace: tools.namespace withResourceQuota: tools.withResourceQuota outputParameters: - type: object mapping: $. - name: update-namespace-2 description: Update a namespace hints: readOnly: false destructive: false idempotent: true call: portainer-kubernetes.updatekubernetesnamespace with: id: tools.id namespace: tools.namespace body: tools.body outputParameters: - type: object mapping: $. - name: get-configmap description: Get a ConfigMap hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesconfigmap with: id: tools.id namespace: tools.namespace configmap: tools.configmap outputParameters: - type: object mapping: $. - name: gets-kubernetes-events-namespace description: Gets kubernetes events for namespace hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkuberneteseventsfornamespace with: id: tools.id namespace: tools.namespace resourceId: tools.resourceId outputParameters: - type: object mapping: $. - name: get-list-ingress-controllers-namespace description: Get a list ingress controllers by namespace hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesingresscontrollersbynamespace with: id: tools.id namespace: tools.namespace outputParameters: - type: object mapping: $. - name: update-block-unblock-ingress-controllers-2 description: Update (block/unblock) ingress controllers by namespace hints: readOnly: false destructive: false idempotent: true call: portainer-kubernetes.updatekubernetesingresscontrollersbynamespace with: id: tools.id namespace: tools.namespace body: tools.body outputParameters: - type: object mapping: $. - name: get-list-ingresses description: Get a list of Ingresses hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesingresses with: id: tools.id namespace: tools.namespace outputParameters: - type: object mapping: $. - name: create-ingress description: Create an Ingress hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.createkubernetesingress with: id: tools.id namespace: tools.namespace body: tools.body outputParameters: - type: object mapping: $. - name: update-ingress description: Update an Ingress hints: readOnly: false destructive: false idempotent: true call: portainer-kubernetes.updatekubernetesingress with: id: tools.id namespace: tools.namespace body: tools.body outputParameters: - type: object mapping: $. - name: get-ingress-name description: Get an Ingress by name hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesingress with: id: tools.id namespace: tools.namespace ingress: tools.ingress outputParameters: - type: object mapping: $. - name: get-secret description: Get a Secret hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetessecret with: id: tools.id namespace: tools.namespace secret: tools.secret outputParameters: - type: object mapping: $. - name: get-list-services-given-namespace description: Get a list of services for a given namespace hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesservicesbynamespace with: id: tools.id namespace: tools.namespace outputParameters: - type: object mapping: $. - name: create-service description: Create a service hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.createkubernetesservice with: id: tools.id namespace: tools.namespace body: tools.body outputParameters: - type: object mapping: $. - name: update-service description: Update a service hints: readOnly: false destructive: false idempotent: true call: portainer-kubernetes.updatekubernetesservice with: id: tools.id namespace: tools.namespace body: tools.body outputParameters: - type: object mapping: $. - name: toggle-system-state-namespace description: Toggle the system state for a namespace hints: readOnly: false destructive: false idempotent: true call: portainer-kubernetes.kubernetesnamespacestogglesystem with: id: tools.id namespace: tools.namespace body: tools.body outputParameters: - type: object mapping: $. - name: get-kubernetes-volumes-within-namespace description: Get Kubernetes volumes within a namespace in the given Portainer environment hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesvolumesinnamespace with: id: tools.id namespace: tools.namespace withApplications: tools.withApplications outputParameters: - type: object mapping: $. - name: drain-kubernetes-node description: Drain a Kubernetes node hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.drainnode with: id: tools.id name: tools.name outputParameters: - type: object mapping: $. - name: get-cpu-and-memory-limits description: Get CPU and memory limits of all nodes within k8s cluster hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesnodeslimits with: id: tools.id outputParameters: - type: object mapping: $. - name: check-if-rbac-is-enabled description: Check if RBAC is enabled hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesrbacstatus with: id: tools.id outputParameters: - type: object mapping: $. - name: delete-role-bindings description: Delete role bindings hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.deleterolebindings with: id: tools.id payload: tools.payload outputParameters: - type: object mapping: $. - name: get-list-kubernetes-role-bindings description: Get a list of kubernetes role bindings hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesrolebindings with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-kubernetes-roles description: Get a list of kubernetes roles hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesroles with: id: tools.id outputParameters: - type: object mapping: $. - name: delete-roles description: Delete roles hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.deleteroles with: id: tools.id payload: tools.payload outputParameters: - type: object mapping: $. - name: get-list-secrets description: Get a list of Secrets hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetessecrets with: id: tools.id isUsed: tools.isUsed outputParameters: - type: object mapping: $. - name: get-secrets-count description: Get Secrets count hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetessecretscount with: id: tools.id outputParameters: - type: object mapping: $. - name: delete-service-accounts description: Delete service accounts hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.deleteserviceaccounts with: id: tools.id payload: tools.payload outputParameters: - type: object mapping: $. - name: get-list-kubernetes-service-accounts description: Get a list of kubernetes service accounts hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesserviceaccounts with: id: tools.id outputParameters: - type: object mapping: $. - name: get-list-services description: Get a list of services hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesservices with: id: tools.id withApplications: tools.withApplications outputParameters: - type: object mapping: $. - name: get-services-count description: Get services count hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesservicescount with: id: tools.id outputParameters: - type: object mapping: $. - name: delete-services description: Delete services hints: readOnly: false destructive: false idempotent: false call: portainer-kubernetes.deletekubernetesservices with: id: tools.id body: tools.body outputParameters: - type: object mapping: $. - name: get-kubernetes-volumes-within-given description: Get Kubernetes volumes within the given Portainer environment hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesvolumes with: id: tools.id withApplications: tools.withApplications outputParameters: - type: object mapping: $. - name: get-total-number-kubernetes-volumes description: Get the total number of kubernetes volumes within the given Portainer environment. hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getallkubernetesvolumescount with: id: tools.id outputParameters: - type: object mapping: $. - name: get-kubernetes-volume-within-given description: Get a Kubernetes volume within the given Portainer environment hints: readOnly: true destructive: false idempotent: true call: portainer-kubernetes.getkubernetesvolume with: id: tools.id namespace: tools.namespace volume: tools.volume outputParameters: - type: object mapping: $.