swagger: '2.0'
info:
  contact:
    email: info@portainer.io
  description: 'Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API.

    Examples are available at https://documentation.portainer.io/api/api-examples/

    You can find out more about Portainer at [http://portainer.io](http://portainer.io) and get some support on [Slack](http://portainer.io/slack/).


    # Authentication


    Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used.

    Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the **Authorization** header of each request

    with the **Bearer** authentication mechanism.


    Example:


    ```

    Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE

    ```


    # Security


    Each API environment(endpoint) has an associated access policy, it is documented in the description of each environment(endpoint).


    Different access policies are available:


    - Public access

    - Authenticated access

    - Restricted access

    - Administrator access


    ### Public access


    No authentication is required to access the environments(endpoints) with this access policy.


    ### Authenticated access


    Authentication is required to access the environments(endpoints) with this access policy.


    ### Restricted access


    Authentication is required to access the environments(endpoints) with this access policy.

    Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.


    ### Administrator access


    Authentication as well as an administrator role are required to access the environments(endpoints) with this access policy.


    # Execute Docker requests


    Portainer **DO NOT** expose specific environments(endpoints) to manage your Docker resources (create a container, remove a volume, etc...).


    Instead, it acts as a reverse-proxy to the Docker HTTP API. This means that you can execute Docker requests **via** the Portainer HTTP API.


    To do so, you can use the `/endpoints/{id}/docker` Portainer API environment(endpoint) (which is not documented below due to Swagger limitations). This environment(endpoint) has a restricted access policy so you still need to be authenticated to be able to query this environment(endpoint). Any query on this environment(endpoint) will be proxied to the Docker API of the associated environment(endpoint) (requests and responses objects are the same as documented in the Docker API).


    # Private Registry


    Using private registry, you will need to pass a based64 encoded JSON string ‘{"registryId":\<registryID value\>}’ inside the Request Header. The parameter name is "X-Registry-Auth".

    \<registryID value\> - The registry ID where the repository was created.


    Example:


    ```

    eyJyZWdpc3RyeUlkIjoxfQ==

    ```


    **NOTE**: You can find more information on how to query the Docker API in the [Docker official documentation](https://docs.docker.com/engine/api/v1.30/) as well as in [this Portainer example](https://documentation.portainer.io/api/api-examples/).

    '
  license:
    name: zlib
    url: https://github.com/portainer/portainer/blob/develop/LICENSE
  title: PortainerCE auth kubernetes API
  version: 2.39.1
basePath: /api
schemes:
- http
- https
tags:
- description: Manage Kubernetes cluster
  name: kubernetes
paths:
  /kubernetes/{id}/applications:
    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.

        **Access policy**: authenticated'
      operationId: GetAllKubernetesApplications
      parameters:
      - description: Environment(Endpoint) identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace name
        in: query
        name: namespace
        required: true
        type: string
      - description: Node name
        in: query
        name: nodeName
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sApplication'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the list of applications from the cluster.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: 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.
      tags:
      - kubernetes
  /kubernetes/{id}/applications/count:
    get:
      description: 'Get the count of Applications across all namespaces in the cluster. If the nodeName is provided, it will return the count of applications running on that node.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesApplicationsCount
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            type: integer
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the count of all applications from the cluster.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get Applications count
      tags:
      - kubernetes
  /kubernetes/{id}/cluster_role_bindings/delete:
    post:
      consumes:
      - application/json
      description: 'Delete the provided list of cluster role bindings.

        **Access policy**: Authenticated user.'
      operationId: DeleteClusterRoleBindings
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: A list of cluster role bindings to delete
        in: body
        name: payload
        required: true
        schema:
          items:
            type: string
          type: array
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific cluster role binding.
        '500':
          description: Server error occurred while attempting to delete cluster role bindings.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Delete cluster role bindings
      tags:
      - kubernetes
  /kubernetes/{id}/cluster_roles/delete:
    post:
      consumes:
      - application/json
      description: 'Delete the provided list of cluster roles.

        **Access policy**: Authenticated user.'
      operationId: DeleteClusterRoles
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: A list of cluster roles to delete
        in: body
        name: payload
        required: true
        schema:
          items:
            type: string
          type: array
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific cluster role.
        '500':
          description: Server error occurred while attempting to delete cluster roles.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Delete cluster roles
      tags:
      - kubernetes
  /kubernetes/{id}/clusterrolebindings:
    get:
      description: 'Get a list of kubernetes cluster role bindings within the given environment at the cluster level.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesClusterRoleBindings
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sClusterRoleBinding'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the list of cluster role bindings.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of kubernetes cluster role bindings
      tags:
      - kubernetes
  /kubernetes/{id}/clusterroles:
    get:
      description: 'Get a list of kubernetes cluster roles within the given environment at the cluster level.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesClusterRoles
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sClusterRole'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the list of cluster roles.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of kubernetes cluster roles
      tags:
      - kubernetes
  /kubernetes/{id}/configmaps:
    get:
      description: 'Get a list of ConfigMaps across all namespaces in the cluster. For non-admin users, it will only return ConfigMaps based on the namespaces that they have access to.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesConfigMaps
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Set to true to include information about applications that use the ConfigMaps in the response
        in: query
        name: isUsed
        required: true
        type: boolean
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sConfigMap'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve all configmaps from the cluster.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of ConfigMaps
      tags:
      - kubernetes
  /kubernetes/{id}/configmaps/count:
    get:
      description: 'Get the count of ConfigMaps across all namespaces in the cluster. For non-admin users, it will only return the count of ConfigMaps based on the namespaces that they have access to.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesConfigMapsCount
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            type: integer
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the count of all configmaps from the cluster.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get ConfigMaps count
      tags:
      - kubernetes
  /kubernetes/{id}/cron_jobs:
    get:
      description: 'Get a list of kubernetes Cron Jobs that the user has access to.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesCronJobs
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sCronJob'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the list of Cron Jobs.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of kubernetes Cron Jobs
      tags:
      - kubernetes
  /kubernetes/{id}/cron_jobs/delete:
    post:
      consumes:
      - application/json
      description: 'Delete the provided list of Cron Jobs.

        **Access policy**: Authenticated user.'
      operationId: DeleteCronJobs
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: A map where the key is the namespace and the value is an array of Cron Jobs to delete
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sCronJobDeleteRequests'
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific service account.
        '500':
          description: Server error occurred while attempting to delete Cron Jobs.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Delete Cron Jobs
      tags:
      - kubernetes
  /kubernetes/{id}/dashboard:
    get:
      consumes:
      - application/json
      description: 'Get the dashboard summary data which is simply a count of a range of different commonly used kubernetes resources.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesDashboard
      parameters:
      - description: Environment (Endpoint) identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sDashboard'
            type: array
        '400':
          description: Invalid request
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get the dashboard summary data
      tags:
      - kubernetes
  /kubernetes/{id}/describe:
    get:
      description: 'Get a description of a kubernetes resource.

        **Access policy**: Authenticated user.'
      operationId: DescribeResource
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Resource name
        in: query
        name: name
        required: true
        type: string
      - description: Resource kind
        in: query
        name: kind
        required: true
        type: string
      - description: Namespace
        in: query
        name: namespace
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/kubernetes.describeResourceResponse'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve resource description
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a description of a kubernetes resource
      tags:
      - kubernetes
  /kubernetes/{id}/events:
    get:
      description: 'Get events by query param resourceId

        **Access policy**: Authenticated user.'
      operationId: getAllKubernetesEvents
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: The resource id of the involved kubernetes object
        in: query
        name: resourceId
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sEvent'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '500':
          description: Server error occurred while attempting to retrieve the events.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Gets kubernetes events
      tags:
      - kubernetes
  /kubernetes/{id}/ingresscontrollers:
    get:
      description: 'Get a list of ingress controllers for the given environment. If the allowedOnly query parameter is set, only ingress controllers that are allowed by the environment''s ingress configuration will be returned.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesIngressControllers
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Only return allowed ingress controllers
        in: query
        name: allowedOnly
        type: boolean
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sIngressController'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve ingress controllers
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of ingress controllers
      tags:
      - kubernetes
    put:
      consumes:
      - application/json
      description: 'Update (block/unblock) ingress controllers for the provided environment.

        **Access policy**: Authenticated user.'
      operationId: UpdateKubernetesIngressControllers
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Ingress controllers
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/kubernetes.K8sIngressController'
          type: array
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find the ingress controllers to update.
        '500':
          description: Server error occurred while attempting to update ingress controllers.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Update (block/unblock) ingress controllers
      tags:
      - kubernetes
  /kubernetes/{id}/ingresses:
    get:
      description: 'Get kubernetes ingresses at the cluster level for the provided environment.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesClusterIngresses
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Lookup services associated with each ingress
        in: query
        name: withServices
        type: boolean
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sIngressInfo'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve ingresses.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get kubernetes ingresses at the cluster level
      tags:
      - kubernetes
  /kubernetes/{id}/ingresses/count:
    get:
      description: 'Get the number of kubernetes ingresses within the given environment.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesClusterIngressesCount
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            type: integer
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve ingresses count.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get Ingresses count
      tags:
      - kubernetes
  /kubernetes/{id}/ingresses/delete:
    post:
      consumes:
      - application/json
      description: 'Delete one or more Ingresses in the provided environment.

        **Access policy**: Authenticated user.'
      operationId: DeleteKubernetesIngresses
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Ingress details
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sIngressDeleteRequests'
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific ingress.
        '500':
          description: Server error occurred while attempting to delete specified ingresses.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Delete one or more Ingresses
      tags:
      - kubernetes
  /kubernetes/{id}/jobs:
    get:
      description: 'Get a list of kubernetes Jobs that the user has access to.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesJobs
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Whether to include Jobs that have a cronjob owner
        in: query
        name: includeCronJobChildren
        type: boolean
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sJob'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the list of Jobs.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of kubernetes Jobs
      tags:
      - kubernetes
  /kubernetes/{id}/jobs/delete:
    post:
      consumes:
      - application/json
      description: 'Delete the provided list of Jobs.

        **Access policy**: Authenticated user.'
      operationId: DeleteJobs
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: A map where the key is the namespace and the value is an array of Jobs to delete
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sJobDeleteRequests'
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific service account.
        '500':
          description: Server error occurred while attempting to delete Jobs.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Delete Jobs
      tags:
      - kubernetes
  /kubernetes/{id}/max_resource_limits:
    get:
      description: 'Get max CPU and memory limits (unused resources) of all nodes within k8s cluster.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesMaxResourceLimits
      parameters:
      - description: Environment(Endpoint) identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/portainer.K8sNodesLimits'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve nodes limits.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get max CPU and memory limits of all nodes within k8s cluster
      tags:
      - kubernetes
  /kubernetes/{id}/metrics/applications_resources:
    get:
      description: 'Get the total CPU (cores) and memory (bytes) requests and limits of all applications across all namespaces.

        **Access policy**: Authenticated user.'
      operationId: GetApplicationsResources
      parameters:
      - description: Environment(Endpoint) identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Node name
        in: query
        name: node
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/kubernetes.K8sApplicationResource'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the total resource requests and limits for all applications from the cluster.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get the total resource requests and limits of all applications
      tags:
      - kubernetes
  /kubernetes/{id}/metrics/nodes:
    get:
      description: 'Get a list of metrics associated with all nodes of a cluster.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesMetricsForAllNodes
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/v1beta1.NodeMetricsList'
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '500':
          description: Server error occurred while attempting to retrieve the list of nodes with their live metrics.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of nodes with their live metrics
      tags:
      - kubernetes
  /kubernetes/{id}/metrics/nodes/{name}:
    get:
      description: 'Get live metrics for the specified node.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesMetricsForNode
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Node identifier
        in: path
        name: name
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/v1beta1.NodeMetrics'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '500':
          description: Server error occurred while attempting to retrieve the live metrics for the specified node.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get live metrics for a node
      tags:
      - kubernetes
  /kubernetes/{id}/metrics/pods/{namespace}:
    get:
      description: 'Get a list of pods with their live metrics for the specified namespace.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesMetricsForAllPods
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace
        in: path
        name: namespace
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/v1beta1.PodMetricsList'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '500':
          description: Server error occurred while attempting to retrieve the list of pods with their live metrics.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of pods with their live metrics
      tags:
      - kubernetes
  /kubernetes/{id}/metrics/pods/{namespace}/{name}:
    get:
      description: 'Get live metrics for the specified pod.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesMetricsForPod
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace
        in: path
        name: namespace
        required: true
        type: string
      - description: Pod identifier
        in: path
        name: name
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/v1beta1.PodMetrics'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '500':
          description: Server error occurred while attempting to retrieve the live metrics for the specified pod.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get live metrics for a pod
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces:
    delete:
      description: 'Delete a kubernetes namespace within the given environment.

        **Access policy**: Authenticated user.'
      operationId: DeleteKubernetesNamespace
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      responses:
        '200':
          description: Success
          schema:
            type: string
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '403':
          description: Unauthorized access or operation not allowed.
        '500':
          description: Server error occurred while attempting to delete the namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Delete a kubernetes namespace
      tags:
      - kubernetes
    get:
      description: 'Get a list of all namespaces within the given environment based on the user role and permissions. If the user is an admin, they can access all namespaces. If the user is not an admin, they can only access namespaces that they have access to.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesNamespaces
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: When set to true, include the resource quota information as part of the Namespace information. Default is false
        in: query
        name: withResourceQuota
        required: true
        type: boolean
      - description: When set to true, include the unhealthy events information as part of the Namespace information. Default is false
        in: query
        name: withUnhealthyEvents
        required: true
        type: boolean
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/portainer.K8sNamespaceInfo'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the list of namespaces.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of namespaces
      tags:
      - kubernetes
    post:
      consumes:
      - application/json
      description: 'Create a namespace within the given environment.

        **Access policy**: Authenticated user.'
      operationId: CreateKubernetesNamespace
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace configuration details
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sNamespaceDetails'
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/portainer.K8sNamespaceInfo'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '409':
          description: Conflict - the namespace already exists.
        '500':
          description: Server error occurred while attempting to create the namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Create a namespace
      tags:
      - kubernetes
    put:
      consumes:
      - application/json
      description: 'Update a namespace within the given environment.

        **Access policy**: Authenticated user.'
      operationId: UpdateKubernetesNamespaceDeprecated
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace
        in: path
        name: namespace
        required: true
        type: string
      - description: Namespace details
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sNamespaceDetails'
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/portainer.K8sNamespaceInfo'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific namespace.
        '500':
          description: Server error occurred while attempting to update the namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Update a namespace
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/{namespace}:
    get:
      description: 'Get namespace details for the provided namespace within the given environment.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesNamespace
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: The namespace name to get details for
        in: path
        name: namespace
        required: true
        type: string
      - description: When set to true, include the resource quota information as part of the Namespace information. Default is false
        in: query
        name: withResourceQuota
        required: true
        type: boolean
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/portainer.K8sNamespaceInfo'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific namespace.
        '500':
          description: Server error occurred while attempting to retrieve specified namespace information.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get namespace details
      tags:
      - kubernetes
    put:
      consumes:
      - application/json
      description: 'Update a namespace within the given environment.

        **Access policy**: Authenticated user.'
      operationId: UpdateKubernetesNamespace
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace
        in: path
        name: namespace
        required: true
        type: string
      - description: Namespace details
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sNamespaceDetails'
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/portainer.K8sNamespaceInfo'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific namespace.
        '500':
          description: Server error occurred while attempting to update the namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Update a namespace
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/{namespace}/configmaps/{configmap}:
    get:
      description: 'Get a ConfigMap by name for a given namespace.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesConfigMap
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: The namespace name where the configmap is located
        in: path
        name: namespace
        required: true
        type: string
      - description: The configmap name to get details for
        in: path
        name: configmap
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/kubernetes.K8sConfigMap'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or a configmap with the specified name in the given namespace.
        '500':
          description: Server error occurred while attempting to retrieve a configmap by name within the specified namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a ConfigMap
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/{namespace}/events:
    get:
      description: 'Get events by optional query param resourceId for a given namespace.

        **Access policy**: Authenticated user.'
      operationId: getKubernetesEventsForNamespace
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: The namespace name the events are associated to
        in: path
        name: namespace
        required: true
        type: string
      - description: The resource id of the involved kubernetes object
        in: query
        name: resourceId
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sEvent'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '500':
          description: Server error occurred while attempting to retrieve the events within the specified namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Gets kubernetes events for namespace
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/{namespace}/ingresscontrollers:
    get:
      description: 'Get a list of ingress controllers for the given environment in the provided namespace.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesIngressControllersByNamespace
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace
        in: path
        name: namespace
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sIngressController'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or a namespace with the specified name.
        '500':
          description: Server error occurred while attempting to retrieve ingress controllers by a namespace
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list ingress controllers by namespace
      tags:
      - kubernetes
    put:
      consumes:
      - application/json
      description: 'Update (block/unblock) ingress controllers by namespace for the provided environment.

        **Access policy**: Authenticated user.'
      operationId: UpdateKubernetesIngressControllersByNamespace
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace name
        in: path
        name: namespace
        required: true
        type: string
      - description: Ingress controllers
        in: body
        name: body
        required: true
        schema:
          items:
            $ref: '#/definitions/kubernetes.K8sIngressController'
          type: array
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to update ingress controllers by namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Update (block/unblock) ingress controllers by namespace
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/{namespace}/ingresses:
    get:
      description: 'Get a list of Ingresses. If namespace is provided, it will return the list of Ingresses in that namespace.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesIngresses
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace name
        in: path
        name: namespace
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sIngressInfo'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve ingresses
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of Ingresses
      tags:
      - kubernetes
    post:
      consumes:
      - application/json
      description: 'Create an Ingress for the provided environment.

        **Access policy**: Authenticated user.'
      operationId: CreateKubernetesIngress
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace name
        in: path
        name: namespace
        required: true
        type: string
      - description: Ingress details
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sIngressInfo'
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '409':
          description: Conflict - an ingress with the same name already exists in the specified namespace.
        '500':
          description: Server error occurred while attempting to create an ingress.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Create an Ingress
      tags:
      - kubernetes
    put:
      consumes:
      - application/json
      description: 'Update an Ingress for the provided environment.

        **Access policy**: Authenticated user.'
      operationId: UpdateKubernetesIngress
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace name
        in: path
        name: namespace
        required: true
        type: string
      - description: Ingress details
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sIngressInfo'
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find the specified ingress.
        '500':
          description: Server error occurred while attempting to update the specified ingress.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Update an Ingress
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/{namespace}/ingresses/{ingress}:
    get:
      description: 'Get an Ingress by name for the provided environment.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesIngress
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace name
        in: path
        name: namespace
        required: true
        type: string
      - description: Ingress name
        in: path
        name: ingress
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/kubernetes.K8sIngressInfo'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find an ingress with the specified name.
        '500':
          description: Server error occurred while attempting to retrieve an ingress.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get an Ingress by name
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/{namespace}/secrets/{secret}:
    get:
      description: 'Get a Secret by name for a given namespace.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesSecret
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: The namespace name where the secret is located
        in: path
        name: namespace
        required: true
        type: string
      - description: The secret name to get details for
        in: path
        name: secret
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/kubernetes.K8sSecret'
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve a secret by name belong in a namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a Secret
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/{namespace}/services:
    get:
      description: 'Get a list of services for a given namespace.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesServicesByNamespace
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace name
        in: path
        name: namespace
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sServiceInfo'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve all services for a namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of services for a given namespace
      tags:
      - kubernetes
    post:
      consumes:
      - application/json
      description: 'Create a service within a given namespace

        **Access policy**: Authenticated user.'
      operationId: CreateKubernetesService
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace name
        in: path
        name: namespace
        required: true
        type: string
      - description: Service definition
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sServiceInfo'
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to create a service.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Create a service
      tags:
      - kubernetes
    put:
      consumes:
      - application/json
      description: 'Update a service within a given namespace.

        **Access policy**: Authenticated user.'
      operationId: UpdateKubernetesService
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace name
        in: path
        name: namespace
        required: true
        type: string
      - description: Service definition
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sServiceInfo'
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find the service to update.
        '500':
          description: Server error occurred while attempting to update a service.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Update a service
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/{namespace}/system:
    put:
      consumes:
      - application/json
      description: 'Toggle the system state for a namespace

        **Access policy**: Administrator or environment administrator.'
      operationId: KubernetesNamespacesToggleSystem
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace name
        in: path
        name: namespace
        required: true
        type: string
      - description: Update details
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/kubernetes.namespacesToggleSystemPayload'
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find the namespace to update.
        '500':
          description: Server error occurred while attempting to update the system state of the namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Toggle the system state for a namespace
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/{namespace}/volumes:
    get:
      description: 'Get a list of kubernetes volumes within the specified namespace in the given environment (Endpoint). The Endpoint ID must be a valid Portainer environment identifier.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesVolumesInNamespace
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace identifier
        in: path
        name: namespace
        required: true
        type: string
      - description: When set to True, include the applications that are using the volumes. It is set to false by default
        in: query
        name: withApplications
        type: boolean
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            additionalProperties:
              $ref: '#/definitions/kubernetes.K8sVolumeInfo'
            type: object
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '403':
          description: Unauthorized access or operation not allowed.
        '500':
          description: Server error occurred while attempting to retrieve kubernetes volumes in the namespace.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get Kubernetes volumes within a namespace in the given Portainer environment
      tags:
      - kubernetes
  /kubernetes/{id}/namespaces/count:
    get:
      description: 'Get the total number of kubernetes namespaces within the given environment, including the system namespaces. The total count depends on the user''s role and permissions.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesNamespacesCount
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            type: integer
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to compute the namespace count.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get the total number of kubernetes namespaces within the given Portainer environment.
      tags:
      - kubernetes
  /kubernetes/{id}/nodes/{name}/drain:
    post:
      consumes:
      - application/json
      description: 'Drain a Kubernetes node by safely evicting all pods from the node, preparing it for maintenance or removal

        **Access policy**: authenticated'
      operationId: drainNode
      parameters:
      - description: Environment(Endpoint) identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Name of the node to drain
        in: path
        name: name
        required: true
        type: string
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find the specified node.
        '500':
          description: Server error occurred while attempting to drain node.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Drain a Kubernetes node
      tags:
      - kubernetes
  /kubernetes/{id}/nodes_limits:
    get:
      description: 'Get CPU and memory limits of all nodes within k8s cluster.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesNodesLimits
      parameters:
      - description: Environment(Endpoint) identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/portainer.K8sNodesLimits'
        '400':
          description: Invalid request
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve nodes limits.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get CPU and memory limits of all nodes within k8s cluster
      tags:
      - kubernetes
  /kubernetes/{id}/rbac_enabled:
    get:
      description: 'Check if RBAC is enabled in the specified Kubernetes cluster.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesRBACStatus
      parameters:
      - description: Environment(Endpoint) identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: RBAC status
          schema:
            type: boolean
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the RBAC status.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Check if RBAC is enabled
      tags:
      - kubernetes
  /kubernetes/{id}/role_bindings/delete:
    post:
      consumes:
      - application/json
      description: 'Delete the provided list of role bindings.

        **Access policy**: Authenticated user.'
      operationId: DeleteRoleBindings
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: A map where the key is the namespace and the value is an array of role bindings to delete
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sRoleBindingDeleteRequests'
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific role binding.
        '500':
          description: Server error occurred while attempting to delete role bindings.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Delete role bindings
      tags:
      - kubernetes
  /kubernetes/{id}/rolebindings:
    get:
      description: 'Get a list of kubernetes role bindings that the user has access to.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesRoleBindings
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sRoleBinding'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the list of role bindings.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of kubernetes role bindings
      tags:
      - kubernetes
  /kubernetes/{id}/roles:
    get:
      description: 'Get a list of kubernetes roles that the user has access to.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesRoles
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sRole'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the list of roles.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of kubernetes roles
      tags:
      - kubernetes
  /kubernetes/{id}/roles/delete:
    post:
      consumes:
      - application/json
      description: 'Delete the provided list of roles.

        **Access policy**: Authenticated user.'
      operationId: DeleteRoles
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: A map where the key is the namespace and the value is an array of roles to delete
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sRoleDeleteRequests'
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific role.
        '500':
          description: Server error occurred while attempting to delete roles.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Delete roles
      tags:
      - kubernetes
  /kubernetes/{id}/secrets:
    get:
      description: 'Get a list of Secrets for a given namespace. If isUsed is set to true, information about the applications that use the secrets is also returned.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesSecrets
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: When set to true, associate the Secrets with the applications that use them
        in: query
        name: isUsed
        required: true
        type: boolean
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sSecret'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve all secrets from the cluster.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of Secrets
      tags:
      - kubernetes
  /kubernetes/{id}/secrets/count:
    get:
      description: 'Get the count of Secrets across all namespaces that the user has access to.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesSecretsCount
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            type: integer
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the count of all secrets from the cluster.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get Secrets count
      tags:
      - kubernetes
  /kubernetes/{id}/service_accounts/delete:
    post:
      consumes:
      - application/json
      description: 'Delete the provided list of service accounts.

        **Access policy**: Authenticated user.'
      operationId: DeleteServiceAccounts
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: A map where the key is the namespace and the value is an array of service accounts to delete
        in: body
        name: payload
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sServiceAccountDeleteRequests'
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific service account.
        '500':
          description: Server error occurred while attempting to delete service accounts.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Delete service accounts
      tags:
      - kubernetes
  /kubernetes/{id}/serviceaccounts:
    get:
      description: 'Get a list of kubernetes service accounts that the user has access to.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesServiceAccounts
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sServiceAccount'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the list of service accounts.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of kubernetes service accounts
      tags:
      - kubernetes
  /kubernetes/{id}/services:
    get:
      description: 'Get a list of services that the user has access to.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesServices
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Lookup applications associated with each service
        in: query
        name: withApplications
        type: boolean
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            items:
              $ref: '#/definitions/kubernetes.K8sServiceInfo'
            type: array
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve all services.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a list of services
      tags:
      - kubernetes
  /kubernetes/{id}/services/count:
    get:
      description: 'Get the count of services that the user has access to.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesServicesCount
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            type: integer
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to retrieve the total count of all services.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get services count
      tags:
      - kubernetes
  /kubernetes/{id}/services/delete:
    post:
      consumes:
      - application/json
      description: 'Delete the provided list of services.

        **Access policy**: Authenticated user.'
      operationId: DeleteKubernetesServices
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: A map where the key is the namespace and the value is an array of services to delete
        in: body
        name: body
        required: true
        schema:
          $ref: '#/definitions/kubernetes.K8sServiceDeleteRequests'
      produces:
      - application/json
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier or unable to find a specific service.
        '500':
          description: Server error occurred while attempting to delete services.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Delete services
      tags:
      - kubernetes
  /kubernetes/{id}/volumes:
    get:
      description: 'Get a list of all kubernetes volumes within the given environment (Endpoint). The Endpoint ID must be a valid Portainer environment identifier.

        **Access policy**: Authenticated user.'
      operationId: GetAllKubernetesVolumes
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: When set to True, include the applications that are using the volumes. It is set to false by default
        in: query
        name: withApplications
        type: boolean
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            additionalProperties:
              $ref: '#/definitions/kubernetes.K8sVolumeInfo'
            type: object
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '403':
          description: Unauthorized access or operation not allowed.
        '500':
          description: Server error occurred while attempting to retrieve kubernetes volumes.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get Kubernetes volumes within the given Portainer environment
      tags:
      - kubernetes
  /kubernetes/{id}/volumes/{namespace}/{volume}:
    get:
      description: 'Get a Kubernetes volume within the given environment (Endpoint). The Endpoint ID must be a valid Portainer environment identifier.

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesVolume
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      - description: Namespace identifier
        in: path
        name: namespace
        required: true
        type: string
      - description: Volume name
        in: path
        name: volume
        required: true
        type: string
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            $ref: '#/definitions/kubernetes.K8sVolumeInfo'
        '400':
          description: Invalid request
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get a Kubernetes volume within the given Portainer environment
      tags:
      - kubernetes
  /kubernetes/{id}/volumes/count:
    get:
      description: 'Get the total number of kubernetes volumes within the given environment (Endpoint). The total count depends on the user''s role and permissions. The Endpoint ID must be a valid Portainer environment identifier.

        **Access policy**: Authenticated user.'
      operationId: getAllKubernetesVolumesCount
      parameters:
      - description: Environment identifier
        in: path
        name: id
        required: true
        type: integer
      produces:
      - application/json
      responses:
        '200':
          description: Success
          schema:
            type: integer
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '403':
          description: Unauthorized access or operation not allowed.
        '500':
          description: Server error occurred while attempting to retrieve kubernetes volumes count.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Get the total number of kubernetes volumes within the given Portainer environment.
      tags:
      - kubernetes
  /kubernetes/config:
    get:
      description: 'Generate a kubeconfig file that allows a client to communicate with the Kubernetes API server

        **Access policy**: Authenticated user.'
      operationId: GetKubernetesConfig
      parameters:
      - collectionFormat: csv
        description: will include only these environments(endpoints)
        in: query
        items:
          type: integer
        name: ids
        type: array
      - collectionFormat: csv
        description: will exclude these environments(endpoints)
        in: query
        items:
          type: integer
        name: excludeIds
        type: array
      produces:
      - application/json
      - ' application/yaml'
      responses:
        '200':
          description: Success
          schema:
            type: object
        '400':
          description: Invalid request payload, such as missing required fields or fields not meeting validation criteria.
        '401':
          description: Unauthorized access - the user is not authenticated or does not have the necessary permissions. Ensure that you have provided a valid API key or JWT token, and that you have the required permissions.
        '403':
          description: Permission denied - the user is authenticated but does not have the necessary permissions to access the requested resource or perform the specified operation. Check your user roles and permissions.
        '404':
          description: Unable to find an environment with the specified identifier.
        '500':
          description: Server error occurred while attempting to generate the kubeconfig file.
      security:
      - ApiKeyAuth: []
        jwt: []
      summary: Generate a kubeconfig file
      tags:
      - kubernetes
definitions:
  v1.ConfigMapKeySelector:
    properties:
      key:
        description: The key to select.
        type: string
      name:
        description: 'Name of the referent.

          This field is effectively required, but due to backwards compatibility is

          allowed to be empty. Instances of this type with an empty value here are

          almost certainly wrong.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

          +optional

          +default=""

          +kubebuilder:default=""

          TODO: Drop `kubebuilder:default` when controller-gen doesn''t need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.'
        type: string
      optional:
        description: 'Specify whether the ConfigMap or its key must be defined

          +optional'
        type: boolean
    type: object
  v1.VolumeMount:
    properties:
      mountPath:
        description: 'Path within the container at which the volume should be mounted.  Must

          not contain '':''.'
        type: string
      mountPropagation:
        allOf:
        - $ref: '#/definitions/v1.MountPropagationMode'
        description: 'mountPropagation determines how mounts are propagated from the host

          to container and the other way around.

          When not set, MountPropagationNone is used.

          This field is beta in 1.10.

          When RecursiveReadOnly is set to IfPossible or to Enabled, MountPropagation must be None or unspecified

          (which defaults to None).

          +optional'
      name:
        description: This must match the Name of a Volume.
        type: string
      readOnly:
        description: 'Mounted read-only if true, read-write otherwise (false or unspecified).

          Defaults to false.

          +optional'
        type: boolean
      recursiveReadOnly:
        allOf:
        - $ref: '#/definitions/v1.RecursiveReadOnlyMode'
        description: 'RecursiveReadOnly specifies whether read-only mounts should be handled

          recursively.


          If ReadOnly is false, this field has no meaning and must be unspecified.


          If ReadOnly is true, and this field is set to Disabled, the mount is not made

          recursively read-only.  If this field is set to IfPossible, the mount is made

          recursively read-only, if it is supported by the container runtime.  If this

          field is set to Enabled, the mount is made recursively read-only if it is

          supported by the container runtime, otherwise the pod will not be started and

          an error will be generated to indicate the reason.


          If this field is set to IfPossible or Enabled, MountPropagation must be set to

          None (or be unspecified, which defaults to None).


          If this field is not specified, it is treated as an equivalent of Disabled.

          +optional'
      subPath:
        description: 'Path within the volume from which the container''s volume should be mounted.

          Defaults to "" (volume''s root).

          +optional'
        type: string
      subPathExpr:
        description: 'Expanded path within the volume from which the container''s volume should be mounted.

          Behaves similarly to SubPath but environment variable references $(VAR_NAME) are expanded using the container''s environment.

          Defaults to "" (volume''s root).

          SubPathExpr and SubPath are mutually exclusive.

          +optional'
        type: string
    type: object
  v1.WindowsSecurityContextOptions:
    properties:
      gmsaCredentialSpec:
        description: 'GMSACredentialSpec is where the GMSA admission webhook

          (https://github.com/kubernetes-sigs/windows-gmsa) inlines the contents of the

          GMSA credential spec named by the GMSACredentialSpecName field.

          +optional'
        type: string
      gmsaCredentialSpecName:
        description: 'GMSACredentialSpecName is the name of the GMSA credential spec to use.

          +optional'
        type: string
      hostProcess:
        description: 'HostProcess determines if a container should be run as a ''Host Process'' container.

          All of a Pod''s containers must have the same effective HostProcess value

          (it is not allowed to have a mix of HostProcess containers and non-HostProcess containers).

          In addition, if HostProcess is true then HostNetwork must also be set to true.

          +optional'
        type: boolean
      runAsUserName:
        description: 'The UserName in Windows to run the entrypoint of the container process.

          Defaults to the user specified in image metadata if unspecified.

          May also be set in PodSecurityContext. If set in both SecurityContext and

          PodSecurityContext, the value specified in SecurityContext takes precedence.

          +optional'
        type: string
    type: object
  v1.ContainerRestartRuleOnExitCodes:
    properties:
      operator:
        allOf:
        - $ref: '#/definitions/v1.ContainerRestartRuleOnExitCodesOperator'
        description: "Represents the relationship between the container exit code(s) and the\nspecified values. Possible values are:\n- In: the requirement is satisfied if the container exit code is in the\n  set of specified values.\n- NotIn: the requirement is satisfied if the container exit code is\n  not in the set of specified values.\n+required"
      values:
        description: 'Specifies the set of values to check for container exit codes.

          At most 255 elements are allowed.

          +optional

          +listType=set'
        items:
          type: integer
        type: array
    type: object
  v1.TCPSocketAction:
    properties:
      host:
        description: 'Optional: Host name to connect to, defaults to the pod IP.

          +optional'
        type: string
      port:
        allOf:
        - $ref: '#/definitions/intstr.IntOrString'
        description: 'Number or name of the port to access on the container.

          Number must be in the range 1 to 65535.

          Name must be an IANA_SVC_NAME.'
    type: object
  kubernetes.K8sPersistentVolumeClaim:
    properties:
      accessModes:
        items:
          $ref: '#/definitions/v1.PersistentVolumeAccessMode'
        type: array
      creationDate:
        type: string
      id:
        type: string
      labels:
        additionalProperties:
          type: string
        type: object
      name:
        type: string
      namespace:
        type: string
      owningApplications:
        items:
          $ref: '#/definitions/kubernetes.K8sApplication'
        type: array
      phase:
        $ref: '#/definitions/v1.PersistentVolumeClaimPhase'
      resourcesRequests:
        $ref: '#/definitions/v1.ResourceList'
      storage:
        type: integer
      storageClass:
        type: string
      volumeMode:
        $ref: '#/definitions/v1.PersistentVolumeMode'
      volumeName:
        type: string
    type: object
  v1.SleepAction:
    properties:
      seconds:
        description: Seconds is the number of seconds to sleep.
        type: integer
    type: object
  v1.PersistentVolumeAccessMode:
    enum:
    - ReadWriteOnce
    - ReadOnlyMany
    - ReadWriteMany
    - ReadWriteOncePod
    type: string
    x-enum-varnames:
    - ReadWriteOnce
    - ReadOnlyMany
    - ReadWriteMany
    - ReadWriteOncePod
  kubernetes.K8sSecret:
    properties:
      Annotations:
        additionalProperties:
          type: string
        type: object
      ConfigurationOwner:
        type: string
      ConfigurationOwnerId:
        type: string
      ConfigurationOwners:
        items:
          $ref: '#/definitions/kubernetes.K8sConfigurationOwnerResource'
        type: array
      CreationDate:
        type: string
      Data:
        additionalProperties:
          type: string
        type: object
      IsUsed:
        type: boolean
      Labels:
        additionalProperties:
          type: string
        type: object
      Name:
        type: string
      Namespace:
        type: string
      SecretType:
        type: string
      UID:
        type: string
    type: object
  v1.CSIPersistentVolumeSource:
    properties:
      controllerExpandSecretRef:
        allOf:
        - $ref: '#/definitions/v1.SecretReference'
        description: 'controllerExpandSecretRef is a reference to the secret object containing

          sensitive information to pass to the CSI driver to complete the CSI

          ControllerExpandVolume call.

          This field is optional, and may be empty if no secret is required. If the

          secret object contains more than one secret, all secrets are passed.

          +optional'
      controllerPublishSecretRef:
        allOf:
        - $ref: '#/definitions/v1.SecretReference'
        description: 'controllerPublishSecretRef is a reference to the secret object containing

          sensitive information to pass to the CSI driver to complete the CSI

          ControllerPublishVolume and ControllerUnpublishVolume calls.

          This field is optional, and may be empty if no secret is required. If the

          secret object contains more than one secret, all secrets are passed.

          +optional'
      driver:
        description: 'driver is the name of the driver to use for this volume.

          Required.'
        type: string
      fsType:
        description: 'fsType to mount. Must be a filesystem type supported by the host operating system.

          Ex. "ext4", "xfs", "ntfs".

          +optional'
        type: string
      nodeExpandSecretRef:
        allOf:
        - $ref: '#/definitions/v1.SecretReference'
        description: 'nodeExpandSecretRef is a reference to the secret object containing

          sensitive information to pass to the CSI driver to complete the CSI

          NodeExpandVolume call.

          This field is optional, may be omitted if no secret is required. If the

          secret object contains more than one secret, all secrets are passed.

          +optional'
      nodePublishSecretRef:
        allOf:
        - $ref: '#/definitions/v1.SecretReference'
        description: 'nodePublishSecretRef is a reference to the secret object containing

          sensitive information to pass to the CSI driver to complete the CSI

          NodePublishVolume and NodeUnpublishVolume calls.

          This field is optional, and may be empty if no secret is required. If the

          secret object contains more than one secret, all secrets are passed.

          +optional'
      nodeStageSecretRef:
        allOf:
        - $ref: '#/definitions/v1.SecretReference'
        description: 'nodeStageSecretRef is a reference to the secret object containing sensitive

          information to pass to the CSI driver to complete the CSI NodeStageVolume

          and NodeStageVolume and NodeUnstageVolume calls.

          This field is optional, and may be empty if no secret is required. If the

          secret object contains more than one secret, all secrets are passed.

          +optional'
      readOnly:
        description: 'readOnly value to pass to ControllerPublishVolumeRequest.

          Defaults to false (read/write).

          +optional'
        type: boolean
      volumeAttributes:
        additionalProperties:
          type: string
        description: 'volumeAttributes of the volume to publish.

          +optional'
        type: object
      volumeHandle:
        description: 'volumeHandle is the unique volume name returned by the CSI volume

          plugin’s CreateVolume to refer to the volume on all subsequent calls.

          Required.'
        type: string
    type: object
  kubernetes.K8sRole:
    properties:
      creationDate:
        type: string
      isSystem:
        description: 'isSystem is true if prefixed with "system:" or exists in the kube-system namespace

          or is one of the portainer roles'
        type: boolean
      name:
        type: string
      namespace:
        type: string
      uid:
        type: string
    type: object
  v1.NamespaceStatus:
    properties:
      conditions:
        description: 'Represents the latest available observations of a namespace''s current state.

          +optional

          +patchMergeKey=type

          +patchStrategy=merge

          +listType=map

          +listMapKey=type'
        items:
          $ref: '#/definitions/v1.NamespaceCondition'
        type: array
      phase:
        allOf:
        - $ref: '#/definitions/v1.NamespacePhase'
        description: 'Phase is the current lifecycle phase of the namespace.

          More info: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

          +optional'
    type: object
  v1beta1.NodeMetrics:
    properties:
      apiVersion:
        description: 'APIVersion defines the versioned schema of this representation of an object.

          Servers should convert recognized schemas to the latest internal value, and

          may reject unrecognized values.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

          +optional'
        type: string
      kind:
        description: 'Kind is a string value representing the REST resource this object represents.

          Servers may infer this from the endpoint the client submits requests to.

          Cannot be updated.

          In CamelCase.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

          +optional'
        type: string
      metadata:
        allOf:
        - $ref: '#/definitions/v1.ObjectMeta'
        description: 'Standard object''s metadata.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

          +optional'
      timestamp:
        description: 'The following fields define time interval from which metrics were

          collected from the interval [Timestamp-Window, Timestamp].'
        type: string
      usage:
        allOf:
        - $ref: '#/definitions/v1.ResourceList'
        description: The memory usage is the memory working set.
      window:
        $ref: '#/definitions/v1.Duration'
    type: object
  kubernetes.K8sServicePort:
    properties:
      Name:
        type: string
      NodePort:
        type: integer
      Port:
        type: integer
      Protocol:
        type: string
      TargetPort:
        type: string
    type: object
  v1.ScopedResourceSelectorRequirement:
    properties:
      operator:
        allOf:
        - $ref: '#/definitions/v1.ScopeSelectorOperator'
        description: 'Represents a scope''s relationship to a set of values.

          Valid operators are In, NotIn, Exists, DoesNotExist.'
      scopeName:
        allOf:
        - $ref: '#/definitions/v1.ResourceQuotaScope'
        description: The name of the scope that the selector applies to.
      values:
        description: 'An array of string values. If the operator is In or NotIn,

          the values array must be non-empty. If the operator is Exists or DoesNotExist,

          the values array must be empty.

          This array is replaced during a strategic merge patch.

          +optional

          +listType=atomic'
        items:
          type: string
        type: array
    type: object
  v1.ResourceFieldSelector:
    properties:
      containerName:
        description: 'Container name: required for volumes, optional for env vars

          +optional'
        type: string
      divisor:
        allOf:
        - $ref: '#/definitions/resource.Quantity'
        description: 'Specifies the output format of the exposed resources, defaults to "1"

          +optional'
      resource:
        description: 'Required: resource to select'
        type: string
    type: object
  v1.Container:
    properties:
      args:
        description: 'Arguments to the entrypoint.

          The container image''s CMD is used if this is not provided.

          Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable

          cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced

          to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will

          produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless

          of whether the variable exists or not. Cannot be updated.

          More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

          +optional

          +listType=atomic'
        items:
          type: string
        type: array
      command:
        description: 'Entrypoint array. Not executed within a shell.

          The container image''s ENTRYPOINT is used if this is not provided.

          Variable references $(VAR_NAME) are expanded using the container''s environment. If a variable

          cannot be resolved, the reference in the input string will be unchanged. Double $$ are reduced

          to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e. "$$(VAR_NAME)" will

          produce the string literal "$(VAR_NAME)". Escaped references will never be expanded, regardless

          of whether the variable exists or not. Cannot be updated.

          More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell

          +optional

          +listType=atomic'
        items:
          type: string
        type: array
      env:
        description: 'List of environment variables to set in the container.

          Cannot be updated.

          +optional

          +patchMergeKey=name

          +patchStrategy=merge

          +listType=map

          +listMapKey=name'
        items:
          $ref: '#/definitions/v1.EnvVar'
        type: array
      envFrom:
        description: 'List of sources to populate environment variables in the container.

          The keys defined within a source may consist of any printable ASCII characters except ''=''.

          When a key exists in multiple

          sources, the value associated with the last source will take precedence.

          Values defined by an Env with a duplicate key will take precedence.

          Cannot be updated.

          +optional

          +listType=atomic'
        items:
          $ref: '#/definitions/v1.EnvFromSource'
        type: array
      image:
        description: 'Container image name.

          More info: https://kubernetes.io/docs/concepts/containers/images

          This field is optional to allow higher level config management to default or override

          container images in workload controllers like Deployments and StatefulSets.

          +optional'
        type: string
      imagePullPolicy:
        allOf:
        - $ref: '#/definitions/v1.PullPolicy'
        description: 'Image pull policy.

          One of Always, Never, IfNotPresent.

          Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.

          Cannot be updated.

          More info: https://kubernetes.io/docs/concepts/containers/images#updating-images

          +optional'
      lifecycle:
        allOf:
        - $ref: '#/definitions/v1.Lifecycle'
        description: 'Actions that the management system should take in response to container lifecycle events.

          Cannot be updated.

          +optional'
      livenessProbe:
        allOf:
        - $ref: '#/definitions/v1.Probe'
        description: 'Periodic probe of container liveness.

          Container will be restarted if the probe fails.

          Cannot be updated.

          More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

          +optional'
      name:
        description: 'Name of the container specified as a DNS_LABEL.

          Each container in a pod must have a unique name (DNS_LABEL).

          Cannot be updated.'
        type: string
      ports:
        description: 'List of ports to expose from the container. Not specifying a port here

          DOES NOT prevent that port from being exposed. Any port which is

          listening on the default "0.0.0.0" address inside a container will be

          accessible from the network.

          Modifying this array with strategic merge patch may corrupt the data.

          For more information See https://github.com/kubernetes/kubernetes/issues/108255.

          Cannot be updated.

          +optional

          +patchMergeKey=containerPort

          +patchStrategy=merge

          +listType=map

          +listMapKey=containerPort

          +listMapKey=protocol'
        items:
          $ref: '#/definitions/v1.ContainerPort'
        type: array
      readinessProbe:
        allOf:
        - $ref: '#/definitions/v1.Probe'
        description: 'Periodic probe of container service readiness.

          Container will be removed from service endpoints if the probe fails.

          Cannot be updated.

          More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

          +optional'
      resizePolicy:
        description: 'Resources resize policy for the container.

          This field cannot be set on ephemeral containers.

          +featureGate=InPlacePodVerticalScaling

          +optional

          +listType=atomic'
        items:
          $ref: '#/definitions/v1.ContainerResizePolicy'
        type: array
      resources:
        allOf:
        - $ref: '#/definitions/v1.ResourceRequirements'
        description: 'Compute Resources required by this container.

          Cannot be updated.

          More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

          +optional'
      restartPolicy:
        allOf:
        - $ref: '#/definitions/v1.ContainerRestartPolicy'
        description: 'RestartPolicy defines the restart behavior of individual containers in a pod.

          This overrides the pod-level restart policy. When this field is not specified,

          the restart behavior is defined by the Pod''s restart policy and the container type.

          Additionally, setting the RestartPolicy as "Always" for the init container will

          have the following effect:

          this init container will be continually restarted on

          exit until all regular containers have terminated. Once all regular

          containers have completed, all init containers with restartPolicy "Always"

          will be shut down. This lifecycle differs from normal init containers and

          is often referred to as a "sidecar" container. Although this init

          container still starts in the init container sequence, it does not wait

          for the container to complete before proceeding to the next init

          container. Instead, the next init container starts immediately after this

          init container is started, or after any startupProbe has successfully

          completed.

          +optional'
      restartPolicyRules:
        description: 'Represents a list of rules to be checked to determine if the

          container should be restarted on exit. The rules are evaluated in

          order. Once a rule matches a container exit condition, the remaining

          rules are ignored. If no rule matches the container exit condition,

          the Container-level restart policy determines the whether the container

          is restarted or not. Constraints on the rules:

          - At most 20 rules are allowed.

          - Rules can have the same action.

          - Identical rules are not forbidden in validations.

          When rules are specified, container MUST set RestartPolicy explicitly

          even it if matches the Pod''s RestartPolicy.

          +featureGate=ContainerRestartRules

          +optional

          +listType=atomic'
        items:
          $ref: '#/definitions/v1.ContainerRestartRule'
        type: array
      securityContext:
        allOf:
        - $ref: '#/definitions/v1.SecurityContext'
        description: 'SecurityContext defines the security options the container should be run with.

          If set, the fields of SecurityContext override the equivalent fields of PodSecurityContext.

          More info: https://kubernetes.io/docs/tasks/configure-pod-container/security-context/

          +optional'
      startupProbe:
        allOf:
        - $ref: '#/definitions/v1.Probe'
        description: 'StartupProbe indicates that the Pod has successfully initialized.

          If specified, no other probes are executed until this completes successfully.

          If this probe fails, the Pod will be restarted, just as if the livenessProbe failed.

          This can be used to provide different probe parameters at the beginning of a Pod''s lifecycle,

          when it might take a long time to load data or warm a cache, than during steady-state operation.

          This cannot be updated.

          More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

          +optional'
      stdin:
        description: 'Whether this container should allocate a buffer for stdin in the container runtime. If this

          is not set, reads from stdin in the container will always result in EOF.

          Default is false.

          +optional'
        type: boolean
      stdinOnce:
        description: 'Whether the container runtime should close the stdin channel after it has been opened by

          a single attach. When stdin is true the stdin stream will remain open across multiple attach

          sessions. If stdinOnce is set to true, stdin is opened on container start, is empty until the

          first client attaches to stdin, and then remains open and accepts data until the client disconnects,

          at which time stdin is closed and remains closed until the container is restarted. If this

          flag is false, a container processes that reads from stdin will never receive an EOF.

          Default is false

          +optional'
        type: boolean
      terminationMessagePath:
        description: 'Optional: Path at which the file to which the container''s termination message

          will be written is mounted into the container''s filesystem.

          Message written is intended to be brief final status, such as an assertion failure message.

          Will be truncated by the node if greater than 4096 bytes. The total message length across

          all containers will be limited to 12kb.

          Defaults to /dev/termination-log.

          Cannot be updated.

          +optional'
        type: string
      terminationMessagePolicy:
        allOf:
        - $ref: '#/definitions/v1.TerminationMessagePolicy'
        description: 'Indicate how the termination message should be populated. File will use the contents of

          terminationMessagePath to populate the container status message on both success and failure.

          FallbackToLogsOnError will use the last chunk of container log output if the termination

          message file is empty and the container exited with an error.

          The log output is limited to 2048 bytes or 80 lines, whichever is smaller.

          Defaults to File.

          Cannot be updated.

          +optional'
      tty:
        description: 'Whether this container should allocate a TTY for itself, also requires ''stdin'' to be true.

          Default is false.

          +optional'
        type: boolean
      volumeDevices:
        description: 'volumeDevices is the list of block devices to be used by the container.

          +patchMergeKey=devicePath

          +patchStrategy=merge

          +listType=map

          +listMapKey=devicePath

          +optional'
        items:
          $ref: '#/definitions/v1.VolumeDevice'
        type: array
      volumeMounts:
        description: 'Pod volumes to mount into the container''s filesystem.

          Cannot be updated.

          +optional

          +patchMergeKey=mountPath

          +patchStrategy=merge

          +listType=map

          +listMapKey=mountPath'
        items:
          $ref: '#/definitions/v1.VolumeMount'
        type: array
      workingDir:
        description: 'Container''s working directory.

          If not specified, the container runtime''s default will be used, which

          might be configured in the container image.

          Cannot be updated.

          +optional'
        type: string
    type: object
  kubernetes.K8sApplicationResource:
    properties:
      CpuLimit:
        type: number
      CpuRequest:
        type: number
      MemoryLimit:
        type: integer
      MemoryRequest:
        type: integer
    type: object
  kubernetes.Pod:
    properties:
      ContainerName:
        type: string
      CreationDate:
        type: string
      Image:
        type: string
      ImagePullPolicy:
        type: string
      Name:
        type: string
      NodeName:
        type: string
      PodIP:
        type: string
      Resource:
        $ref: '#/definitions/kubernetes.K8sApplicationResource'
      Status:
        type: string
      Uid:
        type: string
    type: object
  v1.ResourceName:
    enum:
    - cpu
    - memory
    - storage
    - ephemeral-storage
    - pods
    - services
    - replicationcontrollers
    - resourcequotas
    - secrets
    - configmaps
    - persistentvolumeclaims
    - services.nodeports
    - services.loadbalancers
    - requests.cpu
    - requests.memory
    - requests.storage
    - requests.ephemeral-storage
    - limits.cpu
    - limits.memory
    - limits.ephemeral-storage
    type: string
    x-enum-varnames:
    - ResourceCPU
    - ResourceMemory
    - ResourceStorage
    - ResourceEphemeralStorage
    - ResourcePods
    - ResourceServices
    - ResourceReplicationControllers
    - ResourceQuotas
    - ResourceSecrets
    - ResourceConfigMaps
    - ResourcePersistentVolumeClaims
    - ResourceServicesNodePorts
    - ResourceServicesLoadBalancers
    - ResourceRequestsCPU
    - ResourceRequestsMemory
    - ResourceRequestsStorage
    - ResourceRequestsEphemeralStorage
    - ResourceLimitsCPU
    - ResourceLimitsMemory
    - ResourceLimitsEphemeralStorage
  kubernetes.K8sConfigurationOwnerResource:
    properties:
      Id:
        type: string
      Name:
        type: string
      ResourceKind:
        type: string
    type: object
  v1.ResourceQuota:
    properties:
      apiVersion:
        description: 'APIVersion defines the versioned schema of this representation of an object.

          Servers should convert recognized schemas to the latest internal value, and

          may reject unrecognized values.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

          +optional'
        type: string
      kind:
        description: 'Kind is a string value representing the REST resource this object represents.

          Servers may infer this from the endpoint the client submits requests to.

          Cannot be updated.

          In CamelCase.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

          +optional'
        type: string
      metadata:
        allOf:
        - $ref: '#/definitions/v1.ObjectMeta'
        description: 'Standard object''s metadata.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

          +optional'
      spec:
        allOf:
        - $ref: '#/definitions/v1.ResourceQuotaSpec'
        description: 'Spec defines the desired quota.

          https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

          +optional'
      status:
        allOf:
        - $ref: '#/definitions/v1.ResourceQuotaStatus'
        description: 'Status defines the actual enforced quota and its current usage.

          https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#spec-and-status

          +optional'
    type: object
  v1.PersistentVolumeClaimPhase:
    enum:
    - Pending
    - Bound
    - Lost
    type: string
    x-enum-varnames:
    - ClaimPending
    - ClaimBound
    - ClaimLost
  v1.ContainerPort:
    properties:
      containerPort:
        description: 'Number of port to expose on the pod''s IP address.

          This must be a valid port number, 0 < x < 65536.'
        type: integer
      hostIP:
        description: 'What host IP to bind the external port to.

          +optional'
        type: string
      hostPort:
        description: 'Number of port to expose on the host.

          If specified, this must be a valid port number, 0 < x < 65536.

          If HostNetwork is specified, this must match ContainerPort.

          Most containers do not need this.

          +optional'
        type: integer
      name:
        description: 'If specified, this must be an IANA_SVC_NAME and unique within the pod. Each

          named port in a pod must have a unique name. Name for the port that can be

          referred to by services.

          +optional'
        type: string
      protocol:
        allOf:
        - $ref: '#/definitions/v1.Protocol'
        description: 'Protocol for port. Must be UDP, TCP, or SCTP.

          Defaults to "TCP".

          +optional

          +default="TCP"'
    type: object
  v1beta1.NodeMetricsList:
    properties:
      apiVersion:
        description: 'APIVersion defines the versioned schema of this representation of an object.

          Servers should convert recognized schemas to the latest internal value, and

          may reject unrecognized values.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

          +optional'
        type: string
      items:
        description: List of node metrics.
        items:
          $ref: '#/definitions/v1beta1.NodeMetrics'
        type: array
      kind:
        description: 'Kind is a string value representing the REST resource this object represents.

          Servers may infer this from the endpoint the client submits requests to.

          Cannot be updated.

          In CamelCase.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

          +optional'
        type: string
      metadata:
        allOf:
        - $ref: '#/definitions/v1.ListMeta'
        description: 'Standard list metadata.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    type: object
  v1.ObjectFieldSelector:
    properties:
      apiVersion:
        description: 'Version of the schema the FieldPath is written in terms of, defaults to "v1".

          +optional'
        type: string
      fieldPath:
        description: Path of the field to select in the specified API version.
        type: string
    type: object
  v1.ContainerRestartRule:
    properties:
      action:
        allOf:
        - $ref: '#/definitions/v1.ContainerRestartRuleAction'
        description: 'Specifies the action taken on a container exit if the requirements

          are satisfied. The only possible value is "Restart" to restart the

          container.

          +required'
      exitCodes:
        allOf:
        - $ref: '#/definitions/v1.ContainerRestartRuleOnExitCodes'
        description: 'Represents the exit codes to check on container exits.

          +optional

          +oneOf=when'
    type: object
  v1beta1.ContainerMetrics:
    properties:
      name:
        description: Container name corresponding to the one from pod.spec.containers.
        type: string
      usage:
        allOf:
        - $ref: '#/definitions/v1.ResourceList'
        description: The memory usage is the memory working set.
    type: object
  v1.ProcMountType:
    enum:
    - Default
    - Unmasked
    type: string
    x-enum-varnames:
    - DefaultProcMount
    - UnmaskedProcMount
  v1.PersistentVolumeMode:
    enum:
    - Block
    - Filesystem
    type: string
    x-enum-varnames:
    - PersistentVolumeBlock
    - PersistentVolumeFilesystem
  kubernetes.K8sPersistentVolume:
    properties:
      accessModes:
        items:
          $ref: '#/definitions/v1.PersistentVolumeAccessMode'
        type: array
      annotations:
        additionalProperties:
          type: string
        type: object
      capacity:
        $ref: '#/definitions/v1.ResourceList'
      claimRef:
        $ref: '#/definitions/v1.ObjectReference'
      csi:
        $ref: '#/definitions/v1.CSIPersistentVolumeSource'
      name:
        type: string
      persistentVolumeReclaimPolicy:
        $ref: '#/definitions/v1.PersistentVolumeReclaimPolicy'
      storageClassName:
        type: string
      volumeMode:
        $ref: '#/definitions/v1.PersistentVolumeMode'
    type: object
  kubernetes.K8sCronJobDeleteRequests:
    additionalProperties:
      items:
        type: string
      type: array
    type: object
  portainer.K8sNodeLimits:
    properties:
      CPU:
        type: integer
      Memory:
        type: integer
    type: object
  kubernetes.K8sServiceDeleteRequests:
    additionalProperties:
      items:
        type: string
      type: array
    type: object
  v1.ListMeta:
    properties:
      continue:
        description: 'continue may be set if the user set a limit on the number of items returned, and indicates that

          the server has more data available. The value is opaque and may be used to issue another request

          to the endpoint that served this list to retrieve the next set of available objects. Continuing a

          consistent list may not be possible if the server configuration has changed or more than a few

          minutes have passed. The resourceVersion field returned when using this continue value will be

          identical to the value in the first response, unless you have received this token from an error

          message.'
        type: string
      remainingItemCount:
        description: 'remainingItemCount is the number of subsequent items in the list which are not included in this

          list response. If the list request contained label or field selectors, then the number of

          remaining items is unknown and the field will be left unset and omitted during serialization.

          If the list is complete (either because it is not chunking or because this is the last chunk),

          then there are no more remaining items and this field will be left unset and omitted during

          serialization.

          Servers older than v1.15 do not set this field.

          The intended use of the remainingItemCount is *estimating* the size of a collection. Clients

          should not rely on the remainingItemCount to be set or to be exact.

          +optional'
        type: integer
      resourceVersion:
        description: 'String that identifies the server''s internal version of this object that

          can be used by clients to determine when objects have changed.

          Value must be treated as opaque by clients and passed unmodified back to the server.

          Populated by the system.

          Read-only.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

          +optional'
        type: string
      selfLink:
        description: 'Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

          +optional'
        type: string
    type: object
  v1.NamespaceCondition:
    properties:
      lastTransitionTime:
        description: 'Last time the condition transitioned from one status to another.

          +optional'
        type: string
      message:
        description: 'Human-readable message indicating details about last transition.

          +optional'
        type: string
      reason:
        description: 'Unique, one-word, CamelCase reason for the condition''s last transition.

          +optional'
        type: string
      status:
        allOf:
        - $ref: '#/definitions/k8s_io_api_core_v1.ConditionStatus'
        description: Status of the condition, one of True, False, Unknown.
      type:
        allOf:
        - $ref: '#/definitions/v1.NamespaceConditionType'
        description: Type of namespace controller condition.
    type: object
  v1.HTTPHeader:
    properties:
      name:
        description: 'The header field name.

          This will be canonicalized upon output, so case-variant names will be understood as the same header.'
        type: string
      value:
        description: The header field value
        type: string
    type: object
  v1.Protocol:
    enum:
    - TCP
    - UDP
    - SCTP
    type: string
    x-enum-varnames:
    - ProtocolTCP
    - ProtocolUDP
    - ProtocolSCTP
  v1.Duration:
    properties:
      time.Duration:
        enum:
        - -9223372036854775808
        - 9223372036854775807
        - 1
        - 1000
        - 1000000
        - 1000000000
        - 60000000000
        - 3600000000000
        type: integer
        x-enum-varnames:
        - minDuration
        - maxDuration
        - Nanosecond
        - Microsecond
        - Millisecond
        - Second
        - Minute
        - Hour
    type: object
  v1.AppArmorProfileType:
    enum:
    - Unconfined
    - RuntimeDefault
    - Localhost
    type: string
    x-enum-varnames:
    - AppArmorProfileTypeUnconfined
    - AppArmorProfileTypeRuntimeDefault
    - AppArmorProfileTypeLocalhost
  v1.EnvFromSource:
    properties:
      configMapRef:
        allOf:
        - $ref: '#/definitions/v1.ConfigMapEnvSource'
        description: 'The ConfigMap to select from

          +optional'
      prefix:
        description: 'Optional text to prepend to the name of each environment variable.

          May consist of any printable ASCII characters except ''=''.

          +optional'
        type: string
      secretRef:
        allOf:
        - $ref: '#/definitions/v1.SecretEnvSource'
        description: 'The Secret to select from

          +optional'
    type: object
  v1.PullPolicy:
    enum:
    - Always
    - Never
    - IfNotPresent
    type: string
    x-enum-varnames:
    - PullAlways
    - PullNever
    - PullIfNotPresent
  v1.ScopeSelector:
    properties:
      matchExpressions:
        description: 'A list of scope selector requirements by scope of the resources.

          +optional

          +listType=atomic'
        items:
          $ref: '#/definitions/v1.ScopedResourceSelectorRequirement'
        type: array
    type: object
  v1.ScopeSelectorOperator:
    enum:
    - In
    - NotIn
    - Exists
    - DoesNotExist
    type: string
    x-enum-varnames:
    - ScopeSelectorOpIn
    - ScopeSelectorOpNotIn
    - ScopeSelectorOpExists
    - ScopeSelectorOpDoesNotExist
  portainer.K8sNodesLimits:
    additionalProperties:
      $ref: '#/definitions/portainer.K8sNodeLimits'
    type: object
  v1.SecretEnvSource:
    properties:
      name:
        description: 'Name of the referent.

          This field is effectively required, but due to backwards compatibility is

          allowed to be empty. Instances of this type with an empty value here are

          almost certainly wrong.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

          +optional

          +default=""

          +kubebuilder:default=""

          TODO: Drop `kubebuilder:default` when controller-gen doesn''t need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.'
        type: string
      optional:
        description: 'Specify whether the Secret must be defined

          +optional'
        type: boolean
    type: object
  portainer.K8sNamespaceInfo:
    properties:
      Annotations:
        additionalProperties:
          type: string
        type: object
      CreationDate:
        type: string
      Id:
        type: string
      IsDefault:
        type: boolean
      IsSystem:
        type: boolean
      Name:
        type: string
      NamespaceOwner:
        type: string
      ResourceQuota:
        $ref: '#/definitions/v1.ResourceQuota'
      Status:
        $ref: '#/definitions/v1.NamespaceStatus'
      UnhealthyEventCount:
        type: integer
    type: object
  v1.ObjectReference:
    properties:
      apiVersion:
        description: 'API version of the referent.

          +optional'
        type: string
      fieldPath:
        description: 'If referring to a piece of an object instead of an entire object, this string

          should contain a valid JSON/Go field access statement, such as desiredState.manifest.containers[2].

          For example, if the object reference is to a container within a pod, this would take on a value like:

          "spec.containers{name}" (where "name" refers to the name of the container that triggered

          the event) or if no container name is specified "spec.containers[2]" (container with

          index 2 in this pod). This syntax is chosen only to have some well-defined way of

          referencing a part of an object.

          TODO: this design is not final and this field is subject to change in the future.

          +optional'
        type: string
      kind:
        description: 'Kind of the referent.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

          +optional'
        type: string
      name:
        description: 'Name of the referent.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

          +optional'
        type: string
      namespace:
        description: 'Namespace of the referent.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/

          +optional'
        type: string
      resourceVersion:
        description: 'Specific resourceVersion to which this reference is made, if any.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

          +optional'
        type: string
      uid:
        description: 'UID of the referent.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

          +optional'
        type: string
    type: object
  v1.PersistentVolumeReclaimPolicy:
    enum:
    - Recycle
    - Delete
    - Retain
    type: string
    x-enum-varnames:
    - PersistentVolumeReclaimRecycle
    - PersistentVolumeReclaimDelete
    - PersistentVolumeReclaimRetain
  kubernetes.K8sIngressDeleteRequests:
    additionalProperties:
      items:
        type: string
      type: array
    type: object
  v1.Signal:
    enum:
    - SIGABRT
    - SIGALRM
    - SIGBUS
    - SIGCHLD
    - SIGCLD
    - SIGCONT
    - SIGFPE
    - SIGHUP
    - SIGILL
    - SIGINT
    - SIGIO
    - SIGIOT
    - SIGKILL
    - SIGPIPE
    - SIGPOLL
    - SIGPROF
    - SIGPWR
    - SIGQUIT
    - SIGSEGV
    - SIGSTKFLT
    - SIGSTOP
    - SIGSYS
    - SIGTERM
    - SIGTRAP
    - SIGTSTP
    - SIGTTIN
    - SIGTTOU
    - SIGURG
    - SIGUSR1
    - SIGUSR2
    - SIGVTALRM
    - SIGWINCH
    - SIGXCPU
    - SIGXFSZ
    - SIGRTMIN
    - SIGRTMIN+1
    - SIGRTMIN+2
    - SIGRTMIN+3
    - SIGRTMIN+4
    - SIGRTMIN+5
    - SIGRTMIN+6
    - SIGRTMIN+7
    - SIGRTMIN+8
    - SIGRTMIN+9
    - SIGRTMIN+10
    - SIGRTMIN+11
    - SIGRTMIN+12
    - SIGRTMIN+13
    - SIGRTMIN+14
    - SIGRTMIN+15
    - SIGRTMAX-14
    - SIGRTMAX-13
    - SIGRTMAX-12
    - SIGRTMAX-11
    - SIGRTMAX-10
    - SIGRTMAX-9
    - SIGRTMAX-8
    - SIGRTMAX-7
    - SIGRTMAX-6
    - SIGRTMAX-5
    - SIGRTMAX-4
    - SIGRTMAX-3
    - SIGRTMAX-2
    - SIGRTMAX-1
    - SIGRTMAX
    type: string
    x-enum-varnames:
    - SIGABRT
    - SIGALRM
    - SIGBUS
    - SIGCHLD
    - SIGCLD
    - SIGCONT
    - SIGFPE
    - SIGHUP
    - SIGILL
    - SIGINT
    - SIGIO
    - SIGIOT
    - SIGKILL
    - SIGPIPE
    - SIGPOLL
    - SIGPROF
    - SIGPWR
    - SIGQUIT
    - SIGSEGV
    - SIGSTKFLT
    - SIGSTOP
    - SIGSYS
    - SIGTERM
    - SIGTRAP
    - SIGTSTP
    - SIGTTIN
    - SIGTTOU
    - SIGURG
    - SIGUSR1
    - SIGUSR2
    - SIGVTALRM
    - SIGWINCH
    - SIGXCPU
    - SIGXFSZ
    - SIGRTMIN
    - SIGRTMINPLUS1
    - SIGRTMINPLUS2
    - SIGRTMINPLUS3
    - SIGRTMINPLUS4
    - SIGRTMINPLUS5
    - SIGRTMINPLUS6
    - SIGRTMINPLUS7
    - SIGRTMINPLUS8
    - SIGRTMINPLUS9
    - SIGRTMINPLUS10
    - SIGRTMINPLUS11
    - SIGRTMINPLUS12
    - SIGRTMINPLUS13
    - SIGRTMINPLUS14
    - SIGRTMINPLUS15
    - SIGRTMAXMINUS14
    - SIGRTMAXMINUS13
    - SIGRTMAXMINUS12
    - SIGRTMAXMINUS11
    - SIGRTMAXMINUS10
    - SIGRTMAXMINUS9
    - SIGRTMAXMINUS8
    - SIGRTMAXMINUS7
    - SIGRTMAXMINUS6
    - SIGRTMAXMINUS5
    - SIGRTMAXMINUS4
    - SIGRTMAXMINUS3
    - SIGRTMAXMINUS2
    - SIGRTMAXMINUS1
    - SIGRTMAX
  v1.ObjectMeta:
    properties:
      annotations:
        additionalProperties:
          type: string
        description: 'Annotations is an unstructured key value map stored with a resource that may be

          set by external tools to store and retrieve arbitrary metadata. They are not

          queryable and should be preserved when modifying objects.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations

          +optional'
        type: object
      creationTimestamp:
        description: 'CreationTimestamp is a timestamp representing the server time when this object was

          created. It is not guaranteed to be set in happens-before order across separate operations.

          Clients may not set this value. It is represented in RFC3339 form and is in UTC.


          Populated by the system.

          Read-only.

          Null for lists.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

          +optional'
        type: string
      deletionGracePeriodSeconds:
        description: 'Number of seconds allowed for this object to gracefully terminate before

          it will be removed from the system. Only set when deletionTimestamp is also set.

          May only be shortened.

          Read-only.

          +optional'
        type: integer
      deletionTimestamp:
        description: 'DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This

          field is set by the server when a graceful deletion is requested by the user, and is not

          directly settable by a client. The resource is expected to be deleted (no longer visible

          from resource lists, and not reachable by name) after the time in this field, once the

          finalizers list is empty. As long as the finalizers list contains items, deletion is blocked.

          Once the deletionTimestamp is set, this value may not be unset or be set further into the

          future, although it may be shortened or the resource may be deleted prior to this time.

          For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react

          by sending a graceful termination signal to the containers in the pod. After that 30 seconds,

          the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup,

          remove the pod from the API. In the presence of network partitions, this object may still

          exist after this timestamp, until an administrator or automated process can determine the

          resource is fully terminated.

          If not set, graceful deletion of the object has not been requested.


          Populated by the system when a graceful deletion is requested.

          Read-only.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

          +optional'
        type: string
      finalizers:
        description: 'Must be empty before the object is deleted from the registry. Each entry

          is an identifier for the responsible component that will remove the entry

          from the list. If the deletionTimestamp of the object is non-nil, entries

          in this list can only be removed.

          Finalizers may be processed and removed in any order.  Order is NOT enforced

          because it introduces significant risk of stuck finalizers.

          finalizers is a shared field, any actor with permission can reorder it.

          If the finalizer list is processed in order, then this can lead to a situation

          in which the component responsible for the first finalizer in the list is

          waiting for a signal (field value, external system, or other) produced by a

          component responsible for a finalizer later in the list, resulting in a deadlock.

          Without enforced ordering finalizers are free to order amongst themselves and

          are not vulnerable to ordering changes in the list.

          +optional

          +patchStrategy=merge

          +listType=set'
        items:
          type: string
        type: array
      generateName:
        description: 'GenerateName is an optional prefix, used by the server, to generate a unique

          name ONLY IF the Name field has not been provided.

          If this field is used, the name returned to the client will be different

          than the name passed. This value will also be combined with a unique suffix.

          The provided value has the same validation rules as the Name field,

          and may be truncated by the length of the suffix required to make the value

          unique on the server.


          If this field is specified and the generated name exists, the server will return a 409.


          Applied only if Name is not specified.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency

          +optional'
        type: string
      generation:
        description: 'A sequence number representing a specific generation of the desired state.

          Populated by the system. Read-only.

          +optional'
        type: integer
      labels:
        additionalProperties:
          type: string
        description: 'Map of string keys and values that can be used to organize and categorize

          (scope and select) objects. May match selectors of replication controllers

          and services.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels

          +optional'
        type: object
      managedFields:
        description: 'ManagedFields maps workflow-id and version to the set of fields

          that are managed by that workflow. This is mostly for internal

          housekeeping, and users typically shouldn''t need to set or

          understand this field. A workflow can be the user''s name, a

          controller''s name, or the name of a specific apply path like

          "ci-cd". The set of fields is always in the version that the

          workflow used when modifying the object.


          +optional

          +listType=atomic'
        items:
          $ref: '#/definitions/v1.ManagedFieldsEntry'
        type: array
      name:
        description: 'Name must be unique within a namespace. Is required when creating resources, although

          some resources may allow a client to request the generation of an appropriate name

          automatically. Name is primarily intended for creation idempotence and configuration

          definition.

          Cannot be updated.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names

          +optional'
        type: string
      namespace:
        description: 'Namespace defines the space within which each name must be unique. An empty namespace is

          equivalent to the "default" namespace, but "default" is the canonical representation.

          Not all objects are required to be scoped to a namespace - the value of this field for

          those objects will be empty.


          Must be a DNS_LABEL.

          Cannot be updated.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces

          +optional'
        type: string
      ownerReferences:
        description: 'List of objects depended by this object. If ALL objects in the list have

          been deleted, this object will be garbage collected. If this object is managed by a controller,

          then an entry in this list will point to this controller, with the controller field set to true.

          There cannot be more than one managing controller.

          +optional

          +patchMergeKey=uid

          +patchStrategy=merge

          +listType=map

          +listMapKey=uid'
        items:
          $ref: '#/definitions/v1.OwnerReference'
        type: array
      resourceVersion:
        description: 'An opaque value that represents the internal version of this object that can

          be used by clients to determine when objects have changed. May be used for optimistic

          concurrency, change detection, and the watch operation on a resource or set of resources.

          Clients must treat these values as opaque and passed unmodified back to the server.

          They may only be valid for a particular resource or set of resources.


          Populated by the system.

          Read-only.

          Value must be treated as opaque by clients and .

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency

          +optional'
        type: string
      selfLink:
        description: 'Deprecated: selfLink is a legacy read-only field that is no longer populated by the system.

          +optional'
        type: string
      uid:
        description: 'UID is the unique in time and space value for this object. It is typically generated by

          the server on successful creation of a resource and is not allowed to change on PUT

          operations.


          Populated by the system.

          Read-only.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids

          +optional'
        type: string
    type: object
  v1.ManagedFieldsEntry:
    properties:
      apiVersion:
        description: 'APIVersion defines the version of this resource that this field set

          applies to. The format is "group/version" just like the top-level

          APIVersion field. It is necessary to track the version of a field

          set because it cannot be automatically converted.'
        type: string
      fieldsType:
        description: 'FieldsType is the discriminator for the different fields format and version.

          There is currently only one possible value: "FieldsV1"'
        type: string
      fieldsV1:
        allOf:
        - $ref: '#/definitions/v1.FieldsV1'
        description: 'FieldsV1 holds the first JSON version format as described in the "FieldsV1" type.

          +optional'
      manager:
        description: Manager is an identifier of the workflow managing these fields.
        type: string
      operation:
        allOf:
        - $ref: '#/definitions/v1.ManagedFieldsOperationType'
        description: 'Operation is the type of operation which lead to this ManagedFieldsEntry being created.

          The only valid values for this field are ''Apply'' and ''Update''.'
      subresource:
        description: 'Subresource is the name of the subresource used to update that object, or

          empty string if the object was updated through the main resource. The

          value of this field is used to distinguish between managers, even if they

          share the same name. For example, a status update will be distinct from a

          regular update using the same manager name.

          Note that the APIVersion field is not related to the Subresource field and

          it always corresponds to the version of the main resource.'
        type: string
      time:
        description: 'Time is the timestamp of when the ManagedFields entry was added. The

          timestamp will also be updated if a field is added, the manager

          changes any of the owned fields value or removes a field. The

          timestamp does not update when a field is removed from the entry

          because another manager took it over.

          +optional'
        type: string
    type: object
  kubernetes.Configuration:
    properties:
      ConfigurationOwner:
        type: string
      Data:
        additionalProperties: {}
        type: object
      Kind:
        type: string
    type: object
  v1.EnvVar:
    properties:
      name:
        description: 'Name of the environment variable.

          May consist of any printable ASCII characters except ''=''.'
        type: string
      value:
        description: 'Variable references $(VAR_NAME) are expanded

          using the previously defined environment variables in the container and

          any service environment variables. If a variable cannot be resolved,

          the reference in the input string will be unchanged. Double $$ are reduced

          to a single $, which allows for escaping the $(VAR_NAME) syntax: i.e.

          "$$(VAR_NAME)" will produce the string literal "$(VAR_NAME)".

          Escaped references will never be expanded, regardless of whether the variable

          exists or not.

          Defaults to "".

          +optional'
        type: string
      valueFrom:
        allOf:
        - $ref: '#/definitions/v1.EnvVarSource'
        description: 'Source for the environment variable''s value. Cannot be used if value is not empty.

          +optional'
    type: object
  resource.Quantity:
    properties:
      Format:
        enum:
        - DecimalExponent
        - BinarySI
        - DecimalSI
        type: string
        x-enum-comments:
          BinarySI: e.g., 12Mi (12 * 2^20)
          DecimalExponent: e.g., 12e6
          DecimalSI: e.g., 12M  (12 * 10^6)
        x-enum-varnames:
        - DecimalExponent
        - BinarySI
        - DecimalSI
    type: object
  kubernetes.K8sRoleBindingDeleteRequests:
    additionalProperties:
      items:
        type: string
      type: array
    type: object
  v1.ResourceResizeRestartPolicy:
    enum:
    - NotRequired
    - RestartContainer
    type: string
    x-enum-varnames:
    - NotRequired
    - RestartContainer
  v1.ManagedFieldsOperationType:
    enum:
    - Apply
    - Update
    type: string
    x-enum-varnames:
    - ManagedFieldsOperationApply
    - ManagedFieldsOperationUpdate
  v1.SecurityContext:
    properties:
      allowPrivilegeEscalation:
        description: 'AllowPrivilegeEscalation controls whether a process can gain more

          privileges than its parent process. This bool directly controls if

          the no_new_privs flag will be set on the container process.

          AllowPrivilegeEscalation is true always when the container is:

          1) run as Privileged

          2) has CAP_SYS_ADMIN

          Note that this field cannot be set when spec.os.name is windows.

          +optional'
        type: boolean
      appArmorProfile:
        allOf:
        - $ref: '#/definitions/v1.AppArmorProfile'
        description: 'appArmorProfile is the AppArmor options to use by this container. If set, this profile

          overrides the pod''s appArmorProfile.

          Note that this field cannot be set when spec.os.name is windows.

          +optional'
      capabilities:
        allOf:
        - $ref: '#/definitions/v1.Capabilities'
        description: 'The capabilities to add/drop when running containers.

          Defaults to the default set of capabilities granted by the container runtime.

          Note that this field cannot be set when spec.os.name is windows.

          +optional'
      privileged:
        description: 'Run container in privileged mode.

          Processes in privileged containers are essentially equivalent to root on the host.

          Defaults to false.

          Note that this field cannot be set when spec.os.name is windows.

          +optional'
        type: boolean
      procMount:
        allOf:
        - $ref: '#/definitions/v1.ProcMountType'
        description: 'procMount denotes the type of proc mount to use for the containers.

          The default value is Default which uses the container runtime defaults for

          readonly paths and masked paths.

          This requires the ProcMountType feature flag to be enabled.

          Note that this field cannot be set when spec.os.name is windows.

          +optional'
      readOnlyRootFilesystem:
        description: 'Whether this container has a read-only root filesystem.

          Default is false.

          Note that this field cannot be set when spec.os.name is windows.

          +optional'
        type: boolean
      runAsGroup:
        description: 'The GID to run the entrypoint of the container process.

          Uses runtime default if unset.

          May also be set in PodSecurityContext.  If set in both SecurityContext and

          PodSecurityContext, the value specified in SecurityContext takes precedence.

          Note that this field cannot be set when spec.os.name is windows.

          +optional'
        type: integer
      runAsNonRoot:
        description: 'Indicates that the container must run as a non-root user.

          If true, the Kubelet will validate the image at runtime to ensure that it

          does not run as UID 0 (root) and fail to start the container if it does.

          If unset or false, no such validation will be performed.

          May also be set in PodSecurityContext.  If set in both SecurityContext and

          PodSecurityContext, the value specified in SecurityContext takes precedence.

          +optional'
        type: boolean
      runAsUser:
        description: 'The UID to run the entrypoint of the container process.

          Defaults to user specified in image metadata if unspecified.

          May also be set in PodSecurityContext.  If set in both SecurityContext and

          PodSecurityContext, the value specified in SecurityContext takes precedence.

          Note that this field cannot be set when spec.os.name is windows.

          +optional'
        type: integer
      seLinuxOptions:
        allOf:
        - $ref: '#/definitions/v1.SELinuxOptions'
        description: 'The SELinux context to be applied to the container.

          If unspecified, the container runtime will allocate a random SELinux context for each

          container.  May also be set in PodSecurityContext.  If set in both SecurityContext and

          PodSecurityContext, the value specified in SecurityContext takes precedence.

          Note that this field cannot be set when spec.os.name is windows.

          +optional'
      seccompProfile:
        allOf:
        - $ref: '#/definitions/v1.SeccompProfile'
        description: 'The seccomp options to use by this container. If seccomp options are

          provided at both the pod & container level, the container options

          override the pod options.

          Note that this field cannot be set when spec.os.name is windows.

          +optional'
      windowsOptions:
        allOf:
        - $ref: '#/definitions/v1.WindowsSecurityContextOptions'
        description: 'The Windows specific settings applied to all containers.

          If unspecified, the options from the PodSecurityContext will be used.

          If set in both SecurityContext and PodSecurityContext, the value specified in SecurityContext takes precedence.

          Note that this field cannot be set when spec.os.name is linux.

          +optional'
    type: object
  intstr.Type:
    enum:
    - 0
    - 1
    type: integer
    x-enum-comments:
      Int: The IntOrString holds an int.
      String: The IntOrString holds a string.
    x-enum-varnames:
    - Int
    - String
  kubernetes.K8sIngressController:
    properties:
      Availability:
        type: boolean
      ClassName:
        type: string
      Name:
        type: string
      New:
        type: boolean
      Type:
        type: string
      Used:
        type: boolean
    type: object
  v1.TerminationMessagePolicy:
    enum:
    - File
    - FallbackToLogsOnError
    type: string
    x-enum-varnames:
    - TerminationMessageReadFile
    - TerminationMessageFallbackToLogsOnError
  v1.ResourceList:
    additionalProperties:
      $ref: '#/definitions/resource.Quantity'
    type: object
  kubernetes.K8sClusterRoleBinding:
    properties:
      creationDate:
        type: string
      isSystem:
        type: boolean
      name:
        type: string
      namespace:
        type: string
      roleRef:
        $ref: '#/definitions/v1.RoleRef'
      subjects:
        items:
          $ref: '#/definitions/k8s_io_api_rbac_v1.Subject'
        type: array
      uid:
        type: string
    type: object
  k8s_io_api_core_v1.ResourceClaim:
    properties:
      name:
        description: 'Name must match the name of one entry in pod.spec.resourceClaims of

          the Pod where this field is used. It makes that resource available

          inside a container.'
        type: string
      request:
        description: 'Request is the name chosen for a request in the referenced claim.

          If empty, everything from the claim is made available, otherwise

          only the result of this request.


          +optional'
        type: string
    type: object
  kubernetes.K8sResourceQuota:
    properties:
      cpu:
        type: string
      enabled:
        type: boolean
      memory:
        type: string
    type: object
  kubernetes.TLSInfo:
    properties:
      hosts:
        items:
          type: string
        type: array
    type: object
  kubernetes.namespacesToggleSystemPayload:
    properties:
      System:
        description: Toggle the system state of this namespace to true or false
        example: true
        type: boolean
    type: object
  intstr.IntOrString:
    properties:
      IntVal:
        type: integer
      StrVal:
        type: string
      Type:
        $ref: '#/definitions/intstr.Type'
    type: object
  kubernetes.K8sEvent:
    properties:
      count:
        type: integer
      eventTime:
        type: string
      firstTimestamp:
        type: string
      involvedObject:
        $ref: '#/definitions/kubernetes.K8sEventInvolvedObject'
      kind:
        type: string
      lastTimestamp:
        type: string
      message:
        type: string
      name:
        type: string
      namespace:
        type: string
      reason:
        type: string
      type:
        type: string
      uid:
        type: string
    type: object
  kubernetes.PublishedPort:
    properties:
      IngressRules:
        items:
          $ref: '#/definitions/kubernetes.IngressRule'
        type: array
      Port:
        type: integer
    type: object
  v1.EnvVarSource:
    properties:
      configMapKeyRef:
        allOf:
        - $ref: '#/definitions/v1.ConfigMapKeySelector'
        description: 'Selects a key of a ConfigMap.

          +optional'
      fieldRef:
        allOf:
        - $ref: '#/definitions/v1.ObjectFieldSelector'
        description: 'Selects a field of the pod: supports metadata.name, metadata.namespace, `metadata.labels[''<KEY>'']`, `metadata.annotations[''<KEY>'']`,

          spec.nodeName, spec.serviceAccountName, status.hostIP, status.podIP, status.podIPs.

          +optional'
      fileKeyRef:
        allOf:
        - $ref: '#/definitions/v1.FileKeySelector'
        description: 'FileKeyRef selects a key of the env file.

          Requires the EnvFiles feature gate to be enabled.


          +featureGate=EnvFiles

          +optional'
      resourceFieldRef:
        allOf:
        - $ref: '#/definitions/v1.ResourceFieldSelector'
        description: 'Selects a resource of the container: only resources limits and requests

          (limits.cpu, limits.memory, limits.ephemeral-storage, requests.cpu, requests.memory and requests.ephemeral-storage) are currently supported.

          +optional'
      secretKeyRef:
        allOf:
        - $ref: '#/definitions/v1.SecretKeySelector'
        description: 'Selects a key of a secret in the pod''s namespace

          +optional'
    type: object
  kubernetes.K8sStorageClass:
    properties:
      allowVolumeExpansion:
        type: boolean
      name:
        type: string
      provisioner:
        type: string
      reclaimPolicy:
        $ref: '#/definitions/v1.PersistentVolumeReclaimPolicy'
    type: object
  kubernetes.K8sRoleBinding:
    properties:
      creationDate:
        type: string
      isSystem:
        type: boolean
      name:
        type: string
      namespace:
        type: string
      roleRef:
        $ref: '#/definitions/v1.RoleRef'
      subjects:
        items:
          $ref: '#/definitions/k8s_io_api_rbac_v1.Subject'
        type: array
      uid:
        type: string
    type: object
  v1.NamespaceConditionType:
    enum:
    - NamespaceDeletionDiscoveryFailure
    - NamespaceDeletionContentFailure
    - NamespaceDeletionGroupVersionParsingFailure
    - NamespaceContentRemaining
    - NamespaceFinalizersRemaining
    type: string
    x-enum-varnames:
    - NamespaceDeletionDiscoveryFailure
    - NamespaceDeletionContentFailure
    - NamespaceDeletionGVParsingFailure
    - NamespaceContentRemaining
    - NamespaceFinalizersRemaining
  v1.VolumeDevice:
    properties:
      devicePath:
        description: devicePath is the path inside of the container that the device will be mapped to.
        type: string
      name:
        description: name must match the name of a persistentVolumeClaim in the pod
        type: string
    type: object
  kubernetes.K8sEventInvolvedObject:
    properties:
      kind:
        type: string
      name:
        type: string
      namespace:
        type: string
      uid:
        type: string
    type: object
  v1.MountPropagationMode:
    enum:
    - None
    - HostToContainer
    - Bidirectional
    type: string
    x-enum-varnames:
    - MountPropagationNone
    - MountPropagationHostToContainer
    - MountPropagationBidirectional
  kubernetes.K8sApplication:
    properties:
      Annotations:
        additionalProperties:
          type: string
        type: object
      ApplicationOwner:
        type: string
      ApplicationType:
        type: string
      Configurations:
        items:
          $ref: '#/definitions/kubernetes.Configuration'
        type: array
      Containers:
        items: {}
        type: array
      CreationDate:
        type: string
      CustomResourceMetadata:
        $ref: '#/definitions/kubernetes.CustomResourceMetadata'
      DeploymentType:
        type: string
      Id:
        type: string
      Image:
        type: string
      Kind:
        type: string
      Labels:
        additionalProperties:
          type: string
        type: object
      LoadBalancerIPAddress:
        type: string
      MatchLabels:
        additionalProperties:
          type: string
        type: object
      Metadata:
        $ref: '#/definitions/kubernetes.Metadata'
      Name:
        type: string
      Namespace:
        type: string
      Pods:
        items:
          $ref: '#/definitions/kubernetes.Pod'
        type: array
      PublishedPorts:
        items:
          $ref: '#/definitions/kubernetes.PublishedPort'
        type: array
      Resource:
        $ref: '#/definitions/kubernetes.K8sApplicationResource'
      ResourcePool:
        type: string
      RunningPodsCount:
        type: integer
      ServiceId:
        type: string
      ServiceName:
        type: string
      ServiceType:
        type: string
      StackId:
        type: string
      StackKind:
        type: string
      StackName:
        type: string
      Status:
        type: string
      TotalPodsCount:
        type: integer
      Uid:
        type: string
    type: object
  kubernetes.IngressRule:
    properties:
      Host:
        type: string
      IP:
        type: string
      Path:
        type: string
      TLS:
        items:
          $ref: '#/definitions/kubernetes.TLSInfo'
        type: array
    type: object
  v1.SecretReference:
    properties:
      name:
        description: 'name is unique within a namespace to reference a secret resource.

          +optional'
        type: string
      namespace:
        description: 'namespace defines the space within which the secret name must be unique.

          +optional'
        type: string
    type: object
  k8s_io_api_core_v1.ConditionStatus:
    enum:
    - 'True'
    - 'False'
    - Unknown
    type: string
    x-enum-varnames:
    - ConditionTrue
    - ConditionFalse
    - ConditionUnknown
  v1.ContainerRestartRuleAction:
    enum:
    - Restart
    - RestartAllContainers
    type: string
    x-enum-varnames:
    - ContainerRestartRuleActionRestart
    - ContainerRestartRuleActionRestartAllContainers
  kubernetes.K8sNamespaceDetails:
    properties:
      Annotations:
        additionalProperties:
          type: string
        type: object
      Name:
        type: string
      Owner:
        type: string
      ResourceQuota:
        $ref: '#/definitions/kubernetes.K8sResourceQuota'
    type: object
  v1.OwnerReference:
    properties:
      apiVersion:
        description: API version of the referent.
        type: string
      blockOwnerDeletion:
        description: 'If true, AND if the owner has the "foregroundDeletion" finalizer, then

          the owner cannot be deleted from the key-value store until this

          reference is removed.

          See https://kubernetes.io/docs/concepts/architecture/garbage-collection/#foreground-deletion

          for how the garbage collector interacts with this field and enforces the foreground deletion.

          Defaults to false.

          To set this field, a user needs "delete" permission of the owner,

          otherwise 422 (Unprocessable Entity) will be returned.

          +optional'
        type: boolean
      controller:
        description: 'If true, this reference points to the managing controller.

          +optional'
        type: boolean
      kind:
        description: 'Kind of the referent.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
        type: string
      name:
        description: 'Name of the referent.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#names'
        type: string
      uid:
        description: 'UID of the referent.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names#uids'
        type: string
    type: object
  v1.Probe:
    properties:
      exec:
        allOf:
        - $ref: '#/definitions/v1.ExecAction'
        description: 'Exec specifies a command to execute in the container.

          +optional'
      failureThreshold:
        description: 'Minimum consecutive failures for the probe to be considered failed after having succeeded.

          Defaults to 3. Minimum value is 1.

          +optional'
        type: integer
      grpc:
        allOf:
        - $ref: '#/definitions/v1.GRPCAction'
        description: 'GRPC specifies a GRPC HealthCheckRequest.

          +optional'
      httpGet:
        allOf:
        - $ref: '#/definitions/v1.HTTPGetAction'
        description: 'HTTPGet specifies an HTTP GET request to perform.

          +optional'
      initialDelaySeconds:
        description: 'Number of seconds after the container has started before liveness probes are initiated.

          More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

          +optional'
        type: integer
      periodSeconds:
        description: 'How often (in seconds) to perform the probe.

          Default to 10 seconds. Minimum value is 1.

          +optional'
        type: integer
      successThreshold:
        description: 'Minimum consecutive successes for the probe to be considered successful after having failed.

          Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1.

          +optional'
        type: integer
      tcpSocket:
        allOf:
        - $ref: '#/definitions/v1.TCPSocketAction'
        description: 'TCPSocket specifies a connection to a TCP port.

          +optional'
      terminationGracePeriodSeconds:
        description: 'Optional duration in seconds the pod needs to terminate gracefully upon probe failure.

          The grace period is the duration in seconds after the processes running in the pod are sent

          a termination signal and the time when the processes are forcibly halted with a kill signal.

          Set this value longer than the expected cleanup time for your process.

          If this value is nil, the pod''s terminationGracePeriodSeconds will be used. Otherwise, this

          value overrides the value provided by the pod spec.

          Value must be non-negative integer. The value zero indicates stop immediately via

          the kill signal (no opportunity to shut down).

          This is a beta field and requires enabling ProbeTerminationGracePeriod feature gate.

          Minimum value is 1. spec.terminationGracePeriodSeconds is used if unset.

          +optional'
        type: integer
      timeoutSeconds:
        description: 'Number of seconds after which the probe times out.

          Defaults to 1 second. Minimum value is 1.

          More info: https://kubernetes.io/docs/concepts/workloads/pods/pod-lifecycle#container-probes

          +optional'
        type: integer
    type: object
  kubernetes.K8sIngressTLS:
    properties:
      Hosts:
        items:
          type: string
        type: array
      SecretName:
        type: string
    type: object
  kubernetes.K8sClusterRole:
    properties:
      creationDate:
        type: string
      isSystem:
        type: boolean
      name:
        type: string
      uid:
        type: string
    type: object
  v1.ResourceQuotaSpec:
    properties:
      hard:
        allOf:
        - $ref: '#/definitions/v1.ResourceList'
        description: 'hard is the set of desired hard limits for each named resource.

          More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

          +optional'
      scopeSelector:
        allOf:
        - $ref: '#/definitions/v1.ScopeSelector'
        description: 'scopeSelector is also a collection of filters like scopes that must match each object tracked by a quota

          but expressed using ScopeSelectorOperator in combination with possible values.

          For a resource to match, both scopes AND scopeSelector (if specified in spec), must be matched.

          +optional'
      scopes:
        description: 'A collection of filters that must match each object tracked by a quota.

          If not specified, the quota matches all objects.

          +optional

          +listType=atomic'
        items:
          $ref: '#/definitions/v1.ResourceQuotaScope'
        type: array
    type: object
  kubernetes.K8sJob:
    properties:
      BackoffLimit:
        type: integer
      Command:
        type: string
      Completions:
        type: integer
      Container:
        $ref: '#/definitions/v1.Container'
      Duration:
        type: string
      FailedReason:
        type: string
      FinishTime:
        type: string
      Id:
        type: string
      IsSystem:
        type: boolean
      Name:
        type: string
      Namespace:
        type: string
      PodName:
        type: string
      StartTime:
        type: string
      Status:
        type: string
    type: object
  v1.SeccompProfile:
    properties:
      localhostProfile:
        description: 'localhostProfile indicates a profile defined in a file on the node should be used.

          The profile must be preconfigured on the node to work.

          Must be a descending path, relative to the kubelet''s configured seccomp profile location.

          Must be set if type is "Localhost". Must NOT be set for any other type.

          +optional'
        type: string
      type:
        allOf:
        - $ref: '#/definitions/v1.SeccompProfileType'
        description: 'type indicates which kind of seccomp profile will be applied.

          Valid options are:


          Localhost - a profile defined in a file on the node should be used.

          RuntimeDefault - the container runtime default profile should be used.

          Unconfined - no profile should be applied.

          +unionDiscriminator'
    type: object
  kubernetes.describeResourceResponse:
    properties:
      describe:
        type: string
    type: object
  v1.RoleRef:
    properties:
      apiGroup:
        description: APIGroup is the group for the resource being referenced
        type: string
      kind:
        description: Kind is the type of resource being referenced
        type: string
      name:
        description: 'Name is the name of resource being referenced

          +required

          +k8s:required'
        type: string
    type: object
  kubernetes.K8sIngressInfo:
    properties:
      Annotations:
        additionalProperties:
          type: string
        type: object
      ClassName:
        type: string
      CreationDate:
        type: string
      Hosts:
        items:
          type: string
        type: array
      Labels:
        additionalProperties:
          type: string
        type: object
      Name:
        type: string
      Namespace:
        type: string
      Paths:
        items:
          $ref: '#/definitions/kubernetes.K8sIngressPath'
        type: array
      TLS:
        items:
          $ref: '#/definitions/kubernetes.K8sIngressTLS'
        type: array
      Type:
        type: string
      UID:
        type: string
    type: object
  v1.ContainerResizePolicy:
    properties:
      resourceName:
        allOf:
        - $ref: '#/definitions/v1.ResourceName'
        description: 'Name of the resource to which this resource resize policy applies.

          Supported values: cpu, memory.'
      restartPolicy:
        allOf:
        - $ref: '#/definitions/v1.ResourceResizeRestartPolicy'
        description: 'Restart policy to apply when specified resource is resized.

          If not specified, it defaults to NotRequired.'
    type: object
  kubernetes.K8sVolumeInfo:
    properties:
      persistentVolume:
        $ref: '#/definitions/kubernetes.K8sPersistentVolume'
      persistentVolumeClaim:
        $ref: '#/definitions/kubernetes.K8sPersistentVolumeClaim'
      storageClass:
        $ref: '#/definitions/kubernetes.K8sStorageClass'
    type: object
  kubernetes.K8sConfigMap:
    properties:
      Annotations:
        additionalProperties:
          type: string
        type: object
      ConfigurationOwner:
        type: string
      ConfigurationOwnerId:
        type: string
      ConfigurationOwners:
        items:
          $ref: '#/definitions/kubernetes.K8sConfigurationOwnerResource'
        type: array
      CreationDate:
        type: string
      Data:
        additionalProperties:
          type: string
        type: object
      IsUsed:
        type: boolean
      Labels:
        additionalProperties:
          type: string
        type: object
      Name:
        type: string
      Namespace:
        type: string
      UID:
        type: string
    type: object
  k8s_io_api_rbac_v1.Subject:
    properties:
      apiGroup:
        description: 'APIGroup holds the API group of the referenced subject.

          Defaults to "" for ServiceAccount subjects.

          Defaults to "rbac.authorization.k8s.io" for User and Group subjects.

          +optional'
        type: string
      kind:
        description: 'Kind of object being referenced. Values defined by this API group are "User", "Group", and "ServiceAccount".

          If the Authorizer does not recognized the kind value, the Authorizer should report an error.'
        type: string
      name:
        description: 'Name of the object being referenced.

          +required

          +k8s:required'
        type: string
      namespace:
        description: 'Namespace of the referenced object.  If the object kind is non-namespace, such as "User" or "Group", and this value is not empty

          the Authorizer should report an error.

          +optional'
        type: string
    type: object
  v1.GRPCAction:
    properties:
      port:
        description: Port number of the gRPC service. Number must be in the range 1 to 65535.
        type: integer
      service:
        description: 'Service is the name of the service to place in the gRPC HealthCheckRequest

          (see https://github.com/grpc/grpc/blob/master/doc/health-checking.md).


          If this is not specified, the default behavior is defined by gRPC.

          +optional

          +default=""'
        type: string
    type: object
  kubernetes.K8sServiceIngress:
    properties:
      Hostname:
        type: string
      IP:
        type: string
    type: object
  kubernetes.K8sJobDeleteRequests:
    additionalProperties:
      items:
        type: string
      type: array
    type: object
  v1.FileKeySelector:
    properties:
      key:
        description: 'The key within the env file. An invalid key will prevent the pod from starting.

          The keys defined within a source may consist of any printable ASCII characters except ''=''.

          During Alpha stage of the EnvFiles feature gate, the key size is limited to 128 characters.

          +required'
        type: string
      optional:
        description: 'Specify whether the file or its key must be defined. If the file or key

          does not exist, then the env var is not published.

          If optional is set to true and the specified key does not exist,

          the environment variable will not be set in the Pod''s containers.


          If optional is set to false and the specified key does not exist,

          an error will be returned during Pod creation.

          +optional

          +default=false'
        type: boolean
      path:
        description: 'The path within the volume from which to select the file.

          Must be relative and may not contain the ''..'' path or start with ''..''.

          +required'
        type: string
      volumeName:
        description: 'The name of the volume mount containing the env file.

          +required'
        type: string
    type: object
  v1.RecursiveReadOnlyMode:
    enum:
    - Disabled
    - IfPossible
    - Enabled
    type: string
    x-enum-varnames:
    - RecursiveReadOnlyDisabled
    - RecursiveReadOnlyIfPossible
    - RecursiveReadOnlyEnabled
  v1.SecretKeySelector:
    properties:
      key:
        description: The key of the secret to select from.  Must be a valid secret key.
        type: string
      name:
        description: 'Name of the referent.

          This field is effectively required, but due to backwards compatibility is

          allowed to be empty. Instances of this type with an empty value here are

          almost certainly wrong.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

          +optional

          +default=""

          +kubebuilder:default=""

          TODO: Drop `kubebuilder:default` when controller-gen doesn''t need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.'
        type: string
      optional:
        description: 'Specify whether the Secret or its key must be defined

          +optional'
        type: boolean
    type: object
  kubernetes.K8sDashboard:
    properties:
      applicationsCount:
        type: integer
      configMapsCount:
        type: integer
      ingressesCount:
        type: integer
      namespacesCount:
        type: integer
      secretsCount:
        type: integer
      servicesCount:
        type: integer
      volumesCount:
        type: integer
    type: object
  v1.HTTPGetAction:
    properties:
      host:
        description: 'Host name to connect to, defaults to the pod IP. You probably want to set

          "Host" in httpHeaders instead.

          +optional'
        type: string
      httpHeaders:
        description: 'Custom headers to set in the request. HTTP allows repeated headers.

          +optional

          +listType=atomic'
        items:
          $ref: '#/definitions/v1.HTTPHeader'
        type: array
      path:
        description: 'Path to access on the HTTP server.

          +optional'
        type: string
      port:
        allOf:
        - $ref: '#/definitions/intstr.IntOrString'
        description: 'Name or number of the port to access on the container.

          Number must be in the range 1 to 65535.

          Name must be an IANA_SVC_NAME.'
      scheme:
        allOf:
        - $ref: '#/definitions/v1.URIScheme'
        description: 'Scheme to use for connecting to the host.

          Defaults to HTTP.

          +optional'
    type: object
  v1.Lifecycle:
    properties:
      postStart:
        allOf:
        - $ref: '#/definitions/v1.LifecycleHandler'
        description: 'PostStart is called immediately after a container is created. If the handler fails,

          the container is terminated and restarted according to its restart policy.

          Other management of the container blocks until the hook completes.

          More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

          +optional'
      preStop:
        allOf:
        - $ref: '#/definitions/v1.LifecycleHandler'
        description: 'PreStop is called immediately before a container is terminated due to an

          API request or management event such as liveness/startup probe failure,

          preemption, resource contention, etc. The handler is not called if the

          container crashes or exits. The Pod''s termination grace period countdown begins before the

          PreStop hook is executed. Regardless of the outcome of the handler, the

          container will eventually terminate within the Pod''s termination grace

          period (unless delayed by finalizers). Other management of the container blocks until the hook completes

          or until the termination grace period is reached.

          More info: https://kubernetes.io/docs/concepts/containers/container-lifecycle-hooks/#container-hooks

          +optional'
      stopSignal:
        allOf:
        - $ref: '#/definitions/v1.Signal'
        description: 'StopSignal defines which signal will be sent to a container when it is being stopped.

          If not specified, the default is defined by the container runtime in use.

          StopSignal can only be set for Pods with a non-empty .spec.os.name

          +optional'
    type: object
  v1.ResourceQuotaStatus:
    properties:
      hard:
        allOf:
        - $ref: '#/definitions/v1.ResourceList'
        description: 'Hard is the set of enforced hard limits for each named resource.

          More info: https://kubernetes.io/docs/concepts/policy/resource-quotas/

          +optional'
      used:
        allOf:
        - $ref: '#/definitions/v1.ResourceList'
        description: 'Used is the current observed total usage of the resource in the namespace.

          +optional'
    type: object
  kubernetes.K8sRoleDeleteRequests:
    additionalProperties:
      items:
        type: string
      type: array
    type: object
  v1.ConfigMapEnvSource:
    properties:
      name:
        description: 'Name of the referent.

          This field is effectively required, but due to backwards compatibility is

          allowed to be empty. Instances of this type with an empty value here are

          almost certainly wrong.

          More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names

          +optional

          +default=""

          +kubebuilder:default=""

          TODO: Drop `kubebuilder:default` when controller-gen doesn''t need it https://github.com/kubernetes-sigs/kubebuilder/issues/3896.'
        type: string
      optional:
        description: 'Specify whether the ConfigMap must be defined

          +optional'
        type: boolean
    type: object
  v1.SELinuxOptions:
    properties:
      level:
        description: 'Level is SELinux level label that applies to the container.

          +optional'
        type: string
      role:
        description: 'Role is a SELinux role label that applies to the container.

          +optional'
        type: string
      type:
        description: 'Type is a SELinux type label that applies to the container.

          +optional'
        type: string
      user:
        description: 'User is a SELinux user label that applies to the container.

          +optional'
        type: string
    type: object
  v1.ContainerRestartPolicy:
    enum:
    - Always
    - Never
    - OnFailure
    type: string
    x-enum-varnames:
    - ContainerRestartPolicyAlways
    - ContainerRestartPolicyNever
    - ContainerRestartPolicyOnFailure
  v1.NamespacePhase:
    enum:
    - Active
    - Terminating
    type: string
    x-enum-varnames:
    - NamespaceActive
    - NamespaceTerminating
  kubernetes.K8sIngressPath:
    properties:
      HasService:
        type: boolean
      Host:
        type: string
      IngressName:
        type: string
      Path:
        type: string
      PathType:
        type: string
      Port:
        type: integer
      ServiceName:
        type: string
    type: object
  v1.ContainerRestartRuleOnExitCodesOperator:
    enum:
    - In
    - NotIn
    type: string
    x-enum-varnames:
    - ContainerRestartRuleOnExitCodesOpIn
    - ContainerRestartRuleOnExitCodesOpNotIn
  v1.SeccompProfileType:
    enum:
    - Unconfined
    - RuntimeDefault
    - Localhost
    type: string
    x-enum-varnames:
    - SeccompProfileTypeUnconfined
    - SeccompProfileTypeRuntimeDefault
    - SeccompProfileTypeLocalhost
  kubernetes.K8sCronJob:
    properties:
      Command:
        type: string
      Id:
        type: string
      IsSystem:
        type: boolean
      Jobs:
        items:
          $ref: '#/definitions/kubernetes.K8sJob'
        type: array
      Name:
        type: string
      Namespace:
        type: string
      Schedule:
        type: string
      Suspend:
        type: boolean
      Timezone:
        type: string
    type: object
  v1.ExecAction:
    properties:
      command:
        description: 'Command is the command line to execute inside the container, the working directory for the

          command  is root (''/'') in the container''s filesystem. The command is simply exec''d, it is

          not run inside a shell, so traditional shell instructions (''|'', etc) won''t work. To use

          a shell, you need to explicitly call out to that shell.

          Exit status of 0 is treated as live/healthy and non-zero is unhealthy.

          +optional

          +listType=atomic'
        items:
          type: string
        type: array
    type: object
  kubernetes.K8sServiceAccount:
    properties:
      creationDate:
        type: string
      isSystem:
        type: boolean
      name:
        type: string
      namespace:
        type: string
      uid:
        type: string
    type: object
  v1.Capabilities:
    properties:
      add:
        description: 'Added capabilities

          +optional

          +listType=atomic'
        items:
          type: string
        type: array
      drop:
        description: 'Removed capabilities

          +optional

          +listType=atomic'
        items:
          type: string
        type: array
    type: object
  kubernetes.K8sServiceInfo:
    properties:
      AllocateLoadBalancerNodePorts:
        type: boolean
      Annotations:
        additionalProperties:
          type: string
        type: object
      Applications:
        description: serviceList screen
        items:
          $ref: '#/definitions/kubernetes.K8sApplication'
        type: array
      ClusterIPs:
        items:
          type: string
        type: array
      CreationDate:
        type: string
      ExternalIPs:
        items:
          type: string
        type: array
      ExternalName:
        type: string
      IngressStatus:
        items:
          $ref: '#/definitions/kubernetes.K8sServiceIngress'
        type: array
      Labels:
        additionalProperties:
          type: string
        type: object
      Name:
        type: string
      Namespace:
        type: string
      Ports:
        items:
          $ref: '#/definitions/kubernetes.K8sServicePort'
        type: array
      Selector:
        additionalProperties:
          type: string
        type: object
      Type:
        type: string
      UID:
        type: string
    type: object
  v1.LifecycleHandler:
    properties:
      exec:
        allOf:
        - $ref: '#/definitions/v1.ExecAction'
        description: 'Exec specifies a command to execute in the container.

          +optional'
      httpGet:
        allOf:
        - $ref: '#/definitions/v1.HTTPGetAction'
        description: 'HTTPGet specifies an HTTP GET request to perform.

          +optional'
      sleep:
        allOf:
        - $ref: '#/definitions/v1.SleepAction'
        description: 'Sleep represents a duration that the container should sleep.

          +optional'
      tcpSocket:
        allOf:
        - $ref: '#/definitions/v1.TCPSocketAction'
        description: 'Deprecated. TCPSocket is NOT supported as a LifecycleHandler and kept

          for backward compatibility. There is no validation of this field and

          lifecycle hooks will fail at runtime when it is specified.

          +optional'
    type: object
  kubernetes.CustomResourceMetadata:
    properties:
      apiVersion:
        type: string
      kind:
        type: string
      name:
        type: string
      plural:
        type: string
      scope:
        type: string
    type: object
  kubernetes.K8sServiceAccountDeleteRequests:
    additionalProperties:
      items:
        type: string
      type: array
    type: object
  v1.AppArmorProfile:
    properties:
      localhostProfile:
        description: 'localhostProfile indicates a profile loaded on the node that should be used.

          The profile must be preconfigured on the node to work.

          Must match the loaded name of the profile.

          Must be set if and only if type is "Localhost".

          +optional'
        type: string
      type:
        allOf:
        - $ref: '#/definitions/v1.AppArmorProfileType'
        description: "type indicates which kind of AppArmor profile will be applied.\nValid options are:\n  Localhost - a profile pre-loaded on the node.\n  RuntimeDefault - the container runtime's default profile.\n  Unconfined - no AppArmor enforcement.\n+unionDiscriminator"
    type: object
  kubernetes.Metadata:
    properties:
      annotations:
        additionalProperties:
          type: string
        type: object
      labels:
        additionalProperties:
          type: string
        type: object
    type: object
  v1.FieldsV1:
    type: object
  v1.URIScheme:
    enum:
    - HTTP
    - HTTPS
    type: string
    x-enum-varnames:
    - URISchemeHTTP
    - URISchemeHTTPS
  v1.ResourceRequirements:
    properties:
      claims:
        description: 'Claims lists the names of resources, defined in spec.resourceClaims,

          that are used by this container.


          This field depends on the

          DynamicResourceAllocation feature gate.


          This field is immutable. It can only be set for containers.


          +listType=map

          +listMapKey=name

          +featureGate=DynamicResourceAllocation

          +optional'
        items:
          $ref: '#/definitions/k8s_io_api_core_v1.ResourceClaim'
        type: array
      limits:
        allOf:
        - $ref: '#/definitions/v1.ResourceList'
        description: 'Limits describes the maximum amount of compute resources allowed.

          More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

          +optional'
      requests:
        allOf:
        - $ref: '#/definitions/v1.ResourceList'
        description: 'Requests describes the minimum amount of compute resources required.

          If Requests is omitted for a container, it defaults to Limits if that is explicitly specified,

          otherwise to an implementation-defined value. Requests cannot exceed Limits.

          More info: https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/

          +optional'
    type: object
  v1.ResourceQuotaScope:
    enum:
    - Terminating
    - NotTerminating
    - BestEffort
    - NotBestEffort
    - PriorityClass
    - CrossNamespacePodAffinity
    - VolumeAttributesClass
    type: string
    x-enum-varnames:
    - ResourceQuotaScopeTerminating
    - ResourceQuotaScopeNotTerminating
    - ResourceQuotaScopeBestEffort
    - ResourceQuotaScopeNotBestEffort
    - ResourceQuotaScopePriorityClass
    - ResourceQuotaScopeCrossNamespacePodAffinity
    - ResourceQuotaScopeVolumeAttributesClass
  v1beta1.PodMetricsList:
    properties:
      apiVersion:
        description: 'APIVersion defines the versioned schema of this representation of an object.

          Servers should convert recognized schemas to the latest internal value, and

          may reject unrecognized values.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

          +optional'
        type: string
      items:
        description: List of pod metrics.
        items:
          $ref: '#/definitions/v1beta1.PodMetrics'
        type: array
      kind:
        description: 'Kind is a string value representing the REST resource this object represents.

          Servers may infer this from the endpoint the client submits requests to.

          Cannot be updated.

          In CamelCase.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

          +optional'
        type: string
      metadata:
        allOf:
        - $ref: '#/definitions/v1.ListMeta'
        description: 'Standard list metadata.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds'
    type: object
  v1beta1.PodMetrics:
    properties:
      apiVersion:
        description: 'APIVersion defines the versioned schema of this representation of an object.

          Servers should convert recognized schemas to the latest internal value, and

          may reject unrecognized values.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources

          +optional'
        type: string
      containers:
        description: 'Metrics for all containers are collected within the same time window.

          +listType=atomic'
        items:
          $ref: '#/definitions/v1beta1.ContainerMetrics'
        type: array
      kind:
        description: 'Kind is a string value representing the REST resource this object represents.

          Servers may infer this from the endpoint the client submits requests to.

          Cannot be updated.

          In CamelCase.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds

          +optional'
        type: string
      metadata:
        allOf:
        - $ref: '#/definitions/v1.ObjectMeta'
        description: 'Standard object''s metadata.

          More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata

          +optional'
      timestamp:
        description: 'The following fields define time interval from which metrics were

          collected from the interval [Timestamp-Window, Timestamp].'
        type: string
      window:
        $ref: '#/definitions/v1.Duration'
    type: object
securityDefinitions:
  ApiKeyAuth:
    in: header
    name: X-API-KEY
    type: apiKey
  jwt:
    in: header
    name: Authorization
    type: apiKey