portainer_api_with_docker_api

v2.9.3141

Published

2 years ago

portainer api 2.9.3 with docker api 1.41

Downloads

0High
0Medium
0Low

devil0153

portainer_api_with_docker_api

Portainer api 2.9.3 with Docker api 1.41

PortainerCeApi - JavaScript client for portainer_ce_api 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). 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 SDK is automatically generated by the Swagger Codegen project:

API version: 2.9.3
Package version: 2.9.3
Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install portainer_ce_api --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your portainer_ce_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('portainer_ce_api') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/YOUR_USERNAME/portainer_ce_api then install it via:

    npm install YOUR_USERNAME/portainer_ce_api --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var PortainerCeApi = require('portainer_ce_api');

var defaultClient = PortainerCeApi.ApiClient.instance;

// Configure API key authorization: jwt
var jwt = defaultClient.authentications['jwt'];
jwt.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//jwt.apiKeyPrefix['Authorization'] = "Token"

var api = new PortainerCeApi.DefaultApi()

var id = 56; // {Number} Team identifier

var body = new PortainerCeApi.TeamsTeamUpdatePayload(); // {TeamsTeamUpdatePayload} Team details


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.teamUpdate(id, body, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost/api

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- PortainerCeApi.DefaultApi | teamUpdate | PUT /team/{id} | Update a team PortainerCeApi.DefaultApi | userAdminInit | POST /users/admin/init | Initialize administrator account PortainerCeApi.AuthApi | authenticateUser | POST /auth | Authenticate PortainerCeApi.AuthApi | logout | POST /auth/logout | Logout PortainerCeApi.AuthApi | validateOAuth | POST /auth/oauth/validate | Authenticate with OAuth PortainerCeApi.BackupApi | backup | POST /backup | Creates an archive with a system data snapshot that could be used to restore the system. PortainerCeApi.BackupApi | restore | POST /restore | Triggers a system restore using provided backup file PortainerCeApi.ConfigApi | configCreate | POST /endpoints/{endpointId}/docker/configs/create | Create a config PortainerCeApi.ConfigApi | configDelete | DELETE /endpoints/{endpointId}/docker/configs/{id} | Delete a config PortainerCeApi.ConfigApi | configInspect | GET /endpoints/{endpointId}/docker/configs/{id} | Inspect a config PortainerCeApi.ConfigApi | configList | GET /endpoints/{endpointId}/docker/configs | List configs PortainerCeApi.ConfigApi | configUpdate | POST /endpoints/{endpointId}/docker/configs/{id}/update | Update a Config PortainerCeApi.ContainerApi | containerArchive | GET /endpoints/{endpointId}/docker/containers/{id}/archive | Get an archive of a filesystem resource in a container PortainerCeApi.ContainerApi | containerArchiveInfo | HEAD /endpoints/{endpointId}/docker/containers/{id}/archive | Get information about files in a container PortainerCeApi.ContainerApi | containerAttach | POST /endpoints/{endpointId}/docker/containers/{id}/attach | Attach to a container PortainerCeApi.ContainerApi | containerAttachWebsocket | GET /endpoints/{endpointId}/docker/containers/{id}/attach/ws | Attach to a container via a websocket PortainerCeApi.ContainerApi | containerChanges | GET /endpoints/{endpointId}/docker/containers/{id}/changes | Get changes on a container’s filesystem PortainerCeApi.ContainerApi | containerCreate | POST /endpoints/{endpointId}/docker/containers/create | Create a container PortainerCeApi.ContainerApi | containerDelete | DELETE /endpoints/{endpointId}/docker/containers/{id} | Remove a container PortainerCeApi.ContainerApi | containerExport | GET /endpoints/{endpointId}/docker/containers/{id}/export | Export a container PortainerCeApi.ContainerApi | containerInspect | GET /endpoints/{endpointId}/docker/containers/{id}/json | Inspect a container PortainerCeApi.ContainerApi | containerKill | POST /endpoints/{endpointId}/docker/containers/{id}/kill | Kill a container PortainerCeApi.ContainerApi | containerList | GET /endpoints/{endpointId}/docker/containers/json | List containers PortainerCeApi.ContainerApi | containerLogs | GET /endpoints/{endpointId}/docker/containers/{id}/logs | Get container logs PortainerCeApi.ContainerApi | containerPause | POST /endpoints/{endpointId}/docker/containers/{id}/pause | Pause a container PortainerCeApi.ContainerApi | containerPrune | POST /endpoints/{endpointId}/docker/containers/prune | Delete stopped containers PortainerCeApi.ContainerApi | containerRename | POST /endpoints/{endpointId}/docker/containers/{id}/rename | Rename a container PortainerCeApi.ContainerApi | containerResize | POST /endpoints/{endpointId}/docker/containers/{id}/resize | Resize a container TTY PortainerCeApi.ContainerApi | containerRestart | POST /endpoints/{endpointId}/docker/containers/{id}/restart | Restart a container PortainerCeApi.ContainerApi | containerStart | POST /endpoints/{endpointId}/docker/containers/{id}/start | Start a container PortainerCeApi.ContainerApi | containerStats | GET /endpoints/{endpointId}/docker/containers/{id}/stats | Get container stats based on resource usage PortainerCeApi.ContainerApi | containerStop | POST /endpoints/{endpointId}/docker/containers/{id}/stop | Stop a container PortainerCeApi.ContainerApi | containerTop | GET /endpoints/{endpointId}/docker/containers/{id}/top | List processes running inside a container PortainerCeApi.ContainerApi | containerUnpause | POST /endpoints/{endpointId}/docker/containers/{id}/unpause | Unpause a container PortainerCeApi.ContainerApi | containerUpdate | POST /endpoints/{endpointId}/docker/containers/{id}/update | Update a container PortainerCeApi.ContainerApi | containerWait | POST /endpoints/{endpointId}/docker/containers/{id}/wait | Wait for a container PortainerCeApi.ContainerApi | putContainerArchive | PUT /endpoints/{endpointId}/docker/containers/{id}/archive | Extract an archive of files or folders to a directory in a container PortainerCeApi.CustomTemplatesApi | customTemplateCreate | POST /custom_templates | Create a custom template PortainerCeApi.CustomTemplatesApi | customTemplateDelete | DELETE /custom_templates/{id} | Remove a template PortainerCeApi.CustomTemplatesApi | customTemplateFile | GET /custom_templates/{id}/file | Get Template stack file content. PortainerCeApi.CustomTemplatesApi | customTemplateInspect | GET /custom_templates/{id} | Inspect a custom template PortainerCeApi.CustomTemplatesApi | customTemplateList | GET /custom_templates | List available custom templates PortainerCeApi.CustomTemplatesApi | customTemplateUpdate | PUT /custom_templates/{id} | Update a template PortainerCeApi.DistributionApi | distributionInspect | GET /endpoints/{endpointId}/docker/distribution/{name}/json | Get image information from the registry PortainerCeApi.EdgeApi | endpointsIdEdgeJobsJobIDLogsPost | POST /endpoints/{id}/edge/jobs/{jobID}/logs | Inspect an EdgeJob Log PortainerCeApi.EdgeApi | endpointsIdEdgeStacksStackIdGet | GET /endpoints/{id}/edge/stacks/{stackId} | Inspect an Edge Stack for an Environment(Endpoint) PortainerCeApi.EdgeGroupsApi | edgeGroupCreate | POST /edge_groups | Create an EdgeGroup PortainerCeApi.EdgeGroupsApi | edgeGroupDelete | DELETE /edge_groups/{id} | Deletes an EdgeGroup PortainerCeApi.EdgeGroupsApi | edgeGroupInspect | GET /edge_groups/{id} | Inspects an EdgeGroup PortainerCeApi.EdgeGroupsApi | edgeGroupList | GET /edge_groups | list EdgeGroups PortainerCeApi.EdgeGroupsApi | egeGroupUpdate | PUT /edge_groups/{id} | Updates an EdgeGroup PortainerCeApi.EdgeJobsApi | edgeJobCreate | POST /edge_jobs | Create an EdgeJob PortainerCeApi.EdgeJobsApi | edgeJobDelete | DELETE /edge_jobs/{id} | Delete an EdgeJob PortainerCeApi.EdgeJobsApi | edgeJobFile | GET /edge_jobs/{id}/file | Fetch a file of an EdgeJob PortainerCeApi.EdgeJobsApi | edgeJobInspect | GET /edge_jobs/{id} | Inspect an EdgeJob PortainerCeApi.EdgeJobsApi | edgeJobList | GET /edge_jobs | Fetch EdgeJobs list PortainerCeApi.EdgeJobsApi | edgeJobTaskLogsInspect | GET /edge_jobs/{id}/tasks/{taskID}/logs | Fetch the log for a specifc task on an EdgeJob PortainerCeApi.EdgeJobsApi | edgeJobTasksClear | DELETE /edge_jobs/{id}/tasks/{taskID}/logs | Clear the log for a specifc task on an EdgeJob PortainerCeApi.EdgeJobsApi | edgeJobTasksCollect | POST /edge_jobs/{id}/tasks/{taskID}/logs | Collect the log for a specifc task on an EdgeJob PortainerCeApi.EdgeJobsApi | edgeJobTasksList | GET /edge_jobs/{id}/tasks | Fetch the list of tasks on an EdgeJob PortainerCeApi.EdgeJobsApi | edgeJobUpdate | POST /edge_jobs/{id} | Update an EdgeJob PortainerCeApi.EdgeStacksApi | edgeStackCreate | POST /edge_stacks | Create an EdgeStack PortainerCeApi.EdgeStacksApi | edgeStackDelete | DELETE /edge_stacks/{id} | Delete an EdgeStack PortainerCeApi.EdgeStacksApi | edgeStackFile | GET /edge_stacks/{id}/file | Fetches the stack file for an EdgeStack PortainerCeApi.EdgeStacksApi | edgeStackInspect | GET /edge_stacks/{id} | Inspect an EdgeStack PortainerCeApi.EdgeStacksApi | edgeStackList | GET /edge_stacks | Fetches the list of EdgeStacks PortainerCeApi.EdgeStacksApi | edgeStackStatusUpdate | PUT /edge_stacks/{id}/status | Update an EdgeStack status PortainerCeApi.EdgeStacksApi | edgeStackUpdate | PUT /edge_stacks/{id} | Update an EdgeStack PortainerCeApi.EdgeStacksApi | endpointsIdEdgeStacksStackIdGet | GET /endpoints/{id}/edge/stacks/{stackId} | Inspect an Edge Stack for an Environment(Endpoint) PortainerCeApi.EdgeTemplatesApi | edgeTemplateList | GET /edge_templates | Fetches the list of Edge Templates PortainerCeApi.EndpointGroupsApi | endpointGroupAddEndpoint | PUT /endpoint_groups/{id}/endpoints/{endpointId} | Add an environment(endpoint) to an environment(endpoint) group PortainerCeApi.EndpointGroupsApi | endpointGroupDelete | DELETE /endpoint_groups/{id} | Remove an environment(endpoint) group PortainerCeApi.EndpointGroupsApi | endpointGroupDeleteEndpoint | DELETE /endpoint_groups/{id}/endpoints/{endpointId} | Removes environment(endpoint) from an environment(endpoint) group PortainerCeApi.EndpointGroupsApi | endpointGroupList | GET /endpoint_groups | List Environment(Endpoint) groups PortainerCeApi.EndpointGroupsApi | endpointGroupUpdate | PUT /endpoint_groups/{id} | Update an environment(endpoint) group PortainerCeApi.EndpointGroupsApi | endpointGroupsIdGet | GET /endpoint_groups/{id} | Inspect an Environment(Endpoint) group PortainerCeApi.EndpointGroupsApi | endpointGroupsPost | POST /endpoint_groups | Create an Environment(Endpoint) Group PortainerCeApi.EndpointsApi | endpointAssociationDelete | PUT /api/endpoints/{id}/association | De-association an edge environment(endpoint) PortainerCeApi.EndpointsApi | endpointCreate | POST /endpoints | Create a new environment(endpoint) PortainerCeApi.EndpointsApi | endpointDelete | DELETE /endpoints/{id} | Remove an environment(endpoint) PortainerCeApi.EndpointsApi | endpointInspect | GET /endpoints/{id} | Inspect an environment(endpoint) PortainerCeApi.EndpointsApi | endpointList | GET /endpoints | List environments(endpoints) PortainerCeApi.EndpointsApi | endpointSettingsUpdate | PUT /api/endpoints/{id}/settings | Update settings for an environments(endpoints) PortainerCeApi.EndpointsApi | endpointSnapshot | POST /endpoints/{id}/snapshot | Snapshots an environments(endpoints) PortainerCeApi.EndpointsApi | endpointSnapshots | POST /endpoints/snapshot | Snapshot all environments(endpoints) PortainerCeApi.EndpointsApi | endpointStatusInspect | GET /endpoints/{id}/status | Get environment(endpoint) status PortainerCeApi.EndpointsApi | endpointUpdate | PUT /endpoints/{id} | Update an environment(endpoint) PortainerCeApi.EndpointsApi | endpointsIdEdgeJobsJobIDLogsPost | POST /endpoints/{id}/edge/jobs/{jobID}/logs | Inspect an EdgeJob Log PortainerCeApi.EndpointsApi | endpointsIdEdgeStacksStackIdGet | GET /endpoints/{id}/edge/stacks/{stackId} | Inspect an Edge Stack for an Environment(Endpoint) PortainerCeApi.ExecApi | containerExec | POST /endpoints/{endpointId}/docker/containers/{id}/exec | Create an exec instance PortainerCeApi.ExecApi | execInspect | GET /endpoints/{endpointId}/docker/exec/{id}/json | Inspect an exec instance PortainerCeApi.ExecApi | execResize | POST /endpoints/{endpointId}/docker/exec/{id}/resize | Resize an exec instance PortainerCeApi.ExecApi | execStart | POST /endpoints/{endpointId}/docker/exec/{id}/start | Start an exec instance PortainerCeApi.HelmApi | helmDelete | DELETE /endpoints/{id}/kubernetes/helm/{release} | Delete Helm Release PortainerCeApi.HelmApi | helmInstall | POST /endpoints/{id}/kubernetes/helm | Install Helm Chart PortainerCeApi.HelmApi | helmList | GET /endpoints/{id}/kubernetes/helm | List Helm Releases PortainerCeApi.HelmApi | helmRepoSearch | GET /templates/helm | Search Helm Charts PortainerCeApi.HelmApi | helmUserRepositoriesList | GET /endpoints/{id}/kubernetes/helm/repositories | List a users helm repositories PortainerCeApi.HelmApi | helmUserRepositoryCreate | POST /endpoints/{id}/kubernetes/helm/repositories | Create a user helm repository PortainerCeApi.HelmChartApi | helmShow | GET /templates/helm/{command} | Show Helm Chart Information PortainerCeApi.ImageApi | buildPrune | POST /endpoints/{endpointId}/docker/build/prune | Delete builder cache PortainerCeApi.ImageApi | imageBuild | POST /endpoints/{endpointId}/docker/build | Build an image PortainerCeApi.ImageApi | imageCommit | POST /endpoints/{endpointId}/docker/commit | Create a new image from a container PortainerCeApi.ImageApi | imageCreate | POST /endpoints/{endpointId}/docker/images/create | Create an image PortainerCeApi.ImageApi | imageDelete | DELETE /endpoints/{endpointId}/docker/images/{name} | Remove an image PortainerCeApi.ImageApi | imageGet | GET /endpoints/{endpointId}/docker/images/{name}/get | Export an image PortainerCeApi.ImageApi | imageGetAll | GET /endpoints/{endpointId}/docker/images/get | Export several images PortainerCeApi.ImageApi | imageHistory | GET /endpoints/{endpointId}/docker/images/{name}/history | Get the history of an image PortainerCeApi.ImageApi | imageInspect | GET /endpoints/{endpointId}/docker/images/{name}/json | Inspect an image PortainerCeApi.ImageApi | imageList | GET /endpoints/{endpointId}/docker/images/json | List Images PortainerCeApi.ImageApi | imageLoad | POST /endpoints/{endpointId}/docker/images/load | Import images PortainerCeApi.ImageApi | imagePrune | POST /endpoints/{endpointId}/docker/images/prune | Delete unused images PortainerCeApi.ImageApi | imagePush | POST /endpoints/{endpointId}/docker/images/{name}/push | Push an image PortainerCeApi.ImageApi | imageSearch | GET /endpoints/{endpointId}/docker/images/search | Search images PortainerCeApi.ImageApi | imageTag | POST /endpoints/{endpointId}/docker/images/{name}/tag | Tag an image PortainerCeApi.KubernetesApi | getKubernetesConfig | GET /kubernetes/{id}/config | Generates kubeconfig file enabling client communication with k8s api server PortainerCeApi.KubernetesApi | getKubernetesNodesLimits | GET /kubernetes/{id}/nodes_limits | Get CPU and memory limits of all nodes within k8s cluster PortainerCeApi.KubernetesApi | kubernetesNamespacesToggleSystem | PUT /kubernetes/{id}/namespaces/{namespace}/system | Toggle the system state for a namespace PortainerCeApi.LdapApi | lDAPCheck | POST /ldap/check | Test LDAP connectivity PortainerCeApi.MotdApi | motdGet | GET /motd | fetches the message of the day PortainerCeApi.NetworkApi | networkConnect | POST /endpoints/{endpointId}/docker/networks/{id}/connect | Connect a container to a network PortainerCeApi.NetworkApi | networkCreate | POST /endpoints/{endpointId}/docker/networks/create | Create a network PortainerCeApi.NetworkApi | networkDelete | DELETE /endpoints/{endpointId}/docker/networks/{id} | Remove a network PortainerCeApi.NetworkApi | networkDisconnect | POST /endpoints/{endpointId}/docker/networks/{id}/disconnect | Disconnect a container from a network PortainerCeApi.NetworkApi | networkInspect | GET /endpoints/{endpointId}/docker/networks/{id} | Inspect a network PortainerCeApi.NetworkApi | networkList | GET /endpoints/{endpointId}/docker/networks | List networks PortainerCeApi.NetworkApi | networkPrune | POST /endpoints/{endpointId}/docker/networks/prune | Delete unused networks PortainerCeApi.NodeApi | nodeDelete | DELETE /endpoints/{endpointId}/docker/nodes/{id} | Delete a node PortainerCeApi.NodeApi | nodeInspect | GET /endpoints/{endpointId}/docker/nodes/{id} | Inspect a node PortainerCeApi.NodeApi | nodeList | GET /endpoints/{endpointId}/docker/nodes | List nodes PortainerCeApi.NodeApi | nodeUpdate | POST /endpoints/{endpointId}/docker/nodes/{id}/update | Update a node PortainerCeApi.PluginApi | getPluginPrivileges | GET /endpoints/{endpointId}/docker/plugins/privileges | Get plugin privileges PortainerCeApi.PluginApi | pluginCreate | POST /endpoints/{endpointId}/docker/plugins/create | Create a plugin PortainerCeApi.PluginApi | pluginDelete | DELETE /endpoints/{endpointId}/docker/plugins/{name} | Remove a plugin PortainerCeApi.PluginApi | pluginDisable | POST /endpoints/{endpointId}/docker/plugins/{name}/disable | Disable a plugin PortainerCeApi.PluginApi | pluginEnable | POST /endpoints/{endpointId}/docker/plugins/{name}/enable | Enable a plugin PortainerCeApi.PluginApi | pluginInspect | GET /endpoints/{endpointId}/docker/plugins/{name}/json | Inspect a plugin PortainerCeApi.PluginApi | pluginList | GET /endpoints/{endpointId}/docker/plugins | List plugins PortainerCeApi.PluginApi | pluginPull | POST /endpoints/{endpointId}/docker/plugins/pull | Install a plugin PortainerCeApi.PluginApi | pluginPush | POST /endpoints/{endpointId}/docker/plugins/{name}/push | Push a plugin PortainerCeApi.PluginApi | pluginSet | POST /endpoints/{endpointId}/docker/plugins/{name}/set | Configure a plugin PortainerCeApi.PluginApi | pluginUpgrade | POST /endpoints/{endpointId}/docker/plugins/{name}/upgrade | Upgrade a plugin PortainerCeApi.RegistriesApi | registryConfigure | POST /registries/{id}/configure | Configures a registry PortainerCeApi.RegistriesApi | registryCreate | POST /registries | Create a new registry PortainerCeApi.RegistriesApi | registryDelete | DELETE /registries/{id} | Remove a registry PortainerCeApi.RegistriesApi | registryInspect | GET /registries/{id} | Inspect a registry PortainerCeApi.RegistriesApi | registryList | GET /registries | List Registries PortainerCeApi.RegistriesApi | registryUpdate | PUT /registries/{id} | Update a registry PortainerCeApi.ResourceControlsApi | resourceControlCreate | POST /resource_controls | Create a new resource control PortainerCeApi.ResourceControlsApi | resourceControlDelete | DELETE /resource_controls/{id} | Remove a resource control PortainerCeApi.ResourceControlsApi | resourceControlUpdate | PUT /resource_controls/{id} | Update a resource control PortainerCeApi.RolesApi | roleList | GET /roles | List roles PortainerCeApi.SecretApi | secretCreate | POST /endpoints/{endpointId}/docker/secrets/create | Create a secret PortainerCeApi.SecretApi | secretDelete | DELETE /endpoints/{endpointId}/docker/secrets/{id} | Delete a secret PortainerCeApi.SecretApi | secretInspect | GET /endpoints/{endpointId}/docker/secrets/{id} | Inspect a secret PortainerCeApi.SecretApi | secretList | GET /endpoints/{endpointId}/docker/secrets | List secrets PortainerCeApi.SecretApi | secretUpdate | POST /endpoints/{endpointId}/docker/secrets/{id}/update | Update a Secret PortainerCeApi.ServiceApi | serviceCreate | POST /endpoints/{endpointId}/docker/services/create | Create a service PortainerCeApi.ServiceApi | serviceDelete | DELETE /endpoints/{endpointId}/docker/services/{id} | Delete a service PortainerCeApi.ServiceApi | serviceInspect | GET /endpoints/{endpointId}/docker/services/{id} | Inspect a service PortainerCeApi.ServiceApi | serviceList | GET /endpoints/{endpointId}/docker/services | List services PortainerCeApi.ServiceApi | serviceLogs | GET /endpoints/{endpointId}/docker/services/{id}/logs | Get service logs PortainerCeApi.ServiceApi | serviceUpdate | POST /endpoints/{endpointId}/docker/services/{id}/update | Update a service PortainerCeApi.SessionApi | session | POST /endpoints/{endpointId}/docker/session | Initialize interactive session PortainerCeApi.SettingsApi | settingsInspect | GET /settings | Retrieve Portainer settings PortainerCeApi.SettingsApi | settingsPublic | GET /settings/public | Retrieve Portainer public settings PortainerCeApi.SettingsApi | settingsUpdate | PUT /settings | Update Portainer settings PortainerCeApi.SslApi | sSLInspect | GET /ssl | Inspect the ssl settings PortainerCeApi.SslApi | sSLUpdate | PUT /ssl | Update the ssl settings PortainerCeApi.StacksApi | stackCreate | POST /stacks | Deploy a new stack PortainerCeApi.StacksApi | stackDelete | DELETE /stacks/{id} | Remove a stack PortainerCeApi.StacksApi | stackFileInspect | GET /stacks/{id}/file | Retrieve the content of the Stack file for the specified stack PortainerCeApi.StacksApi | stackGitRedeploy | PUT /stacks/{id}/git/redeploy | Redeploy a stack PortainerCeApi.StacksApi | stackInspect | GET /stacks/{id} | Inspect a stack PortainerCeApi.StacksApi | stackList | GET /stacks | List stacks PortainerCeApi.StacksApi | stackMigrate | POST /stacks/{id}/migrate | Migrate a stack to another environment(endpoint) PortainerCeApi.StacksApi | stackStart | POST /stacks/{id}/start | Starts a stopped Stack PortainerCeApi.StacksApi | stackStop | POST /stacks/{id}/stop | Stops a stopped Stack PortainerCeApi.StacksApi | stackUpdate | PUT /stacks/{id} | Update a stack PortainerCeApi.StacksApi | stackUpdateGit | PUT /stacks/{id}/git | Update a stack's Git configs PortainerCeApi.StatusApi | statusInspect | GET /status | Check Portainer status PortainerCeApi.StatusApi | statusInspectVersion | GET /status/version | Check for portainer updates PortainerCeApi.SwarmApi | swarmInit | POST /endpoints/{endpointId}/docker/swarm/init | Initialize a new swarm PortainerCeApi.SwarmApi | swarmInspect | GET /endpoints/{endpointId}/docker/swarm | Inspect swarm PortainerCeApi.SwarmApi | swarmJoin | POST /endpoints/{endpointId}/docker/swarm/join | Join an existing swarm PortainerCeApi.SwarmApi | swarmLeave | POST /endpoints/{endpointId}/docker/swarm/leave | Leave a swarm PortainerCeApi.SwarmApi | swarmUnlock | POST /endpoints/{endpointId}/docker/swarm/unlock | Unlock a locked manager PortainerCeApi.SwarmApi | swarmUnlockkey | GET /endpoints/{endpointId}/docker/swarm/unlockkey | Get the unlock key PortainerCeApi.SwarmApi | swarmUpdate | POST /endpoints/{endpointId}/docker/swarm/update | Update a swarm PortainerCeApi.SystemApi | systemAuth | POST /endpoints/{endpointId}/docker/auth | Check auth configuration PortainerCeApi.SystemApi | systemDataUsage | GET /endpoints/{endpointId}/docker/system/df | Get data usage information PortainerCeApi.SystemApi | systemEvents | GET /endpoints/{endpointId}/docker/events | Monitor events PortainerCeApi.SystemApi | systemInfo | GET /endpoints/{endpointId}/docker/info | Get system information PortainerCeApi.SystemApi | systemPing | GET /endpoints/{endpointId}/docker/_ping | Ping PortainerCeApi.SystemApi | systemPingHead | HEAD /endpoints/{endpointId}/docker/_ping | Ping PortainerCeApi.SystemApi | systemVersion | GET /endpoints/{endpointId}/docker/version | Get version PortainerCeApi.TagsApi | tagCreate | POST /tags | Create a new tag PortainerCeApi.TagsApi | tagDelete | DELETE /tags/{id} | Remove a tag PortainerCeApi.TagsApi | tagList | GET /tags | List tags PortainerCeApi.TaskApi | taskInspect | GET /endpoints/{endpointId}/docker/tasks/{id} | Inspect a task PortainerCeApi.TaskApi | taskList | GET /endpoints/{endpointId}/docker/tasks | List tasks PortainerCeApi.TaskApi | taskLogs | GET /endpoints/{endpointId}/docker/tasks/{id}/logs | Get task logs PortainerCeApi.TeamMembershipsApi | teamMembershipCreate | POST /team_memberships | Create a new team membership PortainerCeApi.TeamMembershipsApi | teamMembershipDelete | DELETE /team_memberships/{id} | Remove a team membership PortainerCeApi.TeamMembershipsApi | teamMembershipList | GET /team_memberships | List team memberships PortainerCeApi.TeamMembershipsApi | teamMembershipUpdate | PUT /team_memberships/{id} | Update a team membership PortainerCeApi.TeamMembershipsApi | teamMemberships | GET /teams/{id}/memberships | List team memberships PortainerCeApi.TeamsApi | teamCreate | POST /team | Create a new team PortainerCeApi.TeamsApi | teamDelete | DELETE /teams/{id} | Remove a team PortainerCeApi.TeamsApi | teamInspect | GET /teams/{id} | Inspect a team PortainerCeApi.TeamsApi | teamList | GET /teams | List teams PortainerCeApi.TemplatesApi | templateFile | POST /templates/file | Get a template's file PortainerCeApi.TemplatesApi | templateList | GET /templates | List available templates PortainerCeApi.UploadApi | uploadTLS | POST /upload/tls/{certificate} | Upload TLS files PortainerCeApi.UsersApi | userAdminCheck | GET /users/admin/check | Check administrator account existence PortainerCeApi.UsersApi | userCreate | POST /users | Create a new user PortainerCeApi.UsersApi | userDelete | DELETE /users/{id} | Remove a user PortainerCeApi.UsersApi | userInspect | GET /users/{id} | Inspect a user PortainerCeApi.UsersApi | userList | GET /users | List users PortainerCeApi.UsersApi | userMembershipsInspect | GET /users/{id}/memberships | Inspect a user memberships PortainerCeApi.UsersApi | userUpdate | PUT /users/{id} | Update a user PortainerCeApi.UsersApi | userUpdatePassword | PUT /users/{id}/passwd | Update password for a user PortainerCeApi.VolumeApi | volumeCreate | POST /endpoints/{endpointId}/docker/volumes/create | Create a volume PortainerCeApi.VolumeApi | volumeDelete | DELETE /endpoints/{endpointId}/docker/volumes/{name} | Remove a volume PortainerCeApi.VolumeApi | volumeInspect | GET /endpoints/{endpointId}/docker/volumes/{name} | Inspect a volume PortainerCeApi.VolumeApi | volumeList | GET /endpoints/{endpointId}/docker/volumes | List volumes PortainerCeApi.VolumeApi | volumePrune | POST /endpoints/{endpointId}/docker/volumes/prune | Delete unused volumes PortainerCeApi.WebhooksApi | webhooksGet | GET /webhooks | List webhooks PortainerCeApi.WebhooksApi | webhooksIdDelete | DELETE /webhooks/{id} | Delete a webhook PortainerCeApi.WebhooksApi | webhooksPost | POST /webhooks | Create a webhook PortainerCeApi.WebhooksApi | webhooksTokenPost | POST /webhooks/{token} | Execute a webhook PortainerCeApi.WebsocketApi | websocketAttachGet | GET /websocket/attach | Attach a websocket PortainerCeApi.WebsocketApi | websocketExecGet | GET /websocket/exec | Execute a websocket PortainerCeApi.WebsocketApi | websocketKubernetesShellGet | GET /websocket/kubernetes-shell | Execute a websocket on kubectl shell pod PortainerCeApi.WebsocketApi | websocketPodGet | GET /websocket/pod | Execute a websocket on pod

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

portainer_api_with_docker_api

Installation

For Node.js

npm

Local development

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models