ryan/portainer_client
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
OpenAPI Client for Portainer
2 commits 1 branch 0 tags 907 KiB
  • Dart 100%
Find a file
Exact
SpongeManiac e355ad9d28 Add missing dependency
2026-09-16 02:43:56 -06:00
.openapi-generator Initial Commit Portainer API v2.37 2026-09-16 02:18:09 -06:00
doc Initial Commit Portainer API v2.37 2026-09-16 02:18:09 -06:00
lib Add missing dependency 2026-09-16 02:43:56 -06:00
test Initial Commit Portainer API v2.37 2026-09-16 02:18:09 -06:00
.gitignore Initial Commit Portainer API v2.37 2026-09-16 02:18:09 -06:00
.openapi-generator-ignore Initial Commit Portainer API v2.37 2026-09-16 02:18:09 -06:00
analysis_options.yaml Initial Commit Portainer API v2.37 2026-09-16 02:18:09 -06:00
pubspec.yaml Add missing dependency 2026-09-16 02:43:56 -06:00
README.md Initial Commit Portainer API v2.37 2026-09-16 02:18:09 -06:00

README.md

portainer_client (EXPERIMENTAL)

Portainer API is an HTTP API served by Portainer. It is used by the Portainer UI and everything you can do with the UI can be done using the HTTP API. Examples are available at https://documentation.portainer.io/api/api-examples/ You can find out more about Portainer at http://portainer.io and get some support on Slack.

Authentication

Most of the API environments(endpoints) require to be authenticated as well as some level of authorization to be used. Portainer API uses JSON Web Token to manage authentication and thus requires you to provide a token in the Authorization header of each request with the Bearer authentication mechanism.

Example:

Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwidXNlcm5hbWUiOiJhZG1pbiIsInJvbGUiOjEsImV4cCI6MTQ5OTM3NjE1NH0.NJ6vE8FY1WG6jsRQzfMqeatJ4vh2TWAeeYfDhP71YEE

Security

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

Different access policies are available:

  • Public access
  • Authenticated access
  • Restricted access
  • Administrator access

Public access

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

Authenticated access

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

Restricted access

Authentication is required to access the environments(endpoints) with this access policy. Extra-checks might be added to ensure access to the resource is granted. Returned data might also be filtered.

Administrator access

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

Execute Docker requests

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

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

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

Private Registry

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

Example:

eyJyZWdpc3RyeUlkIjoxfQ==

NOTE: You can find more information on how to query the Docker API in the Docker official documentation as well as in this Portainer example.

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: 2.37.0
  • Generator version: 7.19.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  portainer_client: 1.0.0

Github

If this Dart package is published to Github, please include the following in pubspec.yaml

dependencies:
  portainer_client:
    git:
      url: https://github.com/GIT_USER_ID/GIT_REPO_ID.git
      #ref: main

Local development

To use the package from your local drive, please include the following in pubspec.yaml

dependencies:
  portainer_client:
    path: /path/to/portainer_client

Getting Started

Please follow the installation procedure and then run the following:

import 'package:portainer_client/portainer_client.dart';


final api = PortainerV237().getAuthApi();
final AuthAuthenticatePayload body = ; // AuthAuthenticatePayload | Credentials used for authentication

try {
    final response = await api.authenticateUser(body);
    print(response);
} on DioException catch (e) {
    print("Exception when calling AuthApi->authenticateUser: $e\n");
}

Documentation for API Endpoints

All URIs are relative to /api

