PortainerCE API — kubernetes

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
        

# --- truncated at 32 KB (95 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/capabilities/portainer-kubernetes.yaml