portainer/portainer-mcp

portainer/portainer-mcp

от portainer
Просматривает окружения Portainer, запускает GitOps-обновления, управляет Docker и Kubernetes. Официальный сервер от Portainer.

Portainer MCP

MCP server for Portainer, generated from the Portainer OpenAPI spec via FastMCP.

Важно

Portainer MCP is no longer the supported way to use an LLM with Portainer. That is Portainer Command, available to Portainer Business Edition customers (including the free 3-node license).

This server remains available as-is for people who want to keep using it, but it is provided without support, warranty or SLA, and is not recommended for production environments. This repository may be archived in the future.

Overview

This MCP server exposes the Portainer REST API as MCP tools: list and inspect environments, manage GitOps workflows, troubleshoot Docker and Kubernetes resources. It also supports proxying requests to the underlying Docker and K8s APIs of each environment.

Match the MCP server's minor version to your Portainer instance's minor — e.g. MCP server 2.45.x with Portainer 2.45.x. See Version compatibility for details.

Intended use

Portainer MCP is intended for evaluation, homelabs, and other non-production use. It is not supported in business, production, or any other environment where uptime, security posture, or data integrity matter. There is no SLA, no guaranteed response to issues, no further feature development, and no roadmap commitment. If you run it, you are choosing to self-support.

Часто задаваемые вопросы

Инструменты были проиндексированы:
AgentVersionsтолько чтение

Выводит список всех версий агента на основе текущих разрешений пользователя и параметров запроса. Политика доступа: restricted

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

AuthenticateUser

Политика доступа: publicИспользуйте это окружение (конечную точку) для аутентификации в Portainer с помощью имени пользователя и пароля.

Параметры
  • apiKeystringобязательный

    API-ключ

  • passwordstringобязательный

    Пароль

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • usernamestringобязательный

    Имя пользователя

containerImageStatusтолько чтение

Политика доступа

Параметры
  • containerIdintegerобязательный

    Идентификатор контейнера

  • environmentIdintegerобязательный

    Идентификатор среды

  • refreshboolean

    Обновление принудительно обновит кеш статуса изображений.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

containersImageStatusClear

Очищает кэш статуса образов для всех контейнеров в окруженииПолитика доступа:

Параметры
  • environmentIdintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

CreateKubernetesIngress

Создайте Ingress для указанного окружения.Политика доступа: Аутентифицированный пользователь.

Параметры
  • Annotationsobject
  • ClassNamestring
  • CreationDatestring
  • Hostsstring[]
  • idintegerобязательный

    Идентификатор среды

  • Labelsobject
  • Namestring
  • namespacestringобязательный

    Имя пространства имён

  • Namespacestring
  • Pathsobject[]
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • TLSobject[]
  • Typestring
  • UIDstring
CreateKubernetesNamespace

Создаёт пространство имён в указанной среде. Политика доступа: Аутентифицированный пользователь.

Параметры
  • Annotationsobject
  • idintegerобязательный

    Идентификатор среды

  • LoadBalancerQuotaobject
  • Namestring
  • Ownerstring
  • ResourceQuotaobject
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • StorageQuotasobject
CreateKubernetesService

Создаёт сервис в указанном пространстве имён Политика доступа: Аутентифицированный пользователь.

Параметры
  • AllocateLoadBalancerNodePortsboolean
  • Annotationsobject
  • Applicationsobject[]

    экран списка сервисов

  • ClusterIPsstring[]
  • CreationDatestring
  • ExternalIPsstring[]
  • ExternalNamestring
  • idintegerобязательный

    Идентификатор среды

  • IngressStatusobject[]
  • Labelsobject
  • Namestring
  • namespacestringобязательный

    Имя пространства имён

  • Namespacestring
  • Portsobject[]
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • Selectorobject
  • Typestring
  • UIDstring
DefaultRegistryUpdate

Обновляет настройки реестра по умолчанию в Portainer. Политика доступа: администратор

Параметры
  • Hideboolean
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteClusterRoleBindings

Удаляет предоставленный список cluster role bindings. Access policy: Authenticated user.

Параметры
  • bodystring[]обязательный

    Список привязок ролей кластера для удаления

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteClusterRoles

Удаляет указанный список кластерных ролей. Политика доступа: Аутентифицированный пользователь.

Параметры
  • bodystring[]обязательный

    Список кластерных ролей для удаления

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteCronJobs

Удаляет предоставленный список Cron Jobs. Политика доступа: аутентифицированный пользователь.

Параметры
  • bodyobjectобязательный

    Карта, где ключ — это namespace, а значение — массив Cron Jobs для удаления.

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteJobs

Удаляет указанный список задач.Политика доступа: Аутентифицированный пользователь.

Параметры
  • bodyobjectобязательный

    Карта, где ключ - пространство имен, а значение - массив Jobs для удаления.

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

deleteKubernetesClusterScopedCustomResource

Удаляет кластерный Custom Resource Kubernetes, к которому у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • definitionstringобязательный

    Имя CustomResourceDefinition для пользовательского ресурса, например 'clusters.postgresql.cnpg.io'

  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя пользовательского ресурса, например 'pg-cluster'

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

deleteKubernetesCustomResourceDefinition

Удаляет Kubernetes Custom Resource Definition. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя определения пользовательского ресурса для удаления.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteKubernetesIngresses

Удаляет один или несколько Ingresses в указанном окружении. Политика доступа: Аутентифицированный пользователь.

Параметры
  • bodyobjectобязательный

    Детали Ingress

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteKubernetesNamespace

Удаляет namespace Kubernetes в заданном окружении. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

deleteKubernetesNamespacedCustomResource

Удаляет namespaced Custom Resource Kubernetes, к которому у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • definitionstringобязательный

    Имя CustomResourceDefinition для пользовательского ресурса, например 'clusters.postgresql.cnpg.io'

  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя пользовательского ресурса, например 'pg-cluster'

  • namespacestringобязательный

    Имя пространства имён, из которого нужно удалить пользовательский ресурс

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteKubernetesPersistentVolumeClaims

Удаляет предоставленный список PersistentVolumeClaims. Политика доступа: Аутентифицированный пользователь.

Параметры
  • bodyobject[]обязательный

    Список PVC для удаления (namespace + name)

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteKubernetesPersistentVolumes

Удаляет предоставленный список PersistentVolumes. Политика доступа: Аутентифицированный пользователь.

Параметры
  • bodystring[]обязательный

    Список имен PV для удаления

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteKubernetesPod

Удаляет один под Kubernetes в указанном пространстве имен. Отвечающий контроллер (Deployment, StatefulSet, DaemonSet, ...) отвечает за воссоздание пода. Для голых подов под удаляется навсегда.Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namestringобязательный

    Имя пода

  • namespacestringобязательный

    Namespace

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteKubernetesServices

Удаляет предоставленный список служб. Политика доступа: Аутентифицированный пользователь.

Параметры
  • bodyobjectобязательный

    Карта, где ключ — пространство имён, а значение — массив сервисов для удаления

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteKubernetesStorageClasses

Удаляет предоставленный список StorageClasses.Access policy: Аутентифицированный пользователь.

Параметры
  • bodystring[]обязательный

    Список имен StorageClass для удаления

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteRoleBindings

Удаляет предоставленный список связываний ролей.Политика доступа: аутентифицированный пользователь.

Параметры
  • bodyobjectобязательный

    Карта, где ключ - пространство имён, а значение - массив привязок ролей для удаления

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteRoles

Удаляет предоставленный список ролей. Политика доступа: аутентифицированный пользователь.

Параметры
  • bodyobjectобязательный

    Карта, где ключ — это namespace, а значение — массив ролей для удаления.

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DeleteServiceAccounts

Удаляет предоставленный список сервисных аккаунтов. Политика доступа: Аутентифицированный пользователь.

Параметры
  • bodyobjectобязательный

    Словарь, где ключом является пространство имён, а значением — массив сервисных учётных записей для удаления.

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

DescribeResourceтолько чтение

Получает описание ресурса Kubernetes. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • kindstringобязательный

    Вид ресурса

  • namestringобязательный

    Имя ресурса

  • namespacestring

    Namespace

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

dockerContainerGpusInspectтолько чтение

Политика доступа

Параметры
  • containerIdintegerобязательный

    Идентификатор контейнера

  • environmentIdintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

dockerDashboardтолько чтение

Политика доступа: ограничена

Параметры
  • environmentIdintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

dockerImagesListтолько чтение

Политика доступа:

Параметры
  • environmentIdintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • withUsageboolean

    Включите информацию об использовании изображений.

docker_proxy

Проксирует запрос к Docker Engine API через Portainer для указанной среды. path передаётся демону Docker без изменений (например, /containers/json, /images/json, /containers/{id}/json). Передайте JMESPath select, чтобы выбрать только нужные поля — сырые ответы Docker очень объёмные. Пример для /containers/json: [].{id:Id,name:Names[0],state:State,image:Image}.

Параметры
  • bodystring | null

    Сырая строка тела запроса (например, JSON для POST)

  • environment_idintegerобязательный

    Идентификатор окружения Portainer

  • headersobject | null

    Дополнительные заголовки запроса

  • methodstring

    HTTP-метод

  • pathstringобязательный

    Путь Docker API с ведущим слэшем, например, /containers/json

  • query_paramsobject | null

    Параметры запроса

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

drainNode

Опустошает узел Kubernetes, безопасно вытесняя все поды с узла, подготавливая его к обслуживанию или удалению. Политика доступа: аутентифицированные.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namestringобязательный

    Имя узла для осушения

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EdgeStackWebhookInvoke

Политика доступа: публичная

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • webhookIDstringобязательный

    Идентификатор стека

EndpointAssociationDelete

Отвязывает периферийную среду (конечную точку).Политика доступа: администратор

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointCreate

Создаёт новое окружение (endpoint), которое будет использоваться для управления окружением (endpoint). Политика доступа: администратор