Class Method HTTP request Description
AuthApi authenticateUser POST /auth Authenticate
AuthApi logout POST /auth/logout Logout
AuthApi validateOAuth POST /auth/oauth/validate Authenticate with OAuth
BackupApi backup POST /backup Creates an archive with a system data snapshot that could be used to restore the system.
BackupApi restore POST /restore Triggers a system restore using provided backup file
CustomTemplatesApi customTemplateCreateFile POST /custom_templates/create/file Create a custom template
CustomTemplatesApi customTemplateCreateRepository POST /custom_templates/create/repository Create a custom template
CustomTemplatesApi customTemplateCreateString POST /custom_templates/create/string Create a custom template
CustomTemplatesApi customTemplateDelete DELETE /custom_templates/{id} Remove a template
CustomTemplatesApi customTemplateFile GET /custom_templates/{id}/file Get Template stack file content.
CustomTemplatesApi customTemplateGitFetch PUT /custom_templates/{id}/git_fetch Fetch the latest config file content based on custom template's git repository configuration
CustomTemplatesApi customTemplateInspect GET /custom_templates/{id} Inspect a custom template
CustomTemplatesApi customTemplateList GET /custom_templates List available custom templates
CustomTemplatesApi customTemplateUpdate PUT /custom_templates/{id} Update a template
DockerApi dockerContainerGpusInspect GET /docker/{environmentId}/containers/{containerId}/gpus Fetch container gpus data
DockerApi dockerDashboard GET /docker/{environmentId}/dashboard Get counters for the dashboard
DockerApi dockerImagesList GET /docker/{environmentId}/images Fetch images
EdgeApi endpointsIdEdgeJobsJobIDLogsPost POST /endpoints/{id}/edge/jobs/{jobID}/logs Update the logs collected from an Edge Job
EdgeApi endpointsIdEdgeStacksStackIdGet GET /endpoints/{id}/edge/stacks/{stackId} Inspect an Edge Stack for an Environment(Endpoint)
EdgeGroupsApi edgeGroupCreate POST /edge_groups Create an EdgeGroup
EdgeGroupsApi edgeGroupDelete DELETE /edge_groups/{id} Deletes an EdgeGroup
EdgeGroupsApi edgeGroupInspect GET /edge_groups/{id} Inspects an EdgeGroup
EdgeGroupsApi edgeGroupList GET /edge_groups list EdgeGroups
EdgeGroupsApi edgeGroupUpdate PUT /edge_groups/{id} Updates an EdgeGroup
EdgeJobsApi edgeJobCreateFile POST /edge_jobs/create/file Create an EdgeJob from a file
EdgeJobsApi edgeJobCreateString POST /edge_jobs/create/string Create an EdgeJob from a text
EdgeJobsApi edgeJobDelete DELETE /edge_jobs/{id} Delete an EdgeJob
EdgeJobsApi edgeJobFile GET /edge_jobs/{id}/file Fetch a file of an EdgeJob
EdgeJobsApi edgeJobInspect GET /edge_jobs/{id} Inspect an EdgeJob
EdgeJobsApi edgeJobList GET /edge_jobs Fetch EdgeJobs list
EdgeJobsApi edgeJobTaskLogsInspect GET /edge_jobs/{id}/tasks/{taskID}/logs Fetch the log for a specifc task on an EdgeJob
EdgeJobsApi edgeJobTasksClear DELETE /edge_jobs/{id}/tasks/{taskID}/logs Clear the log for a specifc task on an EdgeJob
EdgeJobsApi edgeJobTasksCollect POST /edge_jobs/{id}/tasks/{taskID}/logs Collect the log for a specifc task on an EdgeJob
EdgeJobsApi edgeJobTasksList GET /edge_jobs/{id}/tasks Fetch the list of tasks on an EdgeJob
EdgeJobsApi edgeJobUpdate PUT /edge_jobs/{id} Update an EdgeJob
EdgeStacksApi edgeStackCreateFile POST /edge_stacks/create/file Create an EdgeStack from file
EdgeStacksApi edgeStackCreateRepository POST /edge_stacks/create/repository Create an EdgeStack from a git repository
EdgeStacksApi edgeStackCreateString POST /edge_stacks/create/string Create an EdgeStack from a text
EdgeStacksApi edgeStackDelete DELETE /edge_stacks/{id} Delete an EdgeStack
EdgeStacksApi edgeStackFile GET /edge_stacks/{id}/file Fetches the stack file for an EdgeStack
EdgeStacksApi edgeStackInspect GET /edge_stacks/{id} Inspect an EdgeStack
EdgeStacksApi edgeStackList GET /edge_stacks Fetches the list of EdgeStacks
EdgeStacksApi edgeStackStatusUpdate PUT /edge_stacks/{id}/status Update an EdgeStack status
EdgeStacksApi edgeStackUpdate PUT /edge_stacks/{id} Update an EdgeStack
EdgeStacksApi endpointsIdEdgeStacksStackIdGet GET /endpoints/{id}/edge/stacks/{stackId} Inspect an Edge Stack for an Environment(Endpoint)
EndpointGroupsApi endpointGroupAddEndpoint PUT /endpoint_groups/{id}/endpoints/{endpointId} Add an environment(endpoint) to an environment(endpoint) group
EndpointGroupsApi endpointGroupDelete DELETE /endpoint_groups/{id} Remove an environment(endpoint) group
EndpointGroupsApi endpointGroupDeleteEndpoint DELETE /endpoint_groups/{id}/endpoints/{endpointId} Removes environment(endpoint) from an environment(endpoint) group
EndpointGroupsApi endpointGroupList GET /endpoint_groups List Environment(Endpoint) groups
EndpointGroupsApi endpointGroupUpdate PUT /endpoint_groups/{id} Update an environment(endpoint) group
EndpointGroupsApi endpointGroupsIdGet GET /endpoint_groups/{id} Inspect an Environment(Endpoint) group
EndpointGroupsApi endpointGroupsPost POST /endpoint_groups Create an Environment(Endpoint) Group
EndpointsApi endpointAssociationDelete PUT /endpoints/{id}/association De-association an edge environment(endpoint)
EndpointsApi endpointCreate POST /endpoints Create a new environment(endpoint)
EndpointsApi endpointCreateGlobalKey POST /endpoints/global-key Create or retrieve the endpoint for an EdgeID
EndpointsApi endpointDelete DELETE /endpoints/{id} Remove an environment
EndpointsApi endpointDeleteBatch POST /endpoints/delete Remove multiple environments
EndpointsApi endpointDeleteBatchDeprecated DELETE /endpoints Remove multiple environments
EndpointsApi endpointDockerhubStatus GET /endpoints/{id}/dockerhub/{registryId} fetch docker pull limits
EndpointsApi endpointEdgeStatusInspect GET /endpoints/{id}/edge/status Get environment(endpoint) status
EndpointsApi endpointForceUpdateService PUT /endpoints/{id}/forceupdateservice force update a docker service
EndpointsApi endpointInspect GET /endpoints/{id} Inspect an environment(endpoint)
EndpointsApi endpointList GET /endpoints List environments(endpoints)
EndpointsApi endpointRegistriesList GET /endpoints/{id}/registries List Registries on environment
EndpointsApi endpointRegistryAccess PUT /endpoints/{id}/registries/{registryId} update registry access for environment
EndpointsApi endpointSettingsUpdate PUT /endpoints/{id}/settings Update settings for an environment(endpoint)
EndpointsApi endpointSnapshot POST /endpoints/{id}/snapshot Snapshots an environment(endpoint)
EndpointsApi endpointSnapshots POST /endpoints/snapshot Snapshot all environments(endpoints)
EndpointsApi endpointUpdate PUT /endpoints/{id} Update an environment(endpoint)
EndpointsApi endpointUpdateRelations PUT /endpoints/relations Update relations for a list of environments
EndpointsApi endpointsIdDockerV2BrowsePutPost POST /endpoints/{id}/docker/v2/browse/put Upload a file under a specific path on the file system of an environment (endpoint)
EndpointsApi endpointsIdEdgeJobsJobIDLogsPost POST /endpoints/{id}/edge/jobs/{jobID}/logs Update the logs collected from an Edge Job
EndpointsApi endpointsIdEdgeStacksStackIdGet GET /endpoints/{id}/edge/stacks/{stackId} Inspect an Edge Stack for an Environment(Endpoint)
GitopsApi gitOperationRepoFilePreview POST /gitops/repo/file/preview preview the content of target file in the git repository
HelmApi helmDelete DELETE /endpoints/{id}/kubernetes/helm/{release} Delete Helm Release
HelmApi helmGet GET /endpoints/{id}/kubernetes/helm/{name} Get a helm release
HelmApi helmGetHistory GET /endpoints/{id}/kubernetes/helm/{release}/history Get a historical list of releases
HelmApi helmInstall POST /endpoints/{id}/kubernetes/helm Install Helm Chart
HelmApi helmList GET /endpoints/{id}/kubernetes/helm List Helm Releases
HelmApi helmRepoSearch GET /templates/helm Search Helm Charts
HelmApi helmRollback POST /endpoints/{id}/kubernetes/helm/{release}/rollback Rollback a helm release
HelmApi helmShow GET /templates/helm/{command} Show Helm Chart Information
HelmApi helmUserRepositoriesList GET /users/{id}/helm/repositories List a users helm repositories
HelmApi helmUserRepositoryCreate POST /users/{id}/helm/repositories Create a user helm repository
HelmApi helmUserRepositoryDelete DELETE /users/{id}/helm/repositories/{repositoryID} Delete a users helm repositoryies
IntelApi deviceAction POST /open_amt/{id}/devices/{deviceId}/action Execute out of band action on an AMT managed device
IntelApi deviceFeatures POST /open_amt/{id}/devices_features/{deviceId} Enable features on an AMT managed device
IntelApi openAMTActivate POST /open_amt/{id}/activate Activate OpenAMT device and associate to agent endpoint
IntelApi openAMTConfigure POST /open_amt Enable Portainer's OpenAMT capabilities
IntelApi openAMTDevices GET /open_amt/{id}/devices Fetch OpenAMT managed devices information for endpoint
IntelApi openAMTHostInfo GET /open_amt/{id}/info Request OpenAMT info from a node
KubernetesApi createKubernetesIngress POST /kubernetes/{id}/namespaces/{namespace}/ingresses Create an Ingress
KubernetesApi createKubernetesNamespace POST /kubernetes/{id}/namespaces Create a namespace
KubernetesApi createKubernetesService POST /kubernetes/{id}/namespaces/{namespace}/services Create a service
KubernetesApi deleteClusterRoleBindings POST /kubernetes/{id}/cluster_role_bindings/delete Delete cluster role bindings
KubernetesApi deleteClusterRoles POST /kubernetes/{id}/cluster_roles/delete Delete cluster roles
KubernetesApi deleteCronJobs POST /kubernetes/{id}/cron_jobs/delete Delete Cron Jobs
KubernetesApi deleteJobs POST /kubernetes/{id}/jobs/delete Delete Jobs
KubernetesApi deleteKubernetesIngresses POST /kubernetes/{id}/ingresses/delete Delete one or more Ingresses
KubernetesApi deleteKubernetesNamespace DELETE /kubernetes/{id}/namespaces Delete a kubernetes namespace
KubernetesApi deleteKubernetesServices POST /kubernetes/{id}/services/delete Delete services
KubernetesApi deleteRoleBindings POST /kubernetes/{id}/role_bindings/delete Delete role bindings
KubernetesApi deleteRoles POST /kubernetes/{id}/roles/delete Delete roles
KubernetesApi deleteServiceAccounts POST /kubernetes/{id}/service_accounts/delete Delete service accounts
KubernetesApi describeResource GET /kubernetes/{id}/describe Get a description of a kubernetes resource
KubernetesApi drainNode POST /kubernetes/{id}/nodes/{name}/drain Drain a Kubernetes node
KubernetesApi getAllKubernetesApplications GET /kubernetes/{id}/applications Get a list of applications across all namespaces in the cluster. If the nodeName is provided, it will return the applications running on that node.
KubernetesApi getAllKubernetesApplicationsCount GET /kubernetes/{id}/applications/count Get Applications count
KubernetesApi getAllKubernetesClusterIngresses GET /kubernetes/{id}/ingresses Get kubernetes ingresses at the cluster level
KubernetesApi getAllKubernetesClusterIngressesCount GET /kubernetes/{id}/ingresses/count Get Ingresses count
KubernetesApi getAllKubernetesClusterRoleBindings GET /kubernetes/{id}/clusterrolebindings Get a list of kubernetes cluster role bindings
KubernetesApi getAllKubernetesClusterRoles GET /kubernetes/{id}/clusterroles Get a list of kubernetes cluster roles
KubernetesApi getAllKubernetesConfigMaps GET /kubernetes/{id}/configmaps Get a list of ConfigMaps
KubernetesApi getAllKubernetesConfigMapsCount GET /kubernetes/{id}/configmaps/count Get ConfigMaps count
KubernetesApi getAllKubernetesEvents GET /kubernetes/{id}/events Gets kubernetes events
KubernetesApi getAllKubernetesIngressControllers GET /kubernetes/{id}/ingresscontrollers Get a list of ingress controllers
KubernetesApi getAllKubernetesIngresses GET /kubernetes/{id}/namespaces/{namespace}/ingresses Get a list of Ingresses
KubernetesApi getAllKubernetesServicesCount GET /kubernetes/{id}/services/count Get services count
KubernetesApi getAllKubernetesVolumes GET /kubernetes/{id}/volumes Get Kubernetes volumes within the given Portainer environment
KubernetesApi getAllKubernetesVolumesCount GET /kubernetes/{id}/volumes/count Get the total number of kubernetes volumes within the given Portainer environment.
KubernetesApi getApplicationsResources GET /kubernetes/{id}/metrics/applications_resources Get the total resource requests and limits of all applications
KubernetesApi getKubernetesConfig GET /kubernetes/config Generate a kubeconfig file
KubernetesApi getKubernetesConfigMap GET /kubernetes/{id}/namespaces/{namespace}/configmaps/{configmap} Get a ConfigMap
KubernetesApi getKubernetesCronJobs GET /kubernetes/{id}/cron_jobs Get a list of kubernetes Cron Jobs
KubernetesApi getKubernetesDashboard GET /kubernetes/{id}/dashboard Get the dashboard summary data
KubernetesApi getKubernetesEventsForNamespace GET /kubernetes/{id}/namespaces/{namespace}/events Gets kubernetes events for namespace
KubernetesApi getKubernetesIngress GET /kubernetes/{id}/namespaces/{namespace}/ingresses/{ingress} Get an Ingress by name
KubernetesApi getKubernetesIngressControllersByNamespace GET /kubernetes/{id}/namespaces/{namespace}/ingresscontrollers Get a list ingress controllers by namespace
KubernetesApi getKubernetesJobs GET /kubernetes/{id}/jobs Get a list of kubernetes Jobs
KubernetesApi getKubernetesMaxResourceLimits GET /kubernetes/{id}/max_resource_limits Get max CPU and memory limits of all nodes within k8s cluster
KubernetesApi getKubernetesMetricsForAllNodes GET /kubernetes/{id}/metrics/nodes Get a list of nodes with their live metrics
KubernetesApi getKubernetesMetricsForAllPods GET /kubernetes/{id}/metrics/pods/{namespace} Get a list of pods with their live metrics
KubernetesApi getKubernetesMetricsForNode GET /kubernetes/{id}/metrics/nodes/{name} Get live metrics for a node
KubernetesApi getKubernetesMetricsForPod GET /kubernetes/{id}/metrics/pods/{namespace}/{name} Get live metrics for a pod
KubernetesApi getKubernetesNamespace GET /kubernetes/{id}/namespaces/{namespace} Get namespace details
KubernetesApi getKubernetesNamespaces GET /kubernetes/{id}/namespaces Get a list of namespaces
KubernetesApi getKubernetesNamespacesCount GET /kubernetes/{id}/namespaces/count Get the total number of kubernetes namespaces within the given Portainer environment.
KubernetesApi getKubernetesNodesLimits GET /kubernetes/{id}/nodes_limits Get CPU and memory limits of all nodes within k8s cluster
KubernetesApi getKubernetesRBACStatus GET /kubernetes/{id}/rbac_enabled Check if RBAC is enabled
KubernetesApi getKubernetesRoleBindings GET /kubernetes/{id}/rolebindings Get a list of kubernetes role bindings
KubernetesApi getKubernetesRoles GET /kubernetes/{id}/roles Get a list of kubernetes roles
KubernetesApi getKubernetesSecret GET /kubernetes/{id}/namespaces/{namespace}/secrets/{secret} Get a Secret
KubernetesApi getKubernetesSecrets GET /kubernetes/{id}/secrets Get a list of Secrets
KubernetesApi getKubernetesSecretsCount GET /kubernetes/{id}/secrets/count Get Secrets count
KubernetesApi getKubernetesServiceAccounts GET /kubernetes/{id}/serviceaccounts Get a list of kubernetes service accounts
KubernetesApi getKubernetesServices GET /kubernetes/{id}/services Get a list of services
KubernetesApi getKubernetesServicesByNamespace GET /kubernetes/{id}/namespaces/{namespace}/services Get a list of services for a given namespace
KubernetesApi getKubernetesVolume GET /kubernetes/{id}/volumes/{namespace}/{volume} Get a Kubernetes volume within the given Portainer environment
KubernetesApi getKubernetesVolumesInNamespace GET /kubernetes/{id}/namespaces/{namespace}/volumes Get Kubernetes volumes within a namespace in the given Portainer environment
KubernetesApi kubernetesNamespacesToggleSystem PUT /kubernetes/{id}/namespaces/{namespace}/system Toggle the system state for a namespace
KubernetesApi updateKubernetesIngress PUT /kubernetes/{id}/namespaces/{namespace}/ingresses Update an Ingress
KubernetesApi updateKubernetesIngressControllers PUT /kubernetes/{id}/ingresscontrollers Update (block/unblock) ingress controllers
KubernetesApi updateKubernetesIngressControllersByNamespace PUT /kubernetes/{id}/namespaces/{namespace}/ingresscontrollers Update (block/unblock) ingress controllers by namespace
KubernetesApi updateKubernetesNamespace PUT /kubernetes/{id}/namespaces/{namespace} Update a namespace
KubernetesApi updateKubernetesNamespaceDeprecated PUT /kubernetes/{id}/namespaces Update a namespace
KubernetesApi updateKubernetesService PUT /kubernetes/{id}/namespaces/{namespace}/services Update a service
LdapApi lDAPCheck POST /ldap/check Test LDAP connectivity
MotdApi mOTD GET /motd fetches the message of the day
RegistriesApi registryConfigure POST /registries/{id}/configure Configures a registry
RegistriesApi registryCreate POST /registries Create a new registry
RegistriesApi registryDelete DELETE /registries/{id} Remove a registry
RegistriesApi registryInspect GET /registries/{id} Inspect a registry
RegistriesApi registryList GET /registries List Registries
RegistriesApi registryPing POST /registries/ping Test registry connection
RegistriesApi registryUpdate PUT /registries/{id} Update a registry
ResourceControlsApi resourceControlCreate POST /resource_controls Create a new resource control
ResourceControlsApi resourceControlDelete DELETE /resource_controls/{id} Remove a resource control
ResourceControlsApi resourceControlUpdate PUT /resource_controls/{id} Update a resource control
RolesApi roleList GET /roles List roles
SettingsApi settingsInspect GET /settings Retrieve Portainer settings
SettingsApi settingsPublic GET /settings/public Retrieve Portainer public settings
SettingsApi settingsUpdate PUT /settings Update Portainer settings
SslApi sSLInspect GET /ssl Inspect the ssl settings
SslApi sSLUpdate PUT /ssl Update the ssl settings
StacksApi stackAssociate PUT /stacks/{id}/associate Associate an orphaned stack to a new environment(endpoint)
StacksApi stackCreateDockerStandaloneFile POST /stacks/create/standalone/file Deploy a new compose stack from a file
StacksApi stackCreateDockerStandaloneRepository POST /stacks/create/standalone/repository Deploy a new compose stack from repository
StacksApi stackCreateDockerStandaloneString POST /stacks/create/standalone/string Deploy a new compose stack from a text
StacksApi stackCreateDockerSwarmFile POST /stacks/create/swarm/file Deploy a new swarm stack from a file
StacksApi stackCreateDockerSwarmRepository POST /stacks/create/swarm/repository Deploy a new swarm stack from a git repository
StacksApi stackCreateDockerSwarmString POST /stacks/create/swarm/string Deploy a new swarm stack from a text
StacksApi stackCreateKubernetesFile POST /stacks/create/kubernetes/string Deploy a new kubernetes stack from a file
StacksApi stackCreateKubernetesGit POST /stacks/create/kubernetes/repository Deploy a new kubernetes stack from a git repository
StacksApi stackCreateKubernetesUrl POST /stacks/create/kubernetes/url Deploy a new kubernetes stack from a url
StacksApi stackDelete DELETE /stacks/{id} Remove a stack
StacksApi stackDeleteKubernetesByName DELETE /stacks/name/{name} Remove Kubernetes stacks by name
StacksApi stackFileInspect GET /stacks/{id}/file Retrieve the content of the Stack file for the specified stack
StacksApi stackGitRedeploy PUT /stacks/{id}/git/redeploy Redeploy a stack
StacksApi stackInspect GET /stacks/{id} Inspect a stack
StacksApi stackList GET /stacks List stacks
StacksApi stackMigrate POST /stacks/{id}/migrate Migrate a stack to another environment(endpoint)
StacksApi stackStart POST /stacks/{id}/start Starts a stopped Stack
StacksApi stackStop POST /stacks/{id}/stop Stops a stopped Stack
StacksApi stackUpdate PUT /stacks/{id} Update a stack
StacksApi stackUpdateGit POST /stacks/{id}/git Update a stack's Git configs
StacksApi webhookInvoke POST /stacks/webhooks/{webhookID} Webhook for triggering stack updates from git
StatusApi statusInspect GET /status Check Portainer status
SystemApi systemInfo GET /system/info Retrieve system info
SystemApi systemNodesCount GET /system/nodes Retrieve the count of nodes
SystemApi systemStatus GET /system/status Check Portainer status
SystemApi systemUpgrade POST /system/upgrade Upgrade Portainer to BE
SystemApi systemVersion GET /system/version Check for portainer updates
TagsApi tagCreate POST /tags Create a new tag
TagsApi tagDelete DELETE /tags/{id} Remove a tag
TagsApi tagList GET /tags List tags
TeamMembershipsApi teamMembershipCreate POST /team_memberships Create a new team membership
TeamMembershipsApi teamMembershipDelete DELETE /team_memberships/{id} Remove a team membership
TeamMembershipsApi teamMembershipList GET /team_memberships List team memberships
TeamMembershipsApi teamMembershipUpdate PUT /team_memberships/{id} Update a team membership
TeamMembershipsApi teamMemberships GET /teams/{id}/memberships List team memberships
TeamsApi teamCreate POST /teams Create a new team
TeamsApi teamDelete DELETE /teams/{id} Remove a team
TeamsApi teamInspect GET /teams/{id} Inspect a team
TeamsApi teamList GET /teams List teams
TeamsApi teamUpdate PUT /teams/{id} Update a team
TemplatesApi templateFile POST /templates/{id}/file Get a template's file
TemplatesApi templateList GET /templates List available templates
UploadApi uploadTLS POST /upload/tls/{certificate} Upload TLS files
UsersApi currentUserInspect GET /users/me Inspect the current user user
UsersApi userAdminCheck GET /users/admin/check Check administrator account existence
UsersApi userAdminInit POST /users/admin/init Initialize administrator account
UsersApi userCreate POST /users Create a new user
UsersApi userDelete DELETE /users/{id} Remove a user
UsersApi userGenerateAPIKey POST /users/{id}/tokens Generate an API key for a user
UsersApi userGetAPIKeys GET /users/{id}/tokens Get all API keys for a user
UsersApi userInspect GET /users/{id} Inspect a user
UsersApi userList GET /users List users
UsersApi userMembershipsInspect GET /users/{id}/memberships Inspect a user memberships
UsersApi userRemoveAPIKey DELETE /users/{id}/tokens/{keyID} Remove an api-key associated to a user
UsersApi userUpdate PUT /users/{id} Update a user
UsersApi userUpdatePassword PUT /users/{id}/passwd Update password for a user
WebhooksApi webhooksGet GET /webhooks List webhooks
WebhooksApi webhooksIdDelete DELETE /webhooks/{id} Delete a webhook
WebhooksApi webhooksIdPost POST /webhooks/{id} Execute a webhook
WebhooksApi webhooksIdPut PUT /webhooks/{id} Update a webhook
WebhooksApi webhooksPost POST /webhooks Create a webhook
WebsocketApi websocketAttachGet GET /websocket/attach Attach a websocket
WebsocketApi websocketExecGet GET /websocket/exec Execute a websocket
WebsocketApi websocketKubernetesShellGet GET /websocket/kubernetes-shell Execute a websocket on kubectl shell pod
WebsocketApi websocketPodGet GET /websocket/pod Execute a websocket on pod

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

  • Type: API key
  • API key parameter name: X-API-KEY
  • Location: HTTP header

jwt

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

info@portainer.io