Portainer Documentation
Official WebsiteGet 5 Nodes of BE Free
Search…
BE 2.7
Welcome
Release Notes
Getting Started
Introduction
Portainer architecture
Requirements and prerequisites
Install Portainer BE
Upgrading Portainer
Using Portainer
Docker/Swarm
Kubernetes
Azure ACI
Edge Compute
Administering Portainer
Users
Endpoints
Registries
Licenses
Authentication logs
Settings
Frequently Asked Questions
Portainer Concepts
Installing
Upgrading
Troubleshooting
Contributing
Advanced Topics
CLI configuration options
App templates
The Portainer Edge Agent
Access control
Reset the admin user's password
Security and compliance
Using SSL with Portainer
Using Portainer with reverse proxies
Helm chart configuration options
Kubernetes roles and bindings
Deprecated and removed features
API
API documentation
API usage examples
Get More Help
YouTube
Open a support request
Contribute to Portainer
Contribute
Powered By GitBook
API documentation
Portainer exposes an HTTP API that you can use to automate everything you do via the Portainer UI. You can also use Portainer as a gateway (HTTP queries against the Portainer API) to the underlying Docker/Kubernetes API.
You can find our API documentation at SwaggerHub. We have also provided some examples of API usage.
Advanced Topics - Previous
Deprecated and removed features
Next - API
API usage examples
Last modified 7mo ago
Copy link
Edit on GitHub