Параметры
  • AzureApplicationIDstring

    Идентификатор приложения Azure. Требуется, если тип среды (конечной точки) установлен в значение 3.

  • AzureAuthenticationKeystring

    Ключ аутентификации Azure. Требуется, если тип среды (конечная точка) установлен в 3.

  • AzureTenantIDstring

    Идентификатор клиента Azure. Обязателен, если тип среды (конечной точки) установлен в 3.

  • ContainerEnginestring

    Движок контейнеров, используемый средой (конечной точкой). Значение должно быть одним из: 'docker' или 'podman'

  • CustomTemplateContentstring

    KaaS: содержимое пользовательского шаблона для развертывания при создании окружения

  • CustomTemplateIDinteger

    KaaS: идентификатор кастомного шаблона, который развертывается при создании окружения

  • EdgeAsyncModeboolean

    Включает асинхронный режим для пограничного агента.

  • EdgeCheckinIntervalinteger

    Интервал проверки для edge-агента (в секундах)

  • EdgeCommandIntervalinteger

    Интервал команд для edge-агента (в секундах).

  • EdgePingIntervalinteger

    Интервал пинга для edge-агента (в секундах)

  • EdgeSnapshotIntervalinteger

    Интервал создания снимков для edge-агента (в секундах)

  • EdgeTunnelServerAddressstring

    URL или IP-адрес, который будет использоваться для установки обратного туннеля. Требуется, когда settings.EnableEdgeComputeFeatures имеет значение false или когда settings.Edge.TunnelServerAddress не задан.

  • EndpointCreationTypeenumобязательный

    Тип среды (Endpoint). Значение должно быть одним из: 1 (локальная среда Docker), 2 (среда агента), 3 (среда Azure), 4 (среда пограничного агента) или 5 (локальная среда Kubernetes).

  • Gpusstring

    Список GPU — JSON-сериализованный массив структур {name, value}

  • GroupIDinteger

    Идентификатор группы среды (конечной точки). Если не указано, по умолчанию будет 1 (не назначено).

  • KubeConfigstring

    Содержимое файла конфигурации Kubernetes (в кодировке base64). Требуется, когда для EndpointCreationType установлено значение 6 (KubeConfigEnvironment).

  • Namestringобязательный

    Имя, которое будет использоваться для идентификации этого окружения (конечной точки) (пример: my-environment)

  • PublicURLstring

    URL или IP-адрес, по которому будут доступны открытые контейнеры. Если не указано, по умолчанию используется URL (пример: docker.mydomain.tld:2375)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • StackNamestring

    KaaS: имя стека для развертывания пользовательского шаблона

  • TagIdsstring

    Массив идентификаторов тегов в JSON, с которыми связана эта среда (конечная точка).

  • TLSboolean

    Требуется TLS для подключения к этой среде (конечной точке). Должно быть true, если EndpointCreationType установлен в 2 (среда агента).

  • TLSCACertFilestring

    Файл сертификата ЦС TLS

  • TLSCertFilestring

    Файл клиентского сертификата TLS

  • TLSKeyFilestring

    Файл ключа клиента TLS

  • TLSSkipClientVerifyboolean

    Пропустить проверку клиента при использовании TLS. Должно быть true, если EndpointCreationType установлен в 2 (среда агента).

  • TLSSkipVerifyboolean

    Пропускать проверку сервера при использовании TLS. Обязательно true, если EndpointCreationType установлен в 2 (окружение агента).

  • URLstring

    URL или IP-адрес Docker-хоста (пример: docker.mydomain.tld:2375). По умолчанию используется локальный адрес, если не указано иное (Linux: /var/run/docker.sock, Windows: //./pipe/docker_engine). Не может быть пустым, если для EndpointCreationType задано значение 4 (среда Edge agent).

EndpointCreateGlobalKey

Создаёт или получает конечную точку для EdgeID.

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointDelete

Удаляет среду, связанную с указанным идентификатором, и опционально очищает связанные ресурсы. Политика доступа: Только администратор.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointDeleteBatch

Удаляет несколько окружений и при необходимости очищает связанные ресурсы. Политика доступа: только администратор.

Параметры
  • endpointsobject[]
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointDeleteBatchDeprecated

Устарело: используйте конечную точку POST. Удаляет несколько сред и опционально очищает связанные ресурсы.Политика доступа: только администратор.

Параметры
  • endpointsobject[]
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointDockerBrowsePut

Использует эту среду (endpoint) для загрузки TLS-файлов. Политика доступа: администратор

Параметры
  • filestringобязательный

    Файл для загрузки

  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • Pathstringобязательный

    Путь назначения для загрузки файла

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • volumeIDstring

    Необязательный идентификатор тома для загрузки файла.

endpointDockerhubStatusтолько чтение

Получает лимиты на pull для реестра Docker Hub в окружении Access policy:

Параметры
  • idintegerобязательный

    идентификатор конечной точки

  • registryIdintegerобязательный

    идентификатор реестра

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

endpointForceUpdateService

Принудительно обновляет службу Docker Политика доступа: аутентифицированный

Параметры
  • idintegerобязательный

    идентификатор конечной точки

  • PullImageboolean

    Если PullImage равно true, образ будет извлечен.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • ServiceIDstring

    ServiceId для обновления

EndpointInspectтолько чтение

Получает сведения об окружении (конечной точке). Политика доступа: ограничена.

Параметры
  • excludeSnapshotboolean

    Если true, данные снимка не будут получены.

  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointListтолько чтение

Перечисляет все окружения (конечные точки) на основе авторизации текущего пользователя. Возвращает все окружения (конечные точки), если используется учетная запись администратора или руководителя группы, в противном случае возвращает только авторизованные окружения (конечные точки).Политика доступа: restricted

Параметры
  • agentVersionsstring[]

    Вернет только среды с одной из этих версий агентов.

  • edgeAsyncboolean

    Если параметр равен true, показываются только асинхронные агенты edge; если равен false, показываются только стандартные агенты edge. Если параметр отсутствует, показываются оба типа (актуально только для агентов edge).

  • edgeCheckInPassedSecondsnumber

    Если больше нуля, показывать только те edge-агенты, которые отправляли проверки за последние указанные секунды (актуально только для edge-агентов).

  • edgeDeviceUntrustedboolean

    если true, показывать только недоверенные edge-агенты, если false, показывать только доверенные edge-агенты (актуально только для edge-агентов)

  • edgeGroupIdsinteger[]

    Перечисли окружения (эндпоинты) этих edge-групп.

  • edgeStackIdinteger

    вернёт окружения указанного краевого стека

  • edgeStackStatusenum

    Применяется только при наличии edgeStackId. Фильтрует возвращённые среды по статусу их развёртывания в стеке (не по статусу среды!)

  • endpointIdsinteger[]

    Вернет только эти окружения (эндпоинты).

  • excludeEdgeGroupIdsinteger[]

    Исключает окружения (эндпоинты) этих edge-групп.

  • excludeGroupIdsinteger[]

    Исключите среды этих групп

  • excludeIdsinteger[]

    исключит эти окружения (endpoints)

  • excludeSnapshotsboolean

    Если true, данные снимка не будут получены.

  • groupIdsinteger[]

    Не хватает контекста. Вы не указали, о каких группах идёт речь и где именно нужно искать окружения (endpoints). Уточните, пожалуйста: - Какие это группы (например, из какого API, документации или сервиса)? - Где искать окружения (endpoints): в документации, в конфигурации, в коде? Без этой информации я не смогу дать точный ответ.

  • k8sEnvAdminboolean

    Если значение истинно, в ответ будет добавлен заголовок X-K8S-Env-Admin, который указывает, является ли пользователь администратором K8S-среды для любой из возвращённых сред.

  • limitinteger

    Ограничить результаты этим значением.

  • namestring

    вернёт только среды (конечные точки) с этим именем

  • nameFilterstring

    Фильтрует окружения по частичному совпадению имени (без учёта регистра, ищет только по имени).

  • orderstring

    Упорядочить отсортированные результаты по убыванию/возрастанию

  • outdatedboolean

    Если true, возвращать только окружения с устаревшим агентом.

  • platformTypesenum[]

    Фильтровать окружения по типу платформы.

  • policyboolean

    Если true, применит данные политики к возвращённым средам (конечным точкам).

  • policyIdsinteger[]

    Перечисляет среды (конечные точки), связанные с этими политиками

  • policyStatusenum[]

    Фильтрует окружения по статусу политики (applied, failed, in_progress, warning, not_supported). Применяется только когда указан policyIds.

  • provisionedboolean

    Если true, вернет environment(endpoint), которые были предоставлены

  • searchstring

    Поисковый запрос

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • sortenum

    Сортировать результаты по этому значению

  • startinteger

    Начните поиск с

  • statusinteger[]

    Перечислить окружения (конечные точки) по этому статусу.

  • tagIdsinteger[]

    Искать окружения (эндпоинты) по этим тегам (зависит от tagsPartialMatch)

  • tagsPartialMatchboolean

    Если true, вернёт окружение(конечную точку), у которого есть один из tagIds, если false (или отсутствует) — вернёт только окружения(конечные точки), у которых есть все теги.

  • typesenum[]

    Перечисляет окружения (эндпоинты) данного типа.

  • updateInformationboolean

    Если true, в ответ будет добавлен заголовок X-Update-Available, чтобы указать, доступно ли обновление.

EndpointMTLSAgentCertificateErrorтолько чтение

Получает mTLS-сертификат среды (конечной точки). Политика доступа: администратор

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointMTLSCertificateтолько чтение

Получает mTLS-сертификат среды (endpoint).Политика доступа: администратор

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

endpointRegistriesListтолько чтение

Перечисляет все реестры на основе прав доступа текущего пользователя в текущем окружении. Политика доступа: аутентифицированный.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namespacestring

    Требуется, если среда Kubernetes, показывает реестры по пространствам имён.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

endpointRegistryAccess

Политика доступа: аутентифицированный

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • Namespacesstring[]
  • registryIdintegerобязательный

    Идентификатор реестра

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • TeamAccessPoliciesobject
  • UserAccessPoliciesobject
EndpointSetPolicyStatuses

Окружение (endpoint) для edge-агента, чтобы сообщать о статусах сверки по каждой политике. Политика доступа: доступно только для Edge-окружений (endpoints).

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • statusesobject[]
EndpointSettingsUpdate

Обновляет настройки для окружения (endpoint).Политика доступа: только для аутентифицированных

Параметры
  • changeWindowany

    Включены ли ограничения времени обновления GitOps

  • deploymentOptionsany

    Скрыть формы ручного развертывания для окружения.

  • enableGPUManagementboolean
  • enableImageNotificationboolean
  • gpusobject[]
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • securitySettingsobject

    Обновления настроек безопасности

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointSnapshot

Создаёт снимок окружения (конечной точки) Политика доступа: аутентифицированный

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointSnapshots

Создаёт снимки всех сред (конечных точек)Политика доступа: администратор

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointSummaryCountsтолько чтение

Возвращает количество окружений по статусу (работает, не работает, устаревшая) и несгруппированные окружения (не назначенные), а также разбивку по группе, типу и состоянию. Политика доступа: ограниченный.

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

EndpointUpdate

Обновляет окружение (endpoint). Политика доступа: аутентифицированный

Параметры
  • AzureApplicationIDstring

    ID приложения Azure

  • AzureAuthenticationKeystring

    Ключ аутентификации Azure

  • AzureTenantIDstring

    Идентификатор клиента Azure

  • ChangeWindowany

    Включены ли ограничения времени обновления GitOps

  • DeploymentOptionsany

    Скрыть формы ручного развертывания для окружения.

  • Edgeobject
  • EdgeCheckinIntervalinteger

    Интервал проверки для edge-агента (в секундах)

  • Gpusobject[]

    Информация о графических процессорах

  • GroupIDinteger

    Идентификатор группы

  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • IsSetStatusMessageboolean
  • Kubernetesany

    Связанные данные Kubernetes

  • Namestring

    Имя, используемое для идентификации этого окружения (конечной точки)

  • PublicURLstring

    URL или IP-адрес, по которому будут доступны опубликованные контейнеры. По умолчанию используется URL, если не указано иное.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • Statusinteger

    Статус окружения (конечной точки) (1 - работает, 2 - не работает)

  • StatusMessageobject
  • TagIDsinteger[]

    Список идентификаторов тегов, с которыми связана эта среда(конечная точка)

  • TeamAccessPoliciesobject
  • TLSboolean

    Требует TLS для подключения к этому окружению (конечной точке).

  • TLSSkipClientVerifyboolean

    Пропустить проверку клиента при использовании TLS

  • TLSSkipVerifyboolean

    Пропускает проверку сервера при использовании TLS.

  • URLstring

    URL-адрес или IP-адрес Docker-хоста

  • UserAccessPoliciesobject
EndpointUpdateRelations

Обновляет связи для списка окружений Группы граничных узлов, теги и группа окружений обновляются. Политика доступа: administrator

Параметры
  • Relationsobject
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesApplicationтолько чтение

Получает приложение по имени в определённом пространстве имён Политика доступа: аутентифицированный

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namestringобязательный

    Название приложения

  • namespacestringобязательный

    Пространство имён

  • resourceTypestring

    Тип ресурса, для которого нужно получить приложение

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesApplicationsтолько чтение

Получает список приложений во всех пространствах имён в кластере. Если указано nodeName, возвращает приложения, запущенные на этом узле. Политика доступа: authenticated

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namespacestringобязательный

    Имя пространства имён

  • nodeNamestringобязательный

    Имя узла.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

getAllKubernetesApplicationsCountтолько чтение

Получает количество приложений по всем пространствам имён в кластере. Если указан nodeName, возвращает количество приложений, запущенных на этом узле. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesClusterIngressesтолько чтение

Получает Kubernetes Ingress на уровне кластера для указанного окружения. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • withServicesboolean

    Находит сервисы, связанные с каждым ingress.

GetAllKubernetesClusterIngressesCountтолько чтение

Получает количество kubernetes ingresses в указанной среде. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesClusterRoleBindingsтолько чтение

Получает список привязок ролей кластера Kubernetes в заданном окружении на уровне кластера. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesClusterRolesтолько чтение

Получает список ролей кластера Kubernetes в указанной среде на уровне кластера. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesConfigMapsтолько чтение

Возвращает список ConfigMaps во всех namespace кластера. Для неадминистративных пользователей возвращает только те ConfigMaps, которые находятся в namespaces, к которым у них есть доступ.Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • isUsedbooleanобязательный

    Установите значение true, чтобы включить в ответ информацию о приложениях, использующих ConfigMaps.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesConfigMapsCountтолько чтение

Получает количество ConfigMaps во всех пространствах имён в кластере. Для пользователей без прав администратора возвращает только количество ConfigMaps на основе пространств имён, к которым у них есть доступ. Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

getAllKubernetesEventsтолько чтение

Получает события по параметру запроса resourceId Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • resourceIdstring

    Идентификатор ресурса задействованного объекта Kubernetes.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesIngressControllersтолько чтение

Получает список ingress-контроллеров для заданного окружения. Если установлен параметр запроса allowedOnly, будут возвращены только те ingress-контроллеры, которые разрешены конфигурацией ingress данного окружения. Политика доступа: Аутентифицированный пользователь.

Параметры
  • allowedOnlyboolean

    Возвращает только разрешённые ingress-контроллеры.

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesIngressesтолько чтение

Получает список Ingresses. Если указан namespace, возвращает список Ingresses в указанном namespace. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Имя пространства имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesPersistentVolumeClaimsтолько чтение

Получает список всех PersistentVolumeClaims в заданной среде. Ограничено пространством имен для неадминистративных пользователей. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesPersistentVolumesтолько чтение

Получает список всех PersistentVolumes в указанной среде. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesServicesCountтолько чтение

Получает количество сервисов, к которым у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesStorageClassesтолько чтение

Получает список всех StorageClasses в заданной среде. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetAllKubernetesVolumesтолько чтение

Получает список всех томов Kubernetes в указанной среде (Endpoint). Идентификатор Endpoint должен быть действительным идентификатором среды Portainer. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • withApplicationsboolean

    Если установлено значение True, включаются приложения, использующие тома. По умолчанию установлено значение false.

getAllKubernetesVolumesCountтолько чтение

Получает общее количество томов Kubernetes в заданной среде (Endpoint). Общее количество зависит от роли и разрешений пользователя. Идентификатор Endpoint должен быть допустимым идентификатором среды Portainer. Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetApplicationsResourcesтолько чтение

Получает суммарные запросы и лимиты CPU (ядер) и памяти (байт) всех приложений во всех пространствах имён.Политика доступа: аутентифицирован

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • nodestringобязательный

    Имя узла.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

get_guidanceтолько чтение

Руководство по эксплуатации этого сервера Portainer MCP: проецирование ответов с помощью select, где находятся тяжелые поля, результаты, которые легко неверно истолковать (например: здоровье среды Edge определяется по его heartbeat, а не по полю Status; типизированные инструменты K8s используют другие имена полей, чем сырой прокси), и как безопасно развертывать/масштабировать/удалять. Вызовите его один раз в начале любой задачи Portainer, прежде чем интерпретировать ответы или планировать многошаговые изменения. Это существенно повышает корректность и экономит контекст.

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

getKubernetesAllCustomResourcesтолько чтение

Получает список пользовательских ресурсов Kubernetes, к которым у пользователя есть доступ. Политика доступа: аутентифицированный пользователь.

Параметры
  • definitionstringобязательный

    Имя CustomResourceDefinition для пользовательского ресурса, например 'clusters.postgresql.cnpg.io'

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

getKubernetesClusterScopedCustomResourceтолько чтение

Получает кластерный Custom Resource Kubernetes, к которому у пользователя есть доступ.Политика доступа: аутентифицированный пользователь.

Параметры
  • definitionstringобязательный

    Имя CustomResourceDefinition для пользовательского ресурса, например 'clusters.postgresql.cnpg.io'

  • formatstring

    Формат пользовательского ресурса, например 'yaml' или 'json'

  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя пользовательского ресурса, например 'pg-cluster'

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesConfigMapтолько чтение

Получает ConfigMap по имени для заданного namespace.Политика доступа: Аутентифицированный пользователь.

Параметры
  • configmapstringобязательный

    Имя configmap, для которого нужно получить детали.

  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Имя namespace, в котором находится configmap

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesCronJobsтолько чтение

Получает список Kubernetes Cron Jobs, к которым у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

getKubernetesCustomResourceDefinitionтолько чтение

Получает Custom Resource Definition в Kubernetes.Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя определения пользовательского ресурса, которое нужно получить.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

getKubernetesCustomResourceDefinitionsтолько чтение

Получает список определений пользовательских ресурсов Kubernetes, к которым у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesDashboardтолько чтение

Получает сводные данные панели мониторинга, которые содержат просто подсчет диапазона различных часто используемых ресурсов Kubernetes. Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды (конечной точки)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

getKubernetesEventsForNamespaceтолько чтение

Получает события по необязательному параметру запроса resourceId для заданного пространства имён. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Имя пространства имён, с которым связаны события.

  • resourceIdstring

    Идентификатор ресурса задействованного объекта Kubernetes.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesIngressтолько чтение

Получает Ingress по имени для указанного окружения. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • ingressstringобязательный

    Имя Ingress

  • namespacestringобязательный

    Имя пространства имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesIngressControllersByNamespaceтолько чтение

Получает список ingress-контроллеров для указанной среды в заданном пространстве имён.Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Namespace

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesJobsтолько чтение

Получает список Kubernetes Jobs, к которым у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • includeCronJobChildrenboolean

    Включать ли Jobs, у которых есть владелец cronjob

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesMaxResourceLimitsтолько чтение

Получает максимальные лимиты CPU и памяти (неиспользуемые ресурсы) всех узлов в кластере k8s. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesMetricsForAllNodesтолько чтение

Получает список метрик, связанных со всеми узлами кластера. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesMetricsForAllPodsтолько чтение

Получает список подов с их текущими метриками для указанного пространства имён. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Namespace

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesMetricsForNodeтолько чтение

Получает актуальные метрики для указанного узла. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Идентификатор узла

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesMetricsForPodтолько чтение

Получает живые метрики для указанного пода. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Идентификатор Pod

  • namespacestringобязательный

    Namespace

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesNamespaceтолько чтение

Получает сведения о неймспейсе для указанного неймспейса в заданном окружении. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Имя пространства имен, для которого нужно получить сведения.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • withResourceQuotabooleanобязательный

    При значении true включает информацию о квотах ресурсов как часть информации о Namespace. Значение по умолчанию: false.

getKubernetesNamespacedCustomResourceтолько чтение

Получает список Custom Resources Kubernetes, к которым у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • definitionstringобязательный

    Имя CustomResourceDefinition для пользовательского ресурса, например 'clusters.postgresql.cnpg.io'

  • formatstring

    Формат пользовательского ресурса, например 'yaml' или 'json'

  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя пользовательского ресурса, например 'pg-cluster'

  • namespacestringобязательный

    Имя пространства имен, для которого нужно получить сведения.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesNamespacesтолько чтение

Получает список всех пространств имён в заданной среде на основе роли пользователя и его разрешений. Если пользователь — администратор, ему доступны все пространства имён. Если пользователь не администратор, ему доступны только те пространства имён, к которым у него есть доступ. Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • withResourceQuotabooleanобязательный

    При значении true включает информацию о квотах ресурсов как часть информации о Namespace. Значение по умолчанию: false.

  • withUnhealthyEventsbooleanобязательный

    Если задано значение true, информация о событиях сбоев включается в состав информации Namespace. По умолчанию false.

GetKubernetesNamespacesCountтолько чтение

Получает общее количество пространств имён kubernetes в заданном окружении, включая системные пространства имён. Общее количество зависит от роли и разрешений пользователя.Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesNodesтолько чтение

Возвращает список узлов Kubernetes для выбранной среды. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesNodesLimitsтолько чтение

Получает ограничения CPU и памяти всех узлов в кластере k8s. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesPersistentVolumeтолько чтение

Получает PersistentVolume по имени в указанной среде. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    имя PersistentVolume

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesPersistentVolumeClaimтолько чтение

Получает PersistentVolumeClaim по имени в пространстве имён. Политика доступа: Authenticated user.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя PVC

  • namespacestringобязательный

    Имя пространства имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesPersistentVolumeClaimsInNamespaceтолько чтение

Получает список PersistentVolumeClaims в указанном namespace. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Имя пространства имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

getKubernetesPodSecurityRuleтолько чтение

Получает правило безопасности Pod внутри кластера k8s. Политика доступа: аутентифицирован

Параметры
  • environmentIdintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesRBACStatusтолько чтение

Проверяет, включен ли RBAC в указанном кластере Kubernetes. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesRoleBindingsтолько чтение

Получает список привязок ролей Kubernetes, к которым у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesRolesтолько чтение

Получает список ролей Kubernetes, к которым у пользователя есть доступ. Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesSecretтолько чтение

Получает секрет по имени для заданного пространства имён. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Имя namespace, в котором находится secret

  • secretstringобязательный

    Имя секрета, для которого нужно получить сведения.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesSecretsтолько чтение

Получает список Secrets для заданного namespace. Если isUsed установлен в true, также возвращается информация о приложениях, использующих эти Secrets. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • isUsedbooleanобязательный

    Если установлено в true, свяжите Secrets с приложениями, которые их используют.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesSecretsCountтолько чтение

Получает количество Secrets во всех пространствах имен, к которым у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesServiceAccountтолько чтение

Получает учётную запись kubernetes в заданном namespace. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя сервисного аккаунта

  • namespacestringобязательный

    Namespace

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesServiceAccountsтолько чтение

Получает список сервисных аккаунтов Kubernetes, к которым у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesServicesтолько чтение

Получает список сервисов, к которым у пользователя есть доступ. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • withApplicationsboolean

    Находит приложения, связанные с каждым сервисом

GetKubernetesServicesByNamespaceтолько чтение

Получает список сервисов для указанного пространства имён. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Имя пространства имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesStorageClassтолько чтение

Получает StorageClass по имени в указанном окружении.Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя StorageClass

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesVersionтолько чтение

Получает версию кластера Kubernetes (major, minor, gitVersion, …) по данным API обнаружения кластера, дополненную флагами возможностей, которые Portainer использует для управления функциями интерфейса (например, supportsPodRestart). Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GetKubernetesVolumeтолько чтение

Получает том Kubernetes в указанной среде (Endpoint). Endpoint ID должен быть допустимым идентификатором среды Portainer. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Идентификатор пространства имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • volumestringобязательный

    Имя тома

GetKubernetesVolumesInNamespaceтолько чтение

Получает список томов Kubernetes в указанном пространстве имён (namespace) в заданной среде (Endpoint). Идентификатор Endpoint должен быть допустимым идентификатором среды Portainer. Политика доступа: Аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Идентификатор пространства имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • withApplicationsboolean

    Если установлено значение True, включаются приложения, использующие тома. По умолчанию установлено значение false.

GitOperationRepoFilePreview

Извлекает содержимое файла compose на основе конфигурации git-репозиторияПолитика доступа: только для аутентифицированных

Параметры
  • authorizationTypeany

    Устарело: используйте SourceID вместо этого.

  • createdFromCustomTemplateIDinteger

    CreatedFromCustomTemplateID получает авторизацию из git-настроек этого пользовательского шаблона

  • fromEdgeStackboolean
  • passwordstring

    Устарело: используйте SourceID вместо этого.

  • providerany

    Устарело: используйте SourceID вместо этого.

  • referencestring
  • repositorystring

    Устарело: используйте SourceID вместо этого.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • sourceIdinteger

    SourceID извлекает URL и данные авторизации из сохранённой записи источника.

  • stackIdinteger

    StackID будет получать аутентификацию из git-настроек этого стека (edge stack, если FromEdgeStack равно true).

  • targetFilestring

    Путь к файлу, содержимое которого будет прочитано.

  • TLSSkipVerifyboolean

    TLSSkipVerify пропускает проверку SSL при клонировании Git-репозитория Устарел: используйте SourceID вместо него

  • usernamestring

    Устарело: используйте SourceID вместо этого.

GitOperationRepoFilesSearch

Ищет путь к файлу в git-репозитории по частичному или полному имени файла Политика доступа: аутентифицированный пользователь

Параметры
  • authorizationTypeany

    Устарело: используйте SourceID вместо этого.

  • createdFromCustomTemplateIDinteger

    CreatedFromCustomTemplateID получает авторизацию из git-настроек этого пользовательского шаблона

  • dirOnlyboolean

    Перечислить только директории.

  • forceboolean

    Перечисли результаты без использования кэша.

  • fromEdgeStackboolean
  • includestring

    Позволяет указать конкретное расширение файла в качестве результата поиска. Если поле пустое, по умолчанию будут установлены расширения yml, yaml, hcl, json.

  • keywordstring

    Частичное или полное имя файла. Если поле пустое, будут возвращены все имена файлов с включёнными расширениями.

  • passwordstring

    Устарело: используйте SourceID вместо этого.

  • providerany

    Устарело: используйте SourceID вместо этого.

  • referencestring

    Конкретная ссылка на Git-репозиторий. Если поле пустое, по умолчанию будет установлена ссылка ref/heads/main.

  • repositorystring

    Устарело: используйте SourceID вместо этого.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • sourceIdinteger

    SourceID извлекает URL и данные авторизации из сохранённой записи источника.

  • stackIdinteger

    StackID будет получать аутентификацию из git-настроек этого стека (edge stack, если FromEdgeStack равно true).

  • TLSSkipVerifyboolean

    TLSSkipVerify пропускает проверку SSL при клонировании Git-репозитория Устарел: используйте SourceID вместо него

  • usernamestring

    Устарело: используйте SourceID вместо этого.

GitOperationRepoHelmValues

Загружает и объединяет несколько файлов значений Helm из Git-репозитория, имитируя поведение CLI Helm Политика доступа: аутентифицированный

Параметры
  • authorizationTypeany

    Устарело: используйте SourceID вместо этого.

  • createdFromCustomTemplateIDinteger

    CreatedFromCustomTemplateID получает авторизацию из git-настроек этого пользовательского шаблона

  • fromEdgeStackboolean
  • passwordstring

    Устарело: используйте SourceID вместо этого.

  • providerany

    Устарело: используйте SourceID вместо этого.

  • referencestring
  • repositorystring

    Устарело: используйте SourceID вместо этого.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • sourceIdinteger

    SourceID извлекает URL и данные авторизации из сохранённой записи источника.

  • stackIdinteger

    StackID будет получать аутентификацию из git-настроек этого стека (edge stack, если FromEdgeStack равно true).

  • TLSSkipVerifyboolean

    TLSSkipVerify пропускает проверку SSL при клонировании Git-репозитория Устарел: используйте SourceID вместо него

  • usernamestring

    Устарело: используйте SourceID вместо этого.

  • valuesFilesstring[]обязательный

    ValuesFiles: массив путей к файлам значений Helm (соответствует Stack.HelmValuesFiles)

GitOperationRepoRefs

Перечисляет все ссылки git-репозитория Возвращает все ссылки git-репозитория Политика доступа: аутентифицированный

Параметры
  • authorizationTypeany

    Устарело: используйте SourceID вместо этого.

  • createdFromCustomTemplateIDinteger

    CreatedFromCustomTemplateID получает авторизацию из git-настроек этого пользовательского шаблона

  • forceboolean

    Перечисли результаты без использования кэша.

  • fromEdgeStackboolean
  • passwordstring

    Устарело: используйте SourceID вместо этого.

  • providerany

    Устарело: используйте SourceID вместо этого.

  • repositorystring

    Устарело: используйте SourceID вместо этого.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • sourceIdinteger

    SourceID извлекает URL и данные авторизации из сохранённой записи источника.

  • stackIdinteger

    StackID будет получать аутентификацию из git-настроек этого стека (edge stack, если FromEdgeStack равно true).

  • TLSSkipVerifyboolean

    TLSSkipVerify пропускает проверку SSL при клонировании Git-репозитория Устарел: используйте SourceID вместо него

  • usernamestring

    Устарело: используйте SourceID вместо этого.

GitOpsSourceGetтолько чтение

Возвращает один источник GitOps с его настройками подключения и связанными рабочими процессами. Политика доступа: аутентифицированные

Параметры
  • idintegerобязательный

    Идентификатор источника

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GitOpsSourcesCreateGit

Создаёт новый источник GitOps на основе Git-репозитория. Политика доступа: аутентифицированный

Параметры
  • administratorsOnlyboolean
  • authenticationobject
  • namestring
  • publicboolean
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • teamAccessesinteger[]
  • tlsSkipVerifyboolean
  • urlstringобязательный
  • userAccessesinteger[]
GitOpsSourcesDelete

Удаляет существующий источник GitOps. Возвращает 409, если источник используется в каком-либо workflow или пользовательском шаблоне. Политика доступа: аутентифицированный

Параметры
  • idintegerобязательный

    Идентификатор источника

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GitOpsSourcesListтолько чтение

Возвращает дедуплицированный список git-репозиториев, используемых во всех GitOps-рабочих процессах. Политика доступа: аутентифицированные

Параметры
  • limitinteger

    Ограничение количества страниц (0 = без ограничений)

  • orderstring

    Порядок сортировки: asc или desc

  • searchstring

    Поисковый запрос (совпадает с URL)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • sortstring

    Поле сортировки: имя | статус | тип

  • startinteger

    Индекс начала пагинации

  • statusstring

    Фильтр по статусу: healthy | syncing | error | paused | unknown

  • typeenum

    Фильтровать по типу источника: git | oci | helm

GitOpsSourcesSummaryтолько чтение

Возвращает количество источников по статусу. Политика доступа: аутентифицирован

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

GitOpsSourcesTest

Проверяет подключение для ещё не сохранённых реквизитов Git-соединения. Политика доступа: аутентифицированный

Параметры
  • administratorsOnlyboolean
  • authenticationobject
  • namestring
  • publicboolean
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • teamAccessesinteger[]
  • tlsSkipVerifyboolean
  • urlstringобязательный
  • userAccessesinteger[]
GitOpsSourcesTestById

Проверяет подключение для источника GitOps, применяя необязательные переопределения к сохранённой конфигурации. Политика доступа: аутентифицированный

Параметры
  • authenticationobject
  • idintegerобязательный

    Идентификатор источника

  • namestring
  • referenceNamestring
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • tlsSkipVerifyboolean
  • urlstring
GitOpsSourcesUpdateAccess

Обновляет настройки контроля доступа для существующего источника GitOps. Access policy: administrator

Параметры
  • idintegerобязательный

    Идентификатор источника

  • publicboolean
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • teamsinteger[]
  • usersinteger[]
GitOpsSourcesUpdateGit

Обновляет существующий GitOps-источник на базе Git-репозитория. Политика доступа: аутентифицированный

Параметры
  • authenticationobject
  • idintegerобязательный

    Идентификатор источника

  • namestring
  • referenceNamestring
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • tlsSkipVerifyboolean
  • urlstring
GitOpsWorkflowsListтолько чтение

Возвращает единый список всех стэков и граничных стэков, для которых настроен GitOps (GitConfig). Политика доступа: аутентифицирован

Параметры
  • endpointIdsinteger[]

    Фильтровать по идентификаторам окружений (например, endpointIds[]=1&endpointIds[]=2)

  • limitinteger

    Ограничение количества страниц (0 = без ограничений)

  • orderstring

    Порядок сортировки: asc или desc

  • platformstring

    Фильтр по платформе: dockerStandalone | dockerSwarm | kubernetes

  • searchstring

    Поисковый запрос (совпадает с названием или URL репозитория)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • sortstring

    Поле сортировки: имя | тип | статус | платформа | дата создания | дата последней синхронизации

  • startinteger

    Индекс начала пагинации

  • statusstring

    Фильтр по статусу: healthy | syncing | error | paused | unknown

  • typestring

    Фильтр по типу: stack | edgeStack

GitOpsWorkflowsSummaryтолько чтение

Возвращает количество рабочих процессов по статусу для рабочих процессов, доступных запрашивающему пользователю. Политика доступа: аутентифицированный

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

HelmDelete

Политика доступа: аутентифицированный

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namespacestring

    Необязательное пространство имён.

  • releasestringобязательный

    Название релиза/приложения для удаления

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

HelmGetтолько чтение

Получает сведения о релизе Helm по его имени. Политика доступа: аутентифицированный

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namespacestring

    Указывает необязательное пространство имен.

  • releasestringобязательный

    Имя релиза Helm

  • revisioninteger

    Укажите необязательную ревизию.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • showResourcesboolean

    Показывает ресурсы релиза.

HelmGetHistoryтолько чтение

Получает исторический список релизов по имени релиза Политика доступа: аутентифицированный

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namespacestring

    Указывает необязательное пространство имен.

  • releasestringобязательный

    Имя релиза Helm

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

HelmGitDryRun

Политика доступа: аутентифицированный

Параметры
  • helmChartPathstring
  • helmValuesFilesstring[]
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namestring
  • namespacestring
  • repositoryAuthenticationboolean
  • repositoryAuthorizationTypeenum
  • repositoryPasswordstring
  • repositoryProviderany
  • repositoryReferenceNamestring
  • repositoryURLstring
  • repositoryUsernamestring
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • sourceIdinteger

    SourceID извлекает URL и аутентификацию из сохранённой записи Source. Когда задан, встроенные поля Repository/auth/tls игнорируются.

  • tlsSkipVerifyboolean
HelmInstall

Политика доступа: требуется аутентификация

Параметры
  • atomicboolean
  • chartstring
  • dryRunboolean

    Пожалуйста, отправьте текст для перевода.

  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namestring
  • namespacestring
  • registryIdinteger
  • repostring
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • valuesstring
  • versionstring
HelmListтолько чтение

Политика доступа: требуется аутентификация

Параметры
  • filterstring

    Укажите необязательный фильтр.

  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namespacestring

    Указывает необязательное пространство имен.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • selectorstring

    Укажите необязательный селектор

HelmRepoSearchтолько чтение

Политика доступа: аутентификация

Параметры
  • chartstring

    Имя Helm-чарта

  • registryIdstring

    ID реестра Helm (нужен, если репозиторий не указан)

  • repostring

    URL репозитория Helm (обязателен, если registryId не указан)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • useCachestring

    Если true, поиск будет использовать кэш.

HelmRollback

Откатывает helm-релиз до предыдущей ревизии. Политика доступа: требуется аутентификация.

Параметры
  • forceboolean

    Принудительно обновляет ресурс через удаление/пересоздание при необходимости (по умолчанию: false)

  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namespacestring

    Указывает необязательное пространство имен.

  • recreateboolean

    Выполняет перезапуск подов для ресурса, если применимо (по умолчанию: true).

  • releasestringобязательный

    Имя релиза Helm

  • revisioninteger

    Укажите ревизию для отката (если не указано, будет использована предыдущая ревизия).

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • timeoutinteger

    Время ожидания для любой отдельной операции Kubernetes в секундах (по умолчанию: 300)

  • waitboolean

    ожидать готовности ресурсов (по умолчанию: false)

  • waitForJobsboolean

    Ожидает завершения заданий перед отметкой релиза как успешного (по умолчанию: false)

HelmShowтолько чтение

Политика доступа: требуется аутентификация Требуется указать либо параметр repo, либо registryId (но не оба).

Параметры
  • chartstringобязательный

    Название диаграммы

  • commandstringобязательный

    чарт/значения/описание

  • environmentIdstring

    ID среды (обязателен, если указан registryId и пользователь не является администратором)

  • registryIdstring

    ID реестра Helm (нужен, если репозиторий не указан)

  • repostring

    URL репозитория Helm (обязателен, если registryId не указан)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • versionstring

    Версия чарта

HelmUserRepositoriesListтолько чтение

Инспектирует репозитории helm пользователя. Политика доступа: только для аутентифицированных

Параметры
  • idintegerобязательный

    Идентификатор пользователя

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

HelmUserRepositoryCreate

Создаёт пользовательский репозиторий Helm. Политика доступа: аутентифицированные пользователи

Параметры
  • idintegerобязательный

    Идентификатор пользователя

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • urlstring
HelmUserRepositoryDelete

Политика доступа: аутентификация

Параметры
  • idintegerобязательный

    Идентификатор пользователя

  • repositoryIDintegerобязательный

    Идентификатор репозитория

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

KubernetesNamespacesToggleSystem

Переключает состояние системы для namespace Политика доступа: администратор или администратор окружения.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Имя пространства имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • Systemboolean

    Переключает состояние системы этого пространства имён на true или false.

kubernetes_proxy

Проксирует запрос к Kubernetes API через Portainer для указанного окружения. Путь path передаётся как есть на сервер K8s API (например, /api/v1/pods, /apis/apps/v1/namespaces/default/deployments). Полезная нагрузка K8s содержит много лишнего: один metadata.managedFields часто занимает 30-70% объекта, поэтому передавайте JMESPath select, чтобы спроецировать только то, что нужно. Пример для /api/v1/pods: items[].{name:metadata.name,ns:metadata.namespace,phase:status.phase,node:spec.nodeName}.

Параметры
  • bodystring | null

    Сырое тело запроса в виде строки (например, JSON-манифест для POST)

  • environment_idintegerобязательный

    Идентификатор окружения Portainer

  • headersobject | null

    Дополнительные заголовки запроса

  • methodstring

    HTTP-метод

  • pathstringобязательный

    Путь API Kubernetes с ведущим слэшем

  • query_paramsobject | null

    Параметры запроса (labelSelector, fieldSelector, ...)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

Logout

Политика доступа: публичная

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

MOTDтолько чтение

Политика доступа: ограничена

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

namespacesAccessUpdate

Обновляет права доступа к namespace в указанном окружении. Этот endpoint позволяет добавлять или удалять пользователей и команды, у которых есть доступ к указанному namespace. Учтите: пользователей и команды нужно сначала добавить в окружение, прежде чем добавлять их в namespace. Политика доступа: Ограниченная. Пользователь должен быть администратором или иметь соответствующие права на изменение доступа к namespace.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • rpnintegerобязательный

    Идентификатор пространства имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • TeamsToAddinteger[]
  • TeamsToRemoveinteger[]
  • UsersToAddinteger[]
  • UsersToRemoveinteger[]
ResizeKubernetesPersistentVolumeClaim

Изменяет размер PVC до нового размера. StorageClass должен поддерживать расширение томов. Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestring
  • namespacestring
  • newSizestring
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

restartKubernetesApplication

Перезапускает приложения Kubernetes (deployment, statefulset и daemonset) с помощью kubectl rollout-restart. Политика доступа: требуется аутентификация.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • kindstringобязательный

    deployment, statefulset или daemonset

  • namestringобязательный

    Название приложения — Context7.

  • namespacestringобязательный

    Пространство имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

RestartKubernetesPod

Перезапускает все контейнеры в одном поде Kubernetes на месте с помощью альфа-субресурса pod-restart из Kubernetes 1.35. Сам под при этом сохраняется. Требует, чтобы кластер предоставлял соответствующий субресурс (и чтобы был включён соответствующий feature gate). Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды(Endpoint)

  • namestringобязательный

    Имя пода

  • namespacestringобязательный

    Namespace

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

ServiceImageStatusтолько чтение

Политика доступа:

Параметры
  • environmentIdintegerобязательный

    Идентификатор среды

  • refreshboolean

    Обновление принудительно обновит кеш статуса изображений.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • serviceIdintegerобязательный

    Идентификатор сервиса

serviceImageStatusClear

Очищает кеш статуса изображений для всех сервисов в окружении Политика доступа

Параметры
  • environmentIdintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

SetDefaultKubernetesStorageClass

Устанавливает указанный StorageClass как класс хранения по умолчанию для кластера, снимая признак «по умолчанию» с любого другого.Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя StorageClass

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

SettingsAdditionalFunctionalityInspectтолько чтение

Получает настройки дополнительных функций Portainer. Политика доступа: требуется аутентификация.

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

SettingsAdditionalFunctionalityUpdate

Обновляет настройки дополнительных функций Portainer. Политика доступа: администратор

Параметры
  • Observabilitybooleanобязательный
  • Policiesbooleanобязательный
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

SettingsEdgeMTLSCACertificatesтолько чтение

Получает сертификаты CA Portainer Edge MTLS. Политика доступа: администратор

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

SettingsEdgeMTLSCertificatesтолько чтение

Получает сертификаты Portainer Edge MTLS. Политика доступа: администратор

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

SettingsExperimentalInspectтолько чтение

Получает экспериментальные настройки Portainer. Политика доступа: аутентифицирован

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

SettingsExperimentalUpdate

Обновляет экспериментальные настройки Portainer. Политика доступа: администратор

Параметры
  • fleetManagementboolean
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

SettingsInspectтолько чтение

Возвращает настройки Portainer. Политика доступа: администратор

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

SettingsPublicтолько чтение

Получает публичные настройки. Возвращает небольшой набор настроек, которые не зарезервированы только для администраторов. Политика доступа: публичная.

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

SettingsUpdate

Обновляет настройки Portainer. Политика доступа: администратор

Параметры
  • AuthenticationMethodinteger

    Активный метод аутентификации для экземпляра Portainer. Допустимые значения: 1 - внутренняя, 2 - LDAP, 3 - oauth

  • AutoPatchSettingsany

    Включать ли автоматические патчи

  • BlackListedLabelsobject[]

    Список имени и значения метки, который будет использоваться для скрытия контейнеров при запросе контейнеров.

  • CustomLoginBannerstring

    Содержимое в виде обычного текста, отображаемое на странице входа. Скрывается, когда значение — пустая строка.

  • DisableKubeconfigDownloadboolean

    Следует ли отключить загрузку kubeconfig для пользователей без прав администратора?

  • DisableKubeRolesSyncboolean

    Отключать ли синхронизацию ролей kube для всех встроенных ролей.

  • DisableKubeShellboolean

    Отключать ли доступ kubeshell для не-администраторов

  • Edgeobject
  • EdgeAgentCheckinIntervalinteger

    Интервал проверки по умолчанию для пограничного агента (в секундах)

  • EdgePortainerURLstring

    EdgePortainerURL — это URL-адрес, который предоставляется edge-агентам.

  • EnableEdgeComputeFeaturesboolean

    Включены ли функции периферийных вычислений.

  • EnforceEdgeIDboolean

    EnforceEdgeID заставляет Portainer хранить Edge ID вместо того, чтобы принимать любой.

  • ForceSecureCookiesboolean

    ForceSecureCookies принудительно устанавливает атрибут Secure для аутентификационных cookie независимо от схемы.

  • GlobalDeploymentOptionsany

    Варианты развертывания для стимулирования развертывания как код.

  • HelmRepositoryURLstring

    URL репозитория Helm

  • InternalAuthSettingsobject
  • KubeconfigExpirystring

    Истечение срока действия Kubeconfig

  • KubectlShellImagestring

    Имя/тег образа оболочки Kubectl

  • LDAPSettingsobject
  • LogoURLstring

    URL логотипа, который будет отображаться на странице входа, а также в верхней части боковой панели. Если значение пустое, будет использоваться логотип Portainer по умолчанию.

  • OAuthSettingsobject
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • SnapshotIntervalstring

    Интервал, в течение которого создаются снимки окружения (конечной точки).

  • TemplatesURLstring

    URL-адрес шаблонов, которые будут отображаться в интерфейсе при переходе в раздел App Templates.

  • TrustOnFirstConnectboolean

    TrustOnFirstConnect включает автоматическое принятие подключений edge-агентов в Portainer по умолчанию.

  • UserSessionTimeoutstring

    Длительность пользовательской сессии.

snapshotContainerInspectтолько чтение

Политика доступа:

Параметры
  • containerIdintegerобязательный

    Идентификатор контейнера

  • environmentIdintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

snapshotContainersListтолько чтение

Политика доступа:

Параметры
  • edgeStackIdinteger

    Идентификатор edge stack, вернет только контейнеры для этого edge stack.

  • environmentIdintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

snapshotInspectтолько чтение

Политика доступа:

Параметры
  • environmentIdintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

StackAssociate

Политика доступа: администратор

Параметры
  • endpointIdintegerобязательный

    Идентификатор среды

  • idintegerобязательный

    Идентификатор стека

  • orphanedRunningbooleanобязательный

    Указывает, является ли стек осиротевшим

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • swarmIdintegerобязательный

    Идентификатор Swarm

StackConvert

Преобразует стек Docker Compose или Docker Swarm в манифесты Kubernetes или Helm chart и возвращает результаты для предпросмотра. Access policy: authenticated

Параметры
  • idintegerобязательный

    Идентификатор стека

  • namespacestring

    Пространство имен для стека Kubernetes.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • targetFormatstringобязательный

    Целевой формат: "kubernetes" для манифестов или "helm" для helm-чарта

StackCreateDockerStandaloneFile

Разворачивает новый стек в среде Docker, заданной через идентификатор среды. Политика доступа: требуется аутентификация

Параметры
  • endpointIdintegerобязательный

    Идентификатор окружения, в котором развернется стек.

  • Envstring

    Переменные окружения, передаваемые при развертывании, представленные в виде JSON-массива [{'name': 'name', 'value': 'value'}].

  • filestring

    Стек-файл

  • Namestringобязательный

    Название стека

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

StackCreateDockerStandaloneRepository

Развёртывает новый stack в Docker-окружение, определяемое идентификатором окружения. Политика доступа: требуется аутентификация

Параметры
  • AdditionalFilesstring[]

    Применимо при развертывании с несколькими файлами стека.

  • AutoUpdateany

    Конфигурация обновления GitOps

  • ComposeFilestring

    Путь к файлу Stack внутри Git-репозитория.

  • endpointIdintegerобязательный

    Идентификатор окружения, в котором развернется стек.

  • Envobject[]

    Список переменных окружения, используемых при развертывании стека.

  • FilesystemPathstring

    Локальный путь файловой системы

  • FromAppTemplateboolean

    Происходит ли стек из шаблона приложения

  • Namestringобязательный

    Название стека

  • Registriesinteger[]

    Список реестров для этого стека

  • RepositoryAuthenticationboolean

    Устарело: используйте SourceID вместо этого. Используйте базовую аутентификацию для клонирования Git-репозитория.

  • RepositoryAuthorizationTypeany

    Устарело: используйте SourceID вместо этого. RepositoryAuthorizationType определяет тип авторизации для использования.

  • RepositoryPasswordstring

    Устарело: используйте SourceID вместо этого. Пароль используется в базовой аутентификации. Обязателен, когда RepositoryAuthentication равно true.

  • RepositoryProviderany

    Устарело: используйте SourceID вместо этого. RepositoryProvider — это провайдер, который следует использовать.

  • RepositoryReferenceNamestring

    Опорное имя репозитория Git, размещающего файл Stack.

  • RepositoryURLstring

    Устарело: используйте SourceID вместо этого. URL Git-репозитория, в котором размещается файл Stack.

  • RepositoryUsernamestring

    Устарело: используйте SourceID вместо этого. Имя пользователя используется в базовой аутентификации. Обязательно, когда RepositoryAuthentication равно true.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • SourceIDinteger

    SourceID ссылается на существующий Source для git-учётных данных/URL. Когда он задан, встроенные поля URL и аутентификации игнорируются.

  • SupportRelativePathboolean

    Поддерживает ли стек относительные пути томов?

  • TLSSkipVerifyboolean

    Устарело: используйте SourceID вместо этого. TLSSkipVerify пропускает проверку SSL при клонировании Git-репозитория.

StackCreateDockerStandaloneString

Развёртывает новый стек в Docker-среду, заданную через идентификатор окружения. Политика доступа: аутентифицированный

Параметры
  • endpointIdintegerобязательный

    Идентификатор окружения, в котором развернется стек.

  • Envobject[]

    Список переменных окружения, используемых при развертывании стека.

  • FromAppTemplateboolean

    Происходит ли стек из шаблона приложения

  • Namestringобязательный

    Название стека

  • Registriesinteger[]

    Список реестров для этого стека

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • StackFileContentstringобязательный

    Содержимое файла Stack

  • Webhookstring

    UUID для идентификации вебхука. Стек будет принудительно обновлён и загрузит последний образ при вызове вебхука.

StackCreateDockerSwarmFile

Разворачивает новый стек в среде Docker, указанной по идентификатору среды. Политика доступа: аутентифицированный

Параметры
  • endpointIdintegerобязательный

    Идентификатор окружения, в котором развернется стек.

  • Envstring

    Переменные окружения, передаваемые при развертывании, представлены в виде JSON-массива [{'name': 'name', 'value': 'value'}]. Необязательно.

  • filestring

    Стек-файл

  • Namestring

    Название стека

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • SwarmIDstring

    Идентификатор кластера Swarm

StackCreateDockerSwarmRepository

Разворачивает новый стек в среде Docker, заданной идентификатором среды. Политика доступа: аутентифицированные.

Параметры
  • AdditionalFilesstring[]

    Применимо при развертывании с несколькими файлами стека.

  • AutoUpdateany

    Конфигурация обновления GitOps

  • ComposeFilestring

    Путь к файлу Stack внутри Git-репозитория.

  • endpointIdintegerобязательный

    Идентификатор окружения, в котором развернется стек.

  • Envobject[]

    Список переменных окружения, используемых при развертывании стека.

  • FilesystemPathstring

    Путь в сетевой файловой системе

  • FromAppTemplateboolean

    Происходит ли стек из шаблона приложения

  • Namestringобязательный

    Название стека

  • Registriesinteger[]

    Список реестров для этого стека

  • RepositoryAuthenticationboolean

    Устарело: используйте SourceID вместо этого. Используйте базовую аутентификацию для клонирования Git-репозитория.

  • RepositoryAuthorizationTypeany

    Устарело: используйте SourceID вместо этого. RepositoryAuthorizationType определяет тип авторизации для использования.

  • RepositoryPasswordstring

    Устарело: используйте SourceID вместо этого. Пароль используется в базовой аутентификации. Обязателен, когда RepositoryAuthentication равно true.

  • RepositoryProviderany

    Устарело: используйте SourceID вместо этого. RepositoryProvider — это провайдер, который следует использовать.

  • RepositoryReferenceNamestring

    Опорное имя репозитория Git, размещающего файл Stack.

  • RepositoryURLstring

    Устарело: используйте SourceID вместо этого. URL Git-репозитория, в котором размещается файл Stack.

  • RepositoryUsernamestring

    Устарело: используйте SourceID вместо этого. Имя пользователя используется в базовой аутентификации. Обязательно, когда RepositoryAuthentication равно true.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • SourceIDinteger

    SourceID ссылается на существующий Source для git-учётных данных/URL. Когда он задан, встроенные поля URL и аутентификации игнорируются.

  • SupportRelativePathboolean

    Поддерживает ли стек относительные пути для томов?

  • SwarmIDstringобязательный

    Идентификатор кластера Swarm

  • TLSSkipVerifyboolean

    Устарело: используйте SourceID вместо этого. TLSSkipVerify пропускает проверку SSL при клонировании Git-репозитория.

StackCreateDockerSwarmString

Разворачивает новый стек в среду Docker, указанную по идентификатору среды. Политика доступа: только для аутентифицированных.

Параметры
  • endpointIdintegerобязательный

    Идентификатор окружения, в котором развернется стек.

  • Envobject[]

    Список переменных окружения, используемых при развертывании стека.

  • FromAppTemplateboolean

    Происходит ли стек из шаблона приложения

  • Namestringобязательный

    Название стека

  • Registriesinteger[]

    Список реестров для этого стека

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • StackFileContentstringобязательный

    Содержимое файла Stack

  • SwarmIDstringобязательный

    Идентификатор кластера Swarm

  • Webhookstring

    UUID для идентификации вебхука. Стек будет принудительно обновлён и загрузит последний образ при вызове вебхука.

StackCreateKubernetesFile

Разворачивает новый стек в Docker-окружении, указанном через идентификатор окружения. Политика доступа: аутентифицированный пользователь

Параметры
  • ComposeFormatboolean
  • endpointIdintegerобязательный

    Идентификатор окружения, в котором развернется стек.

  • FromAppTemplateboolean

    Происходит ли стек из шаблона приложения

  • Namespacestring
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • StackFileContentstring
  • StackNamestring
StackCreateKubernetesGit

Развертывает новый стек в Docker-среду, заданную через идентификатор окружения. Политика доступа: требуется аутентификация

Параметры
  • AdditionalFilesstring[]
  • AutoUpdateobject
  • ComposeFormatboolean
  • endpointIdintegerобязательный

    Идентификатор окружения, в котором развернется стек.

  • HelmChartPathstring

    Поля, специфичные для Helm

  • HelmValuesFilesstring[]

    Массив путей к YAML-файлам значений в Git-репозитории.

  • ManifestFilestring
  • Namespacestring
  • RepositoryAuthenticationboolean

    Устарело: используйте SourceID вместо этого. Используйте аутентификацию, чтобы клонировать Git-репозиторий.

  • RepositoryAuthorizationTypeany

    Устарело: используйте SourceID вместо этого. Тип авторизации используется для клонирования Git-репозитория.

  • RepositoryPasswordstring

    Устарело: используйте SourceID вместо этого. Пароль используется при аутентификации.

  • RepositoryProviderany

    Устарело: используйте SourceID вместо этого. Провайдер, используемый для клонирования Git-репозитория.

  • RepositoryReferenceNamestring

    Устарело: используйте SourceID вместо этого. Имя ссылки на Git-репозиторий, в котором размещается файл Stack.

  • RepositoryURLstring

    Устарело: используйте SourceID вместо этого. URL Git-репозитория, в котором размещается файл Stack.

  • RepositoryUsernamestring

    Устарело: используйте SourceID вместо этого. Имя пользователя используется при аутентификации.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • SourceIDinteger

    SourceID ссылается на существующий Source для git-учётных данных/URL. Когда он задан, встроенные поля URL и аутентификации игнорируются.

  • StackNamestring
  • TLSSkipVerifyboolean

    Устарело: используйте SourceID вместо этого. TLSSkipVerify пропускает проверку SSL при клонировании Git-репозитория.

StackCreateKubernetesUrl

Развёртывает новый стек в Docker-среде, заданной через идентификатор среды. Политика доступа: аутентифицированный

Параметры
  • ComposeFormatboolean
  • endpointIdintegerобязательный

    Идентификатор окружения, в котором развернется стек.

  • ManifestURLstring
  • Namespacestring
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • StackNamestring
StackDelete

Удаляет стек. Политика доступа: restricted

Параметры
  • endpointIdintegerобязательный

    Идентификатор среды

  • externalboolean

    Установите значение true, чтобы удалить внешний стек. Поддерживаются только внешние стеки Swarm

  • idintegerобязательный

    Идентификатор стека

  • removeVolumesboolean

    Установите значение true, чтобы удалить именованные тома, объявленные в файле стека, и анонимные тома, прикреплённые к контейнерам. Влияет только на стеки Docker Standalone.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

StackDeleteKubernetesByName

Удаляет стек. Политика доступа: ограниченная

Параметры
  • endpointIdintegerобязательный

    Идентификатор среды

  • externalboolean

    Установите значение true, чтобы удалить внешний стек. Поддерживаются только внешние стеки Swarm

  • namestringобязательный

    Имя стека

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

StackFileInspectтолько чтение

Получает содержимое файла Stack. Политика доступа: ограничена

Параметры
  • commitHashstring

    Хэш коммита Git-репозитория. Если указаны и version, и commitHash, будет использован commitHash.

  • idintegerобязательный

    Идентификатор стека

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • versioninteger

    Версия файла стека поддерживается Portainer. Если указаны и версия, и commitHash, используется commitHash.

StackGitRedeploy

Получает и повторно разворачивает стек через Git Политика доступа: только для аутентифицированных

Параметры
  • endpointIdinteger

    Стеки, созданные до версии 1.18.0, могут не иметь связанного идентификатора среды (endpoint). Используйте этот необязательный параметр, чтобы задать идентификатор среды (endpoint), используемый стеком.

  • Envobject[]
  • idintegerобязательный

    Идентификатор стека

  • Pruneboolean
  • PullImageboolean

    Устарело (2.36): используйте RepullImageAndRedeploy вместо этого, чтобы responsibilities были чище Принудительно вытягивает образ с исходным тегом, даже если образ уже последней версии

  • RepositoryAuthenticationboolean
  • RepositoryAuthorizationTypeenum
  • RepositoryPasswordstring
  • RepositoryProviderenum
  • RepositoryReferenceNamestring
  • RepositoryUsernamestring
  • RepullImageAndRedeployboolean

    RepullImageAndRedeploy указывает, следует ли принудительно перетягивать образы и повторно разворачивать стек.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • StackNamestring
stackImagesStatusтолько чтение

Политика доступа:

Параметры
  • idintegerобязательный

    Идентификатор стека

  • refreshboolean

    Обновление принудительно обновит кеш статуса изображений.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

StackInspectтолько чтение

Получает сведения о стеке. Политика доступа: ограниченная

Параметры
  • idintegerобязательный

    Идентификатор стека

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

StackListтолько чтение

Выводит список всех стеков на основе авторизаций текущего пользователя. Возвращает все стеки, если используется учётная запись администратора, иначе возвращает только список стеков, к которым у пользователя есть доступ. Ограниченные стеки этот эндпоинт не возвращает. Политика доступа: аутентифицированный

Параметры
  • filtersstring

    Фильтры для обработки списка стеков. Кодируются как JSON (map[string]string). Например, {'SwarmID': 'jpofkc0i9uo9wtx1zesuk649w'} вернёт только те стеки, которые входят в указанный кластер Swarm. Доступные фильтры: EndpointID, SwarmID.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

StackMigrate

Переносит стек из одной среды (endpoint) в другую среду (endpoint). Пересоздаёт стек в целевой среде (endpoint) перед удалением исходного стека. Политика доступа: аутентифицированный

Параметры
  • endpointIdinteger

    Стеки, созданные до версии 1.18.0, могут не иметь связанного идентификатора среды (endpoint). Используйте этот необязательный параметр, чтобы задать идентификатор среды (endpoint), используемый стеком.

  • EndpointIDintegerобязательный
  • idintegerобязательный

    Идентификатор стека

  • IsHelmboolean
  • Namestring
  • Namespacestring
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • SwarmIDstring
stacksImageStatusClear

Очищает кэш статуса образов для всех стеков в окружении Политика доступа:

Параметры
  • environmentIdinteger

    Идентификатор среды (конечной точки), который будет использоваться для фильтрации стеков, для которых нужно очистить кэш статуса образов.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • swarmIdstring

    Идентификатор кластера Swarm, который используется для фильтрации стеков с целью очистки кэша состояния образов.

StackStart

Запускает остановленный Stack. Политика доступа: authenticated

Параметры
  • endpointIdintegerобязательный

    Идентификатор среды

  • idintegerобязательный

    Идентификатор стека

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

StackStop

Останавливает запущенный Stack. Политика доступа: аутентифицированный

Параметры
  • endpointIdintegerобязательный

    Идентификатор среды

  • idintegerобязательный

    Идентификатор стека

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

StacksWebhookInvoke

Политика доступа: public

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • webhookIDstringобязательный

    Идентификатор стека

StackUpdate

Обновляет стек, только для стеков на основе файлов. Политика доступа: аутентифицированный

Параметры
  • endpointIdintegerобязательный

    Идентификатор среды

  • Envobject[]

    Список переменных окружения (конечных точек), используемых при развертывании стека

  • idintegerобязательный

    Идентификатор стека

  • Pruneboolean

    Удаляет сервисы, на которые больше нет ссылок (доступно только для стеков Swarm).

  • PullImageboolean

    Устарело (2.36): используйте RepullImageAndRedeploy вместо этого, чтобы responsibilities были чище Принудительно вытягивает образ с исходным тегом, даже если образ уже последней версии

  • Registriesinteger[]

    Список реестров для этого стека

  • RepullImageAndRedeployboolean

    RepullImageAndRedeploy указывает, следует ли принудительно перетягивать образы и повторно разворачивать стек.

  • RollbackTointeger

    RollbackTo задаёт версию файла стека для отката (сейчас поддерживается только откат к последней версии).

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • StackFileContentstring

    Новое содержимое файла Stack

  • Webhookstring

    UUID для идентификации вебхука. Стек будет принудительно обновлён и загрузит последний образ при вызове вебхука.

StackUpdateGit

Обновляет настройки Git в стеке, например, RepositoryReferenceName и AutoUpdate. Когда задан SourceID, URL/авторизация/TLS берутся из указанного Source. Политика доступа: только для аутентифицированных

Параметры
  • AdditionalFilesstring[]
  • Atomicboolean

    Включает атомарный откат при сбое (флаг Helm --atomic)

  • AutoUpdateobject
  • ConfigFilePathstring
  • endpointIdinteger

    Стеки, созданные до версии 1.18.0, могут не иметь связанного идентификатора среды (endpoint). Используйте этот необязательный параметр, чтобы задать идентификатор среды (endpoint), используемый стеком.

  • Envobject[]
  • HelmChartPathstring

    Путь к папке Helm chart в Git-репозитории (для Helm stacks)

  • HelmValuesFilesstring[]

    Пути к файлам values Helm в Git-репозитории (для стеков Helm)

  • idintegerобязательный

    Идентификатор стека

  • Pruneboolean
  • Registriesinteger[]
  • RepositoryAuthenticationboolean

    Устарело: используйте SourceID вместо этого. Используйте базовую аутентификацию для клонирования Git-репозитория.

  • RepositoryAuthorizationTypeany

    Устарело: используйте SourceID вместо этого. Тип авторизации для аутентификации git.

  • RepositoryPasswordstring

    Устарело: используйте SourceID вместо этого. Пароль используется в базовой аутентификации.

  • RepositoryProviderany

    Устарело: используйте SourceID вместо этого. Git-провайдер для аутентификации на основе OAuth.

  • RepositoryReferenceNamestring
  • RepositoryURLstring

    Устарело: используйте SourceID вместо этого. URL Git-репозитория, в котором размещается файл Stack.

  • RepositoryUsernamestring

    Устарело: используйте вместо этого SourceID. Имя пользователя, используемое в базовой аутентификации.

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • SourceIDinteger

    SourceID ссылается на существующий Source для git-учётных данных/URL. Когда он задан, встроенные поля URL и аутентификации игнорируются.

  • TLSSkipVerifyboolean
StatusInspectтолько чтение

Устарело: используйте вместо него endpoint /system/status. Получает статус Portainer Политика доступа: public

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

systemInfoтолько чтение

Политика доступа: требуется аутентификация

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

systemNodesCountтолько чтение

Политика доступа: аутентифицированным пользователям

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

systemStatusтолько чтение

Возвращает статус Portainer Политика доступа: публичная

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

systemUpdate

Обновляет Portainer до последней версииПолитика доступа: administrator

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

systemVersionтолько чтение

Проверяет, доступно ли обновление для Portainer. Политика доступа: требуется аутентификация.

Параметры
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

TrustEdgeEndpoints

Связывает одно или несколько Edge-окружений, в настоящее время находящихся в комнате ожидания, с окружениями Portainer. Это действие фактически предоставляет доверие этим окружениям. Политика доступа: только администратор.

Параметры
  • EndpointIDsinteger[]
  • Relationsobject
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

updateK8sPodSecurityRule

Обновляет Pod Security Rule в кластере k8s Политика доступа: аутентифицированный

Параметры
  • environmentIdintegerобязательный

    Идентификатор среды(Endpoint)

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

UpdateKubernetesIngress

Обновляет Ingress для указанного окружения. Политика доступа: аутентифицированный пользователь.

Параметры
  • Annotationsobject
  • ClassNamestring
  • CreationDatestring
  • Hostsstring[]
  • idintegerобязательный

    Идентификатор среды

  • Labelsobject
  • Namestring
  • namespacestringобязательный

    Имя пространства имён

  • Namespacestring
  • Pathsobject[]
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • TLSobject[]
  • Typestring
  • UIDstring
UpdateKubernetesIngressControllers

Обновляет (блокирует/разблокирует) ingress controllers для указанного окружения. Политика доступа: аутентифицированный пользователь.

Параметры
  • bodyobject[]обязательный

    Ingress-контроллеры

  • idintegerобязательный

    Идентификатор среды

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

UpdateKubernetesIngressControllersByNamespace

Обновляет (блокирует/разблокирует) ingress-контроллеры по namespace для указанного окружения. Политика доступа: аутентифицированный пользователь.

Параметры
  • bodyobject[]обязательный

    Ingress-контроллеры

  • idintegerобязательный

    Идентификатор среды

  • namespacestringобязательный

    Имя пространства имён

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

UpdateKubernetesNamespace

Обновляет namespace в указанном окружении. Политика доступа: аутентифицированный пользователь.

Параметры
  • Annotationsobject
  • idintegerобязательный

    Идентификатор среды

  • LoadBalancerQuotaobject
  • Namestring
  • namespacestringобязательный

    Namespace

  • Ownerstring
  • ResourceQuotaobject
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • StorageQuotasobject
UpdateKubernetesPersistentVolumeReclaimPolicy

Обновляет политику повторного использования PersistentVolume. Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestring
  • reclaimPolicyenum
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

UpdateKubernetesService

Обновляет сервис в указанном пространстве имён. Политика доступа: аутентифицированный пользователь.

Параметры
  • AllocateLoadBalancerNodePortsboolean
  • Annotationsobject
  • Applicationsobject[]

    экран списка сервисов

  • ClusterIPsstring[]
  • CreationDatestring
  • ExternalIPsstring[]
  • ExternalNamestring
  • idintegerобязательный

    Идентификатор среды

  • IngressStatusobject[]
  • Labelsobject
  • Namestring
  • namespacestringобязательный

    Имя пространства имён

  • Namespacestring
  • Portsobject[]
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

  • Selectorobject
  • Typestring
  • UIDstring
UpdateKubernetesServiceAccountImagePullSecrets

Заменяет список imagePullSecrets в сервисном аккаунте на предоставленный список. Политика доступа: аутентифицированный пользователь.

Параметры
  • idintegerобязательный

    Идентификатор среды

  • namestringобязательный

    Имя сервисного аккаунта

  • namespacestringобязательный

    Namespace

  • secretNamesstring[]
  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

ValidateOAuth

Политика доступа: публичная

Параметры
  • Codestring

    Код OAuth, возвращённый от OAuth Provided

  • selectstring | null

    Необязательное выражение JMESPath для фильтрации ответа на стороне сервера. Используйте его на «шумных» конечных точках, чтобы отбросить ненужные поля: например, [].{id:Id,name:Name,type:Type} для списка окружений или {kind:Kind,name:metadata.name,phase:status.phase} для одного объекта K8s. Опустите параметр, чтобы получить полный ответ (с учётом глобального ограничения размера).

2.45.1основная
2.45.0
2.44.0
2.43.3
2.43.2
2.43.1
2.43.0
2.42.6
2.42.5
2.42.4
2.42.3
2.42.2
2.42.1
2.42.0
2.41.0

Выберите клиент, чтобы установить portainer/portainer-mcp:

Любой клиент

Конфиг добавления MCP сервера стандартный, обычно он не меняется вообще, поэтому подходит практически к любому ИИ клиенту, поддерживающему MCP.

{
  "mcpServers": {
    "portainer-portainer-mcp-rqvg10r9jt": {
      "command": "uvx",
      "args": [
        "--from",
        "mcp-portainer~=2.43.0",
        "mcp-portainer"
      ],
      "env": {
        "PORTAINER_URL": "https://portainer.example.com",
        "PORTAINER_API_KEY": "ptr_xxxxxxxxxxxxxxxx"
      }
    }
  }
}
CursorCursor

Перейдите по ссылке и сервер автоматически будет добавлен в Cursor. Либо откройте/создайте файл ~/.cursor/mcp.json(%USERPROFILE%\.cursor\mcp.json на Windows) и добавьте конфиг сервера:

{
  "mcpServers": {
    "portainer-portainer-mcp-rqvg10r9jt": {
      "command": "uvx",
      "args": [
        "--from",
        "mcp-portainer~=2.43.0",
        "mcp-portainer"
      ],
      "env": {
        "PORTAINER_URL": "https://portainer.example.com",
        "PORTAINER_API_KEY": "ptr_xxxxxxxxxxxxxxxx"
      }
    }
  }
}
VS Code

Создайте .vscode/mcp.json в проекте (ключ верхнего уровня — servers):

{
  "servers": {
    "portainer-portainer-mcp-rqvg10r9jt": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "--from",
        "mcp-portainer~=2.43.0",
        "mcp-portainer"
      ],
      "env": {
        "PORTAINER_URL": "https://portainer.example.com",
        "PORTAINER_API_KEY": "ptr_xxxxxxxxxxxxxxxx"
      }
    }
  }
}

