Portainer MCP connector

• List List all Portainer roles List all Portainer roles available for use. Returns an array of role objects including id, name, description, and priority.
• List List all Portainer kubernete applications List Kubernetes applications across all namespaces in a Portainer environment. When nodeName is provided, returns only applications running on that node. Returns an array of application objects, each with an id and schema-specific attributes defined in the upstream K8sApplication schema. Required: kubernete_id, namespace, nodeName.
• List List all Portainer applications counts Get the count of Kubernetes applications across all namespaces in a Portainer environment. Returns an integer count of applications, optionally filtered to a specific node when nodeName is supplied. Required: kubernete_id.
• Delete Delete a Portainer cluster role bindings delete by ID Delete a list of cluster role bindings from a Portainer Kubernetes environment. Accepts an array of cluster role binding names to remove. Returns an empty 204 response on success. Required: kubernete_id (the environment identifier) and a JSON array of cluster role binding names in the request body.
• Delete Delete a Portainer cluster roles delete by ID Delete a list of Kubernetes cluster roles in a Portainer environment. Returns an empty 204 response on success. Required: kubernete_id and a request body array of cluster role names.
• List List all Portainer kubernete clusterrolebindings List Kubernetes cluster role bindings within a Portainer environment at the cluster level. Returns each binding's name and attributes. Required: kubernete_id.
• List List all Portainer kubernete clusterroles List Kubernetes cluster roles within a Portainer environment at the cluster level. Returns an array of K8sClusterRole objects including id and attributes whose field-level shape is defined in the upstream OpenAPI schema. Required: kubernete_id.
• List List all Portainer kubernete configmaps List ConfigMaps across all namespaces in a Portainer Kubernetes environment. Returns an array of K8sConfigMap objects; when isUsed is set to true, each item includes information about applications that use it. Required: kubernete_id, isUsed.
• List List all Portainer configmaps counts Get the count of ConfigMaps across all namespaces in a Portainer Kubernetes environment. Returns an integer count of ConfigMaps; for non-admin users only ConfigMaps in accessible namespaces are counted. Required: kubernete_id.
• List List all Portainer kubernete cron jobs List Kubernetes Cron Jobs in a Portainer environment that the authenticated user has access to. Returns an array of Cron Job objects. Required: kubernete_id.
• Delete Delete a Portainer cron jobs delete by ID Delete Kubernetes Cron Jobs from a Portainer environment, grouped by namespace. Returns an empty 204 response on success. Required: kubernete_id and a request body mapping each namespace to an array of Cron Job names to delete.
• List List all Portainer kubernete dashboards Get Kubernetes dashboard summary data for a Portainer environment, providing counts of commonly used Kubernetes resources. Returns an array of dashboard summary objects whose fields are defined by the upstream K8sDashboard schema (resource counts). Required: kubernete_id.
• List List all Portainer kubernete describes Get a description of a Kubernetes resource in a Portainer environment. Returns the resource description with content-type-specific fields that vary by resource kind. Required: kubernete_id, name, kind.
• List List all Portainer kubernetes List Kubernetes events in a Portainer environment, optionally filtered by the resource id of a specific involved Kubernetes object. Returns Kubernetes event objects with an id and attributes whose fields are defined upstream in the kubernetes.K8sEvent schema. Required: kubernete_id.
• List List all Portainer kubernete ingresscontrollers List Kubernetes ingress controllers for a Portainer environment, optionally filtering to only allowed controllers. Returns: attributes (ingress controller fields defined by the upstream kubernetes.K8sIngressController schema). Required: kubernete_id.
• Update Portainer kubernete ingresscontrollers bulk update Update (block/unblock) Kubernetes ingress controllers for a Portainer environment by submitting an array of ingress controller objects. Returns an empty 204 response on success. Required: kubernete_id.
• List List all Portainer kubernete ingresses List Kubernetes ingresses at the cluster level for a Portainer environment. Returns ingress records including id and attributes with fields defined in the upstream K8sIngressInfo schema. Required: kubernete_id.
• List List all Portainer ingresses counts Get the count of Kubernetes ingresses within a specific Portainer environment. Returns an integer representing the total number of ingresses. Required: kubernete_id.
• Delete Delete a Portainer ingresses delete by ID Delete one or more Kubernetes Ingresses in a Portainer environment. Returns an empty 204 response on success. Required: kubernete_id.
• List List all Portainer kubernete jobs List Kubernetes Jobs in a Portainer environment that the authenticated user has access to. Optionally include jobs owned by cron jobs. Returns: id. Required: kubernete_id.
• Delete Delete a Portainer jobs delete by ID Delete a list of Kubernetes Jobs in a Portainer environment by providing a namespace-to-jobs map. Returns an empty 204 response on success. Required: kubernete_id (environment identifier) and a request body mapping namespace names to arrays of Job names.
• List List all Portainer kubernete max resource limits Get max CPU and memory limits (unused resources) for all nodes within a Kubernetes cluster in Portainer. Returns a map of per-node resource limits including CPU and memory capacity per node. Required: kubernete_id.
• List List all Portainer metrics applications resources List the total CPU (cores) and memory (bytes) requests and limits of all applications across all namespaces in a Portainer Kubernetes environment. Returns: CpuRequest, CpuLimit, MemoryRequest, MemoryLimit. Required: kubernete_id, node.
• List List all Portainer metrics nodes List live metrics for all nodes in a Portainer Kubernetes environment. Returns the NodeMetricsList object whose field shape is defined by the Kubernetes v1beta1.NodeMetricsList schema referenced upstream. Required: kubernete_id.
• Get Get single Portainer metrics node by ID Get live metrics for a specific node by id in a Portainer Kubernetes environment. Returns: apiVersion, kind, metadata, timestamp, window, usage. Required: kubernete_id, id.
• List List all Portainer metrics pods List pods with their live metrics in a Portainer Kubernetes environment namespace. Returns a v1beta1.PodMetricsList whose fields are defined by the upstream Kubernetes metrics API and are not expanded in the Portainer API documentation. Required: kubernete_id, namespace.
• Get Get single Portainer metrics pod by ID Get live metrics for a specific pod in a Portainer Kubernetes environment namespace. Returns a v1beta1.PodMetrics object whose fields are defined by the upstream Kubernetes metrics API and are not expanded in the Portainer API documentation. Required: kubernete_id, namespace, id.
• List List all Portainer kubernete namespaces List all Kubernetes namespaces in a Portainer environment, scoped by the user's role and permissions. Returns: Name. Required: kubernete_id, withResourceQuota, withUnhealthyEvents.
• Create Create a Portainer kubernete namespace Create a Kubernetes namespace in a Portainer environment. Returns: Name. Required: kubernete_id, Name.
• Update Update a Portainer kubernete namespace by ID Update a Kubernetes namespace in a Portainer environment. Returns: Name. Required: kubernete_id, id, Name.
• List Portainer kubernete namespaces list events List Kubernetes events for a namespace in a Portainer environment, optionally filtered by resource id. Returns: id. Required: kubernete_id, namespace.
• Get Get single Portainer kubernete namespace by ID Get details of a Kubernetes namespace in a Portainer environment by id. Returns: id, attributes. Required: kubernete_id, id.
• Update Portainer kubernete namespaces bulk update Update Kubernetes namespaces within a Portainer environment. Returns: id, attributes. Required: kubernete_id.
• Delete Portainer kubernete namespaces bulk delete Delete a Kubernetes namespace in a Portainer environment. Returns a success message string. Required: kubernete_id, namespace.
• List List all Portainer namespace configmaps Get a ConfigMap by name within a specific namespace in a Portainer Kubernetes environment. Returns the full Kubernetes ConfigMap object including its name, namespace, and configuration data. Required: kubernete_id, namespace, configmap.
• List List all Portainer namespace ingresscontrollers List ingress controllers for a Portainer Kubernetes environment in a specific namespace. Returns an array of ingress controller objects with attributes defined by the upstream K8sIngressController schema. Required: kubernete_id, namespace.
• Update Portainer namespace ingresscontrollers bulk update Update (block/unblock) Kubernetes ingress controllers by namespace for a Portainer environment. Accepts an array of ingress controller objects to update. Returns an empty 204 response on success. Required: kubernete_id, namespace.
• List List all Portainer namespace ingresses List Kubernetes ingresses in a specific namespace within a Portainer environment. Returns: id, name. Required: kubernete_id, namespace.
• Create Create a Portainer namespace ingress Create a Kubernetes ingress in a specific namespace within a Portainer environment. Returns an empty 204 response on success. Required: kubernete_id, namespace.
• Get Get single Portainer namespace ingress by ID Get a single Kubernetes ingress by id in a specific namespace within a Portainer environment. Returns: id, name, namespace. Required: kubernete_id, namespace, id.
• Update Portainer namespace ingresses bulk update Update a Kubernetes ingress in a specific namespace within a Portainer environment. Returns an empty 204 response on success. Required: kubernete_id, namespace.
• List List all Portainer namespace persistent volume claims List Kubernetes PersistentVolumeClaims in a namespace within a Portainer environment. Returns PVC objects including name and attributes. Required: kubernete_id, namespace.
• Get Get single Portainer namespace persistent volume claim by ID Get a specific PersistentVolumeClaim by name within a Kubernetes namespace in a Portainer environment. Returns the PVC object including its id and attributes. Required: kubernete_id, namespace, id.
• Delete Delete a Portainer namespace pod by ID Delete a Kubernetes pod in a given namespace from Portainer. The owning controller (Deployment, StatefulSet, DaemonSet) recreates the pod; naked pods are removed permanently. Returns an empty 204 response on success. Required: kubernete_id, namespace, id.
• Create Create a Portainer pod restart Restart all containers in a Kubernetes pod in place using the Kubernetes 1.35 alpha pod-restart subresource; the pod itself is preserved. Returns an empty 204 response on success. Required: kubernete_id, namespace, name. The cluster must expose the pod-restart subresource (Kubernetes 1.35+ with the matching feature gate enabled).
• List List all Portainer namespace secrets Get a Kubernetes Secret by name within a specified namespace in a Portainer environment. Returns the secret object including its name, namespace, and data. Required: kubernete_id, namespace, secret.
• List List all Portainer namespace service accounts Get a specific Kubernetes service account by name within a namespace in a Portainer environment. Returns: name. Required: kubernete_id, namespace, name.
• Update Portainer service account image pull secrets bulk update Replace the imagePullSecrets list on a Kubernetes service account in a Portainer environment with the provided list. Returns an empty 204 response on success. Required: kubernete_id, namespace, id.
• List List all Portainer namespace services List Kubernetes services for a given namespace in a Portainer environment. Returns: attributes containing Kubernetes service information as defined by the upstream K8sServiceInfo schema. Required: kubernete_id, namespace.
• Create Create a Portainer namespace service Create a Kubernetes service within a given namespace in a Portainer environment. Returns an empty 204 response on success. Required: kubernete_id, namespace.
• Update Portainer namespace services bulk update Update a Kubernetes service within a given namespace in Portainer. Returns an empty 204 response on success. Required: kubernete_id, namespace, and a K8sServiceInfo request body containing the updated service configuration.
• Update Portainer namespace systems bulk update Toggle the system state for a Kubernetes namespace in a Portainer environment. Returns an empty 204 response on success. Required: kubernete_id, namespace.
• List List all Portainer namespace volumes List Kubernetes volumes within a specific namespace in a Portainer environment. Returns: attributes containing Portainer-defined K8sVolumeInfo fields (volume details and optionally the applications using each volume). Required: kubernete_id, namespace.
• List List all Portainer namespaces counts Get the total number of Kubernetes namespaces within a Portainer environment, including system namespaces. Returns an integer count that depends on the user's role and permissions. Required: kubernete_id.
• List List all Portainer kubernete nodes List Kubernetes cluster nodes for a Portainer environment. Returns each node's id and attributes (as defined by the upstream KubernetesNodeResponse schema). Required: kubernete_id.
• Create Create a Portainer node drain Drain a Kubernetes node in Portainer by safely evicting all pods from the node, preparing it for maintenance or removal. Returns an empty 204 response on success. Required: kubernete_id, name.
• List List all Portainer kubernete nodes limits Get CPU and memory limits of all nodes within a Kubernetes cluster in Portainer. Returns a map keyed by node name where each entry contains the node's CPU and Memory limits. Required: kubernete_id.
• List List all Portainer kubernete persistent volume claims List all PersistentVolumeClaims in a Portainer Kubernetes environment. Returns an array of PersistentVolumeClaim objects. Required: kubernete_id. Results are scoped by namespace for non-admin users.
• Delete Delete a Portainer persistent volume claims delete by ID Delete a list of PersistentVolumeClaims in a Portainer Kubernetes environment by providing PVC namespace and name pairs. Returns an empty 204 response on success. Required: kubernete_id and a body array of PVC namespace/name pairs.
• Update Portainer persistent volume claims resizes bulk update Resize a PersistentVolumeClaim in a Portainer Kubernetes environment to a new size. Returns an empty 204 response on success. Required: kubernete_id. The StorageClass must support volume expansion.
• List List all Portainer kubernete persistent volumes List all PersistentVolumes in a Portainer Kubernetes environment. Returns: name. Required: kubernete_id.
• Get Get single Portainer kubernete persistent volume by ID Get a specific PersistentVolume by id in a Portainer Kubernetes environment. Returns: name. Required: kubernete_id, id.
• Delete Delete a Portainer persistent volumes delete by ID Delete a list of PersistentVolumes in a Portainer Kubernetes environment by providing their names. Returns an empty 204 response on success. Required: kubernete_id and the list of PersistentVolume names to delete.
• Update Portainer persistent volumes reclaim policies bulk update Update the reclaim policy of a PersistentVolume in a Portainer Kubernetes environment. Returns an empty 204 response on success. Required: kubernete_id.
• List List all Portainer kubernete rbac enableds Check whether RBAC is enabled in a specific Portainer Kubernetes cluster. Returns a boolean indicating the RBAC status. Required: kubernete_id.
• Delete Delete a Portainer role bindings delete by ID Delete Kubernetes role bindings in a Portainer environment by submitting a namespace-to-role-binding-names map. Returns an empty 204 response on success. Required: kubernete_id.
• List List all Portainer kubernete rolebindings List Kubernetes role bindings in a Portainer environment that the authenticated user has access to. Returns an array of role binding records with id and attributes. Required: kubernete_id.
• List List all Portainer kubernete roles List Kubernetes roles in a Portainer environment that the authenticated user has access to. Returns: name. Required: kubernete_id.
• Delete Delete a Portainer roles delete by ID Delete Kubernetes roles in a Portainer environment by providing a map of namespaces to arrays of role names. Returns an empty 204 response on success. Required: kubernete_id.
• List List all Portainer kubernete secrets List Kubernetes Secrets across all namespaces in a Portainer environment. When isUsed is set to true, information about the applications that use each secret is included in the response. Returns an array of K8sSecret objects including id and additional secret attributes. Required: kubernete_id, isUsed.
• List List all Portainer secrets counts Get the count of Kubernetes Secrets across all namespaces the user has access to in Portainer. Returns the total count as an integer. Required: kubernete_id (the environment identifier).
• Delete Delete a Portainer service accounts delete by ID Delete a list of Kubernetes service accounts from a Portainer environment. Accepts a map where each key is a namespace and each value is an array of service account names to delete. Returns an empty 204 response on success. Required: kubernete_id.
• List List all Portainer kubernete serviceaccounts List Kubernetes service accounts in a Portainer environment that the user has access to. Returns: name. Required: kubernete_id.
• List List all Portainer kubernete services List Kubernetes services that the user has access to in a Portainer environment. Returns an array of Kubernetes service objects. Required: kubernete_id. Optional: withApplications to include associated applications with each service.
• List List all Portainer services counts Get the total count of Kubernetes services the user has access to in a Portainer environment. Returns the service count as an integer. Required: kubernete_id (environment identifier).
• Delete Delete a Portainer services delete by ID Delete Kubernetes services in a Portainer environment by providing a map of namespace to service names. Returns an empty 204 response on success. Required: kubernete_id.
• List List all Portainer kubernete storage classes List all Kubernetes StorageClasses in a Portainer environment. Returns: Name. Required: kubernete_id.
• Get Get single Portainer kubernete storage class by ID Get a specific Kubernetes StorageClass by name in a Portainer environment. Returns: Name, attributes. Required: kubernete_id, id.
• Update Portainer kubernete storage classes bulk update Set a specified StorageClass as the cluster default in Portainer, removing default status from any other StorageClass. Returns an empty 204 response on success. Required: kubernete_id, id.
• Delete Delete a Portainer storage classes delete by ID Delete one or more Kubernetes StorageClasses from a Portainer environment. Accepts a JSON array of StorageClass names to delete. Returns an empty 204 response on success. Required: kubernete_id and the array of StorageClass names.
• List List all Portainer kubernete versions Get the Kubernetes cluster version and Portainer capability flags for a specific environment in Portainer. Returns: major, minor, gitVersion, and capability flags such as supportsPodRestart. Required: kubernete_id.
• List List all Portainer kubernete volumes List all Kubernetes volumes in a Portainer environment, optionally including the applications using each volume. Returns: Name. Required: kubernete_id.
• Get Get single Portainer kubernete volume by ID Get a specific Kubernetes volume by namespace and id in a Portainer environment. Returns: Name, Namespace, Applications. Required: kubernete_id, namespace, id.
• List List all Portainer volumes counts Get the total number of Kubernetes volumes within a Portainer environment. Returns an integer count of volumes; the count depends on the user's role and permissions. Required: kubernete_id.
• List List all Portainer kubernetes configs Generate a kubeconfig file in Portainer that allows a client to communicate with the Kubernetes API server. Returns the kubeconfig file with Kubernetes-standard fields. Use ids to include only specific environment endpoints, or excludeIds to exclude environments. Both parameters are optional and accept arrays of environment endpoint identifiers.
• List List all Portainer settings Retrieve Portainer settings. Returns the full Portainer settings object containing global configuration options for the instance. No required parameters.
• Update Portainer settings bulk update Update Portainer settings by submitting a new settings payload. Returns the updated Portainer settings object. Required: a JSON request body containing the new settings.
• List List all Portainer settings publics Retrieve Portainer public settings — a small set of non-administrative settings. Returns the public settings object whose individual fields are defined upstream in the settings.publicSettingsResponse schema and are not enumerated in the available documentation.
• List List all Portainer system info Retrieve Portainer system info. Returns the Portainer system info object with details about the running Portainer instance.
• List List all Portainer system nodes Retrieve the count of nodes managed by Portainer. Returns: count. No required parameters.
• List List all Portainer system status Check Portainer status. This public endpoint retrieves the current status of the Portainer instance, including whether authentication is enabled and whether analytics are active. No required parameters.
• Create Create a Portainer system upgrade Upgrade Portainer to the Business Edition (BE). Returns an empty 204 response on success. Requires administrator access.
• List List all Portainer system versions Check if Portainer has an update available. Returns a version response object containing Portainer update availability information. No required parameters.
• List List all Portainer teams List teams in Portainer. For non-administrator users, only returns teams they are a member of. Returns: Id, Name.
• Create Create a Portainer team Create a new team in Portainer. Returns the created team including its Id and Name. Required: Name. Returns 409 if a team with the same name already exists.
• Get Get single Portainer team by ID Get a single Portainer team by id. Returns: Id, Name. Required: id.
• Update Update a Portainer team by ID Update a Portainer team by id. Returns the updated team including its Id and Name. Required: id.
• Delete Delete a Portainer team by ID Delete a Portainer team by id. Returns an empty 204 response on success. Required: id.
• List List all Portainer websocket attaches Attach a websocket in Portainer. When nodeName is provided the request is proxied to the underlying agent environment; otherwise the request is upgraded to the websocket protocol with an AttachStart operation. Returns an empty 200 response on success. Required: endpointId.
• List List all Portainer websocket execs Execute a websocket exec session on a Portainer environment. When nodeName is provided the request is proxied to the underlying agent environment; otherwise the request is upgraded to the websocket protocol and an ExecStart operation is created and hijacked. Returns an empty 200 response on success. Required: endpointId.
• List List all Portainer websocket kubernetes shells Execute a websocket on a kubectl shell pod in Portainer, upgrading the request to a long-lived websocket connection that proxies client input to the pod. The response is a protocol upgrade with no structured JSON body. Required: endpointId.
• List List all Portainer websocket pods Execute a command in a container within a Kubernetes pod via WebSocket in Portainer. The request is upgraded to the WebSocket protocol; no structured response body is returned. Required: endpointId, namespace, podName, containerName, command.
• List List all Portainer tags List all tags in Portainer. Returns: id.
• Create Create a Portainer tag Create a new tag in Portainer. Returns: id. Required: Name. Returns 409 if the name is already associated to an existing tag.
• Delete Delete a Portainer tag by ID Delete a Portainer tag by id. Returns an empty 204 response on success. Required: id.
• Create Create a Portainer auth Authenticate against Portainer using a username and password to obtain a JWT token. Returns: jwt. Required: Username, Password.
• Create Create a Portainer auth logout Log out of Portainer, invalidating the current session. Returns an empty 204 response on success.
• Create Create a Portainer oauth validate Authenticate with OAuth in Portainer by submitting OAuth credentials. Returns a JWT token for subsequent authenticated API calls. Required: OAuth credentials in the request body.
• List List all Portainer team memberships List all team memberships in Portainer. Returns an array of team membership objects including id. No caller-supplied parameters required.
• Create Create a Portainer team membership Create a new team membership in Portainer. Returns the created team membership object including id. A JSON request body with team membership details is required.
• Update Update a Portainer team membership by ID Update a team membership in Portainer by id. Returns the updated team membership object including id. Required: id. A JSON request body with team membership details is required.
• Delete Delete a Portainer team membership by ID Delete a team membership in Portainer by id. Returns an empty 204 response on success. Required: id.
• List Portainer team memberships list by team List team memberships for a specific team in Portainer. Returns each membership's Id, UserID, TeamID, and Role. Required: team_id.
• List List all Portainer endpoints List Portainer environments (endpoints) with extensive filtering by group, type, status, tags, platform, edge properties, and more. Returns: Id, Type, URL.
• Create Create a Portainer endpoint Create a new Portainer environment (endpoint) to manage a Docker, Agent, Azure, Edge, or Kubernetes environment. Returns the created environment including Id, Name, Type, URL, Status, GroupID, and TLS settings. Required: Name, EndpointCreationType.
• Delete Portainer endpoints bulk delete Remove multiple Portainer environments in a single batch request, optionally cleaning up associated resources. Deprecated — prefer the POST /endpoints/delete endpoint instead. Returns an empty 204 response on success.
• Get Get single Portainer endpoint by ID Get a single Portainer environment (endpoint) by id. Returns the full environment object including Id, Name, Type, URL, Status, GroupID, Snapshots, and TLS settings. Required: id.
• Update Update a Portainer endpoint by ID Update a Portainer environment (endpoint) by id, modifying properties such as name, URL, TLS settings, group, tags, and status. Returns the updated environment including Id, Name, Type, URL, Status, GroupID, and TLS settings. Required: id.
• Delete Delete a Portainer endpoint by ID Delete a Portainer environment (endpoint) by id, optionally cleaning up associated resources. Returns an empty 204 response on success. Required: id.
• Update Portainer endpoint associations bulk update De-associate an edge environment (endpoint) in Portainer by id. Returns an empty 204 response on success. Required: id.
• Create Create a Portainer browse put Upload a file to a specific destination path on the file system of a Portainer environment (endpoint), such as TLS files. Returns an empty 204 response on success. Required: endpoint_id, Path, file.
• List List all Portainer endpoint dockerhubs Fetch Docker Hub pull limits for a Docker Hub registry in a Portainer environment. Returns the Docker Hub pull limit status for the specified registry. Required: endpoint_id, registry_id.
• Update Portainer endpoint forceupdateservices bulk update Force update a Docker service on a Portainer endpoint (environment). Returns a swarm service update response object. Required: id.
• List List all Portainer endpoint registries List all registries available in a Portainer environment based on the current user's authorizations. Returns an array of registry objects for the specified environment, filtered by the caller's access permissions. Required: endpoint_id. For Kubernetes environments, an optional namespace parameter filters registries by namespace.
• Update Update a Portainer endpoint registry by ID Update registry access for a Portainer environment. Returns an empty 204 response on success. Required: id, endpoint_id, and a JSON access payload body.
• Update Portainer endpoint settings bulk update Update settings for a Portainer environment (endpoint) by id. Returns the updated Portainer Endpoint object including Id, Name, Status, URL, Type, and GroupID. Required: id.
• Create Create a Portainer endpoint snapshot Create a snapshot of a Portainer environment (endpoint). Returns an empty 204 response on success. Required: endpoint_id.
• Create Create a Portainer endpoints delete Remove multiple Portainer environments in a single batch and optionally clean up associated resources. Returns an empty 204 response on success; a 207 partial-success response is returned when some environments fail to delete. Requires a request body specifying the environments to remove.
• Create Create a Portainer endpoints global key Create or retrieve the Portainer environment (endpoint) for an EdgeID. Returns the endpoint global key response object including its id and content-specific attributes.
• Update Portainer endpoints relations bulk update Update relations for a list of Portainer environments, including edge groups, tags, and environment group assignments. Returns an empty 204 response on success. Required: a request body containing environment relations data.
• Create Create a Portainer endpoints snapshot Trigger a snapshot of all Portainer environments (endpoints). Returns an empty 204 response on success.
• List List all Portainer endpoints summaries Get Portainer environment summary counts including environment status breakdown (up, down), unassigned count, and breakdowns by group, type, and health. Returns: type.
• List List all Portainer templates List available Portainer app templates. Returns: id. The full template object shape is defined by the upstream templates.listResponse schema, which is not enumerated in the API docs; individual fields vary by Portainer version and configured template source.
• Create Create a Portainer template file Get a Portainer template's file content by template id. Returns: FileContent. Required: template_id.
• List List all Portainer users List Portainer users. Returns: Id. Non-administrator users can only see other non-administrator accounts. Passwords are filtered out and never returned. Optionally filter by environmentId.
• Create Create a Portainer user Create a new Portainer user. Returns the created user object including Id, Username, and Role. Only administrators can create users; returns 409 if the user already exists. Required: Username, Password, Role.
• Get Get single Portainer user by ID Get a single Portainer user by id. Returns: Id. Passwords are filtered out and never returned. Required: id.
• Update Update a Portainer user by ID Update a Portainer user by id. Returns: Id. Regular users can only update their own details and cannot change their username or role. Required: id.
• Delete Delete a Portainer user by ID Delete a Portainer user by id. Returns an empty 204 response on success. Required: id.
• Action Portainer users current Retrieve details about the current authenticated Portainer user. Returns: Id, Username, Role. User passwords are filtered out and never returned.
• List List all Portainer user effective acceses List a Portainer user's effective access on every environment. Returns: role, environment for each accessible environment, following the access viewer's policy precedence. Environments with no role are omitted. Required: user_id.
• List List all Portainer user memberships List team memberships for a Portainer user by user id. Returns a TeamMembership object including Id, TeamID, UserID, and Role. Required: user_id.
• Update Portainer user passwds bulk update Update the password for a Portainer user by id. Returns an empty 204 response on success. Required: id, password.
• List List all Portainer user tokens List all API keys for a Portainer user. Returns an array of API key objects, each with an id and additional attributes defined in the upstream portainer.APIKey schema. Required: user_id.
• Create Create a Portainer user token Create a new API access token for a Portainer user. Only the calling user can generate a token for themselves. Returns: id. Required: user_id. Password is required only for internal authentication.
• Delete Delete a Portainer user token by ID Delete an API key (user token) associated with a Portainer user. Returns an empty 204 response on success. Required: user_id, id.
• List List all Portainer admin checks Check if an administrator account exists in the Portainer database. Returns an empty 204 response on success; a 404 indicates no administrator user has been initialized yet.
• Create Create a Portainer admin init Initialize the Portainer administrator user account on an uninitialized instance. Returns the created admin user object. Returns 409 if an admin is already initialized.
• Create Create a Portainer upload tl Upload a TLS file (CA, certificate, or key) to Portainer. The file is stored in a specified folder which is created if it does not already exist. Returns an empty 204 response on success. Required: certificate, folder, file.
• List List all Portainer stacks List all Portainer stacks based on the current user's authorizations. Returns: Id, Name. Limited stacks are not returned by this endpoint.
• Get Get single Portainer stack by ID Get a single Portainer stack by id. Returns: Id, Name. Required: id.
• Update Update a Portainer stack by ID Update a file-based Portainer stack by id. Returns: id, Name. Required: id, endpointId. Only for file-based stacks.
• Delete Delete a Portainer stack by ID Delete a Portainer stack by id. Returns an empty 204 response on success. Required: id, endpointId.
• Start Portainer stacks start Start a stopped Portainer stack. Returns the stack object including Id, Name, EndpointID, SwarmID, and Env. Required: stack_id, endpointId. Fails with 409 if the stack is already active, deploying, or in error state.
• Update Portainer stack associates bulk update Associate an orphaned Portainer stack to a new environment(endpoint). Returns the updated stack object including Id, Name, EndpointID, and SwarmID. Required: id, endpointId, swarmId, orphanedRunning.
• List List all Portainer stack files Get the stack file content for a specific Portainer stack. Returns: StackFileContent. Required: stack_id.
• Create Create a Portainer stack git Update Git configuration for a Portainer stack, including repository reference name and auto-update settings. When SourceID is set, URL/auth/TLS are inherited from the referenced Source. Returns: Id. Required: stack_id.
• Update Portainer git redeploys bulk update Redeploy a Portainer stack by pulling its latest configuration from Git and reapplying it. Returns the updated stack object including id, name, and type. Required: id.
• Create Create a Portainer stack migrate Migrate a Portainer stack to another environment(endpoint), re-creating it in the target before removing the original. Returns the migrated stack with Id, Name, EndpointID, and SwarmID. Required: stack_id. Fails with 409 if a stack with the same name already runs on the target.
• Create Create a Portainer kubernetes repository Deploy a new Kubernetes stack in Portainer from a git repository into a specified environment. Returns the created stack object including id, name, type, and status. Required: endpointId and a stack config request body.
• Create Create a Portainer kubernetes string Deploy a new Kubernetes stack from inline manifest text in Portainer. Returns the created Stack object including id, name, and endpointId. Required: endpointId.
• Create Create a Portainer kubernetes URL Deploy a new Kubernetes stack from a manifest URL in Portainer. Returns the created stack object including its Id. Required: endpointId and a stack config request body.
• Create Create a Portainer standalone file Deploy a new standalone compose stack from a file upload in Portainer. Returns the created stack object including its id, name, and endpointId. Required: endpointId and Name.
• Create Create a Portainer standalone repository Deploy a new compose stack from a Git repository into a Portainer Docker environment. Returns the created portainer.Stack object including Id, Name, Type, EndpointID, and Status. Required: endpointId.
• Create Create a Portainer standalone string Deploy a new standalone compose stack from inline text content into a Portainer Docker environment. Returns the created stack object including its Id, Name, and EndpointId. Required: endpointId, Name, StackFileContent.
• Create Create a Portainer swarm file Deploy a new swarm stack from a file upload in Portainer. Returns the created stack object including its id and stack attributes. Required: endpointId, Name, SwarmID, file.
• Create Create a Portainer swarm repository Deploy a new swarm stack from a Git repository into a Portainer Docker environment. Returns the created stack object including Id, Name, Status, and EndpointId. Required: endpointId.
• Create Create a Portainer swarm string Deploy a new swarm stack in Portainer from inline compose file text. Returns the created stack object including Id, Name, Type, EndpointId, SwarmId, and Status. Required: endpointId, Name, SwarmID, StackFileContent.
• Delete Portainer stacks names bulk delete Delete a Portainer Kubernetes stack by name. Returns an empty 204 response on success. Required: name, endpointId.
• Create Create a Portainer stacks webhook Trigger a Portainer stack git update via webhook. Returns a success response with no body. A 409 is returned if autoupdate for the stack is unavailable or a stack deployment is already in progress. Required: webhook_id.
• List List all Portainer registries List all registries in Portainer based on the current user's authorizations. Administrators see all registries; non-admin users see only authorized ones. Returns: Id, URL.
• Create Create a Portainer registry Create a new registry in Portainer. Returns the created registry object including Id and URL. A 409 is returned if another registry with the same name or same URL and credentials already exists. Required: URL.
• Get Get single Portainer registry by ID Get a single Portainer registry by id. Returns: Id, Name, URL. Required: id.
• Update Update a Portainer registry by ID Update a Portainer registry by id. Returns the updated registry object including Id, Name, and URL. Required: id.
• Delete Delete a Portainer registry by ID Delete a Portainer registry by id. Returns an empty 204 response on success. Required: id.
• Create Create a Portainer registrie configure Configure a registry in Portainer by submitting a registry configuration payload. Returns an empty 204 response on success. Required: registry_id.
• Create Create a Portainer registries ping Test connection to a registry in Portainer using provided credentials before persisting it. Returns a response indicating whether the registry connection test was successful. Required: the request body containing registry credentials.
• List List all Portainer webhooks List Portainer webhooks, optionally filtered by endpoint and resource. Returns: ID. The filters parameter accepts a JSON string with EndpointID and ResourceID keys.
• Create Create a Portainer webhook Create a Portainer webhook for a specific resource. Returns: ID. Required: ResourceID, EndpointID. Returns 409 if a webhook for this resource already exists.
• Update Update a Portainer webhook by ID Update a Portainer webhook by id. Returns: ID. Required: id.
• Delete Delete a Portainer webhook by ID Delete a Portainer webhook by id. Returns an empty 202 response on success. Required: id.
• Execute Portainer webhooks execute Execute a Portainer webhook by its token UUID to restart the associated Docker service. Returns an empty 202 response on success. Required: webhook_id.
• Create Create a Portainer backup Create a Portainer system data snapshot backup archive that can be used to restore the system. Accepts a password in the request body to encrypt the backup. Returns the backup archive as a binary file download on success.
• Create Create a Portainer restore Trigger a system restore in Portainer using a provided backup file. Returns an empty 200 response on success. Requires a restore request payload containing the backup file data.
• List List all Portainer custom templates List available custom templates in Portainer, optionally filtered by template type and edge status. Returns: id, Description, Type. Required: type.
• Get Get single Portainer custom template by ID Get a single custom template by id in Portainer. Returns: id, Description, Type. Required: id.
• Update Update a Portainer custom template by ID Update a custom template in Portainer by id. Returns the updated template including id, Title, Description, Platform, Type, Logo, and Variables. Required: id.
• Delete Delete a Portainer custom template by ID Delete a custom template in Portainer by id. Returns an empty 204 response on success. Required: id.
• List List all Portainer custom template files Retrieve the stack file content for a Portainer custom template. Returns: FileContent containing the file's text content. Required: custom_template_id.
• Update Portainer custom template git fetches bulk update Fetch the latest config file content from a Portainer custom template's git repository configuration. Returns the file response containing FileContent. Required: id.
• Create Create a Portainer create file Create a Portainer custom template by uploading a file. Returns the created custom template object including its id, title, description, platform, and type. Required: Title, Description, Note, Platform, Type, File.
• Create Create a Portainer create repository Create an EdgeStack from a git repository in Portainer. Returns the created EdgeStack object including its Id, Name, DeploymentType, and EdgeGroups. Requires a stack configuration request body with git repository details. Edge compute features must be enabled.
• Create Create a Portainer create string Create a Portainer custom template from inline file content provided as a string. Returns: id, Description, Type. Required: Title, Description, Note, Platform, Type, FileContent.
• List List all Portainer container gpus Fetch GPU device data for a specific Docker container in a Portainer environment. Returns: gpus, with each GPU entry including name and value. Required: environment_id, container_id.
• List List all Portainer dashboards Get Docker dashboard counters for a Portainer environment. Returns a summary of resource counters for the specified environment. Required: environment_id.
• List List all Portainer images List Docker images in a Portainer environment. Returns image objects with id and attributes whose fields are defined by the upstream Portainer API schema. Required: environment_id.
• Action Portainer edge jobs attach log Update the logs collected from a Portainer Edge Job on a specific environment. Returns an empty 200 response on success. Required: endpoint_id, job_id.
• List List all Portainer edge jobs List all Portainer EdgeJobs. Returns: id.
• Get Get single Portainer edge job by ID Get a single Portainer EdgeJob by id. Returns: id, Name. Required: id.
• Update Update a Portainer edge job by ID Update a Portainer EdgeJob by id. Returns the updated EdgeJob including id, Name, CronExpression, EdgeGroups, Endpoints, Recurring, and Created. Required: id.
• Delete Delete a Portainer edge job by ID Delete a Portainer EdgeJob by id. Returns an empty 204 response on success. Required: id.
• List List all Portainer edge stacks List Portainer EdgeStacks. Returns an array of EdgeStack objects including Id, Name, EdgeGroups, DeploymentType, and Registries.
• Get Get single Portainer edge stack by ID Get a single Portainer EdgeStack by id. Returns the EdgeStack object including Id, Name, EdgeGroups, DeploymentType, and Registries. Required: id.
• Update Update a Portainer edge stack by ID Update a Portainer EdgeStack by id with new EdgeStack data. Returns the updated EdgeStack object including Id, Name, EdgeGroups, DeploymentType, and Registries. Required: id.
• Delete Delete a Portainer edge stack by ID Delete a Portainer EdgeStack by id. Returns an empty 204 response on success. Required: id.
• List List all Portainer edge status Get the edge environment status for a specific Portainer environment. Returns the edge environment status response object whose field-level details are not available in the discovered source.
• List List all Portainer edge groups List all Portainer EdgeGroups. Returns decorated EdgeGroup records including id and attributes from the upstream edgegroups.decoratedEdgeGroup schema. Edge compute features must be enabled.
• Create Create a Portainer edge group Create a Portainer EdgeGroup. Returns the created EdgeGroup including id and attributes from the upstream portainer.EdgeGroup schema. Required: attributes.
• Get Get single Portainer edge group by ID Get a single Portainer EdgeGroup by id. Returns: id. Required: id.
• Update Update a Portainer edge group by ID Update a Portainer EdgeGroup by id. Returns the updated EdgeGroup including id and attributes from the upstream portainer.EdgeGroup schema. Required: id, attributes.
• Delete Delete a Portainer edge group by ID Delete a Portainer EdgeGroup by id. Returns an empty 204 response on success. Cannot delete an EdgeGroup that is in use by an Edge stack or Edge job. Required: id.
• List List all Portainer edge job files Fetch the file content of an EdgeJob in Portainer. Returns: FileContent. Required: edge_job_id.
• List List all Portainer edge job tasks List tasks for a Portainer Edge Job. Returns task container objects with id and schema-specific attributes defined by the upstream edgejobs.taskContainer schema. Required: edge_job_id.
• List Portainer edge job tasks list logs Fetch the log for a specific task on a Portainer Edge Job. Returns a file response object with id and schema-specific attributes defined by the upstream edgejobs.fileResponse schema. Required: edge_job_id, task_id.
• Action Portainer edge job tasks attach log Collect the log for a specific task on a Portainer Edge Job. Returns an empty 204 response on success. Required: edge_job_id, task_id.
• Delete Portainer edge job tasks bulk delete Clear the log for a specific task on a Portainer Edge Job. Returns an empty 204 response on success. Required: edge_job_id, task_id.
• List List all Portainer edge stack files Fetch the stack file content for a Portainer Edge Stack by its id. Returns: StackFileContent. Required: edge_stack_id.
• Update Portainer edge stack status bulk update Update the deployment status of a Portainer EdgeStack. Called by an Edge Environment to report its stack deployment status. Returns the updated EdgeStack object including Id, Name, and DeploymentType. Required: id.
• List List all Portainer endpoint groups List all Portainer environment groups based on current user authorizations; administrators see all groups while other users see only authorized ones. Returns: id. The size parameter includes endpoint counts and type breakdown per group.
• Create Create a Portainer endpoint group Create a new Portainer environment group. Returns the created group with its id and attributes.
• Get Get single Portainer endpoint group by ID Get a single Portainer environment group by id. Returns: id. Required: id. The size parameter includes endpoint counts and type breakdown.
• Update Update a Portainer endpoint group by ID Update a Portainer environment group by id. Returns the updated group with its id and attributes. Required: id.
• Delete Delete a Portainer endpoint group by ID Delete a Portainer environment group by id. Returns an empty 204 response on success. Required: id.
• Update Update a Portainer endpoint group endpoint by ID Add an environment (endpoint) to an environment (endpoint) group in Portainer. Returns an empty 204 response on success. Required: endpoint_group_id, id.
• Delete Delete a Portainer endpoint group endpoint by ID Remove an environment (endpoint) from an environment (endpoint) group in Portainer. Returns an empty 204 response on success. Required: endpoint_group_id, id.
• Create Create a Portainer file preview Preview the content of a target file in a git repository in Portainer. Retrieves the compose file content based on the provided git repository configuration. Returns: FileContent. Requires a request body with repository file preview details.
• List List all Portainer gitops sources List all GitOps sources in Portainer, returning a deduplicated list of git repositories used across all GitOps workflows. Returns: id, name, url, type. Filter by status or source type, sort by name, status, or type.
• Get Get single Portainer gitops source by ID Get a single GitOps source in Portainer by id, including its connection settings and linked workflows. Returns: id, name, url, type. Required: id.
• Update Update a Portainer gitops source by ID Update an existing GitOps source in Portainer backed by a Git repository. Returns the updated source including id, name, url, and type. Required: id.
• Delete Delete a Portainer gitops source by ID Delete an existing GitOps source in Portainer by id. Returns an empty 204 response on success. A 409 is returned if the source is still referenced by workflows or custom templates. Required: id.
• Update Portainer source acceses bulk update Update the access control settings for an existing GitOps source in Portainer. Returns the updated source object including id, name, status, type, and url. Required: id and a source access control payload.
• Create Create a Portainer source test Test the connection of a stored GitOps source in Portainer, applying optional connection overrides to the stored configuration. Returns a connection test result object. Required: source_id.
• Create Create a Portainer sources git Create a new GitOps Git source in Portainer backed by a Git repository. Returns: ID, Name, URL, Status, Type. Required: URL. Returns 409 if a source with the same URL and credentials already exists.
• List List all Portainer sources summaries Summarize GitOps source status counts in Portainer. Returns a count of sources per status: healthy, syncing, error, paused, and unknown. No parameters required.
• Create Create a Portainer sources test Test connectivity for Git connection details in Portainer before persisting them as a source. Returns a connection test result indicating whether the repository is reachable. Required: Git connection details body with repository URL and credentials to validate.
• List List all Portainer gitops workflows List all GitOps workflows in Portainer — stacks with GitConfig enabled across all environments. Returns: id, name, type. Supports filtering by status, type, platform, and environment IDs, and sorting by name, type, status, creationDate, or lastSyncDate.
• List List all Portainer workflows summaries Summarize Portainer GitOps workflow status counts across all environments. Returns: healthy, syncing, error, paused, unknown (integer count of workflows in each status).
• List List all Portainer kubernetes helms List Helm releases in a Portainer Kubernetes environment. Returns each release with name, namespace, and additional release attributes from the upstream schema. Required: endpoint_id.
• Create Create a Portainer kubernetes helm Install a Helm chart in a Portainer Kubernetes environment. Returns: id. Required: endpoint_id.
• Delete Delete a Portainer kubernetes helm by ID Delete a Helm release by id in a Portainer Kubernetes environment. Returns an empty 204 response on success. Required: endpoint_id, id.
• List Portainer kubernetes helms list history List the revision history of a Helm release in a Portainer Kubernetes environment. Returns each historical revision with name, namespace, revision, and additional release attributes from the upstream schema. Required: endpoint_id, release.
• Get Get single Portainer kubernetes helm by ID Get a specific Helm release by release name in a Portainer Kubernetes environment. Returns: name, namespace, chart, config, info, manifest, hooks, version. Required: endpoint_id, id.
• Create Create a Portainer rollback Rollback a Helm release to a previous revision in a Portainer Kubernetes environment. Returns the rolled-back Helm release object. Required: endpoint_id, release.
• List List all Portainer templates helms Search Helm charts in a Portainer Helm repository by repository URL and optional chart name. Returns the search results as a plain string. Required: repo.
• Get Get single Portainer templates helm by ID Get a Portainer Helm template by id. Returns the template information as a plain string. Required: id.
• List List all Portainer helm repositories List a Portainer user's helm repositories. Returns: url. Required: user_id.
• Create Create a Portainer helm repository Create a helm repository for a Portainer user by providing a repository URL. Returns the created repository including url and global. Required: user_id, url.
• Delete Delete a Portainer helm repository by ID Delete a helm repository for a Portainer user by id. Returns an empty 204 response on success. Required: user_id, id.
• Create Create a Portainer ldap check Test LDAP connectivity in Portainer by submitting LDAP connection details. Returns an empty 204 response on success. Required: LDAP details request body (defined by the ldap.checkPayload schema upstream).
• List List all Portainer motds Fetch the Portainer message of the day (MOTD). Returns the motd object as defined by the upstream motd.Motd schema; the specific fields are not enumerated in the discovered API documentation.
• Create Create a Portainer resource control Create a new resource control in Portainer to restrict access to a Docker resource. Returns: id. Required: a resource control details body. Fails if a resource control is already associated with the target resource.
• Update Update a Portainer resource control by ID Update an existing resource control in Portainer by id. Returns: id. Required: id, a resource control details body.
• Delete Delete a Portainer resource control by ID Remove a resource control in Portainer by id. Returns an empty 204 response on success. Required: id.
• List List all Portainer ssls Inspect the SSL settings in Portainer. Returns the current SSL configuration object as defined by the portainer.SSLSettings schema.
• Update Portainer ssls bulk update Update the SSL settings in Portainer. Accepts an SSL settings payload as defined by the ssl.sslUpdatePayload schema. Returns an empty 204 response on success.
• List List all Portainer status Check Portainer status. Returns: InstanceID, Version.

No tools match your search.