mirror of
https://github.com/portainer/portainer-docs.git
synced 2026-03-27 12:58:32 +07:00
20 lines
875 B
Markdown
20 lines
875 B
Markdown
# 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.
|
|
|
|
{% hint style="info" %}
|
|
You will need an access token in order to use the Portainer API. If you have not already set up an access token for the API, we have [instructions on how to do so](access.md).
|
|
{% endhint %}
|
|
|
|
You can find our API documentation at SwaggerHub:
|
|
|
|
* [Business Edition (BE) 2.19.5 API Documentation](https://app.swaggerhub.com/apis/portainer/portainer-ee/2.19.5)
|
|
* [Community Edition (CE) 2.19.5 API Documentation](https://app.swaggerhub.com/apis/portainer/portainer-ce/2.19.5)
|
|
|
|
We have also provided some examples of API usage.
|
|
|
|
{% content-ref url="examples.md" %}
|
|
[examples.md](examples.md)
|
|
{% endcontent-ref %}
|
|
|