Либо добавьте сервер через терминал:

code --add-mcp "{\"name\":\"portainer-portainer-mcp-rqvg10r9jt\",\"type\":\"stdio\",\"command\":\"uvx\",\"args\":[\"--from\",\"mcp-portainer~=2.43.0\",\"mcp-portainer\"],\"env\":{\"PORTAINER_URL\":\"https://portainer.example.com\",\"PORTAINER_API_KEY\":\"ptr_xxxxxxxxxxxxxxxx\"}}"
ClaudeClaude Desktop

Откройте Settings → Developer → Edit Config — это откроет файл claude_desktop_config.json:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json

Впишите сервер и полностью перезапустите Claude Desktop:

{
  "mcpServers": {
    "portainer-portainer-mcp-rqvg10r9jt": {
      "command": "uvx",
      "args": [
        "--from",
        "mcp-portainer~=2.43.0",
        "mcp-portainer"
      ],
      "env": {
        "PORTAINER_URL": "https://portainer.example.com",
        "PORTAINER_API_KEY": "ptr_xxxxxxxxxxxxxxxx"
      }
    }
  }
}
Claude CodeClaude Code

Добавьте сервер одной командой в терминале:

claude mcp add portainer-portainer-mcp-rqvg10r9jt --env PORTAINER_URL=https://portainer.example.com --env PORTAINER_API_KEY=ptr_xxxxxxxxxxxxxxxx -- uvx --from mcp-portainer~=2.43.0 mcp-portainer

Либо через JSON-конфиг:

claude mcp add-json portainer-portainer-mcp-rqvg10r9jt "{\"command\":\"uvx\",\"args\":[\"--from\",\"mcp-portainer~=2.43.0\",\"mcp-portainer\"],\"env\":{\"PORTAINER_URL\":\"https://portainer.example.com\",\"PORTAINER_API_KEY\":\"ptr_xxxxxxxxxxxxxxxx\"}}"
CodexCodex

Добавьте сервер командой в терминале:

codex mcp add portainer-portainer-mcp-rqvg10r9jt --env PORTAINER_URL=https://portainer.example.com --env PORTAINER_API_KEY=ptr_xxxxxxxxxxxxxxxx -- uvx --from mcp-portainer~=2.43.0 mcp-portainer

Либо вручную в ~/.codex/config.toml(%USERPROFILE%\.codex\config.toml на Windows):

[mcp_servers.portainer-portainer-mcp-rqvg10r9jt]
command = "uvx"
args = ["--from", "mcp-portainer~=2.43.0", "mcp-portainer"]

[mcp_servers.portainer-portainer-mcp-rqvg10r9jt.env]
PORTAINER_URL = "https://portainer.example.com"
PORTAINER_API_KEY = "ptr_xxxxxxxxxxxxxxxx"
PerplexityPerplexity

MCP доступен подписчикам Perplexity Pro / Max / Enterprise. Локальные серверы — только в приложении для macOS.

  1. Откройте Настройки аккаунта → Connectors.
  2. Установите вспомогательное приложение PerplexityXPC (один раз).
  3. Нажмите Add Connector → вкладка Simple.
  4. В поле Server Name укажите portainer/portainer-mcp, а в поле команды запуска — строку ниже:
uvx --from mcp-portainer~=2.43.0 mcp-portainer

Нажмите Save и дождитесь статуса Running.

WindsurfWindsurf

Откройте Windsurf Settings → Cascade → MCP Servers или отредактируйте файл ~/.codeium/windsurf/mcp_config.json:

{
  "mcpServers": {
    "portainer-portainer-mcp-rqvg10r9jt": {
      "command": "uvx",
      "args": [
        "--from",
        "mcp-portainer~=2.43.0",
        "mcp-portainer"
      ],
      "env": {
        "PORTAINER_URL": "https://portainer.example.com",
        "PORTAINER_API_KEY": "ptr_xxxxxxxxxxxxxxxx"
      }
    }
  }
}
ClineCline

В панели Cline нажмите иконку MCP Servers → Configure → Configure MCP Servers (или отредактируйте ~/.cline/mcp.json) и добавьте сервер:

{
  "mcpServers": {
    "portainer-portainer-mcp-rqvg10r9jt": {
      "command": "uvx",
      "args": [
        "--from",
        "mcp-portainer~=2.43.0",
        "mcp-portainer"
      ],
      "env": {
        "PORTAINER_URL": "https://portainer.example.com",
        "PORTAINER_API_KEY": "ptr_xxxxxxxxxxxxxxxx"
      },
      "disabled": false,
      "autoApprove": []
    }
  }
}
Continue

Создайте файл в .continue/mcpServers/ (например portainer-portainer-mcp-rqvg10r9jt.yaml) или добавьте блок в config.yaml. MCP работает только в режиме agent:

mcpServers:
  - name: portainer-portainer-mcp-rqvg10r9jt
    command: uvx
    args:
      - "--from"
      - "mcp-portainer~=2.43.0"
      - "mcp-portainer"
    env:
      PORTAINER_URL: https://portainer.example.com
      PORTAINER_API_KEY: ptr_xxxxxxxxxxxxxxxx
Zed

Выполните agent: add context server или откройте настройки (zed: open settings file) и добавьте сервер в объект context_servers:

{
  "context_servers": {
    "portainer-portainer-mcp-rqvg10r9jt": {
      "command": "uvx",
      "args": [
        "--from",
        "mcp-portainer~=2.43.0",
        "mcp-portainer"
      ],
      "env": {
        "PORTAINER_URL": "https://portainer.example.com",
        "PORTAINER_API_KEY": "ptr_xxxxxxxxxxxxxxxx"
      }
    }
  }
}

Похожие MCP-сервера

mrostamii/rancher-mcp-server

mrostamii/rancher-mcp-server

от mrostamii

MCP-сервер для управления Rancher, Harvester HCI и Fleet GitOps через единый API. Работает с мультикластерным Kubernetes, виртуальными машинами, Helm-релизами и GitOps-репозиториями. По умолчанию т...

Go⭐ 12
alexei-led/k8s-mcp-server

alexei-led/k8s-mcp-server

от alexei-led

K8s MCP Server - Docker-сервер с MCP для Claude. Запускает kubectl, helm, istioctl, argocd в изолированном контейнере. Помогает управлять Kubernetes-кластерами, разворачивать приложения и диагности...

Python⭐ 212
harness/mcp-server

harness/mcp-server

от harness

MCP сервер для AI-агентов платформы Harness.io. 11 инструментов покрывают 214 типов ресурсов: CI/CD, GitOps, Feature Flags, облачные затраты. Работает через API ключ, расширяется. Автоматизируй пайплайны и инфраструктуру.

TypeScript⭐ 108
strowk/mcp-k8s-go

strowk/mcp-k8s-go

от strowk

Управляет кластером Kubernetes: создаёт и изменяет ресурсы, читает логи и события, выполняет команды в подах.

Go⭐ 382
Daghis/teamcity-mcp

Daghis/teamcity-mcp

от daghis

MCP сервер объединяет AI-ассистентов с TeamCity CI/CD. Разработчики запускают сборки, просматривают логи, управляют параметрами и агентами из редактора. Режимы: Dev для повседневных задач и Full дл...

TypeScript⭐ 31
flux159/mcp-server-kubernetes

flux159/mcp-server-kubernetes

от flux159

Управляет Kubernetes-кластером через kubectl: создаёт и удаляет ресурсы, деплоит манифесты, масштабирует поды и смотрит логи.

TypeScript⭐ 1606
© Каталог MCP, 2026. Все права защищены.
Проект не аффилирован с Anthropic и любыми упомянутыми продуктами.
Все названия и торговые марки принадлежат их владельцам.
Контакты для связи: hi@mcp-katalog.ru

Лука Никитин