Portainer

Portainer Endpoints API

Manage Docker environments(endpoints)

GitHub OpenAPI
Business capability
IT Infrastructure Management BC-600.50

Operations 21

DELETE /endpoints Remove multiple environments #
GET /endpoints List environments(endpoints) #
POST /endpoints Create a new environment(endpoint) #
DELETE /endpoints/{id} Remove an environment #
GET /endpoints/{id} Inspect an environment(endpoint) #
PUT /endpoints/{id} Update an environment(endpoint) #
PUT /endpoints/{id}/association De-association an edge environment(endpoint) #
POST /endpoints/{id}/docker/v2/browse/put Upload a file under a specific path on the file system of an environment… #
GET /endpoints/{id}/dockerhub/{registryId} fetch docker pull limits #
POST /endpoints/{id}/edge/jobs/{jobID}/logs Update the logs collected from an Edge Job #
GET /endpoints/{id}/edge/stacks/{stackId} Inspect an Edge Stack for an Environment(Endpoint) #
GET /endpoints/{id}/edge/status Get environment(endpoint) status #
PUT /endpoints/{id}/forceupdateservice force update a docker service #
GET /endpoints/{id}/registries List Registries on environment #
PUT /endpoints/{id}/registries/{registryId} update registry access for environment #
PUT /endpoints/{id}/settings Update settings for an environment(endpoint) #
POST /endpoints/{id}/snapshot Snapshots an environment(endpoint) #
POST /endpoints/delete Remove multiple environments #
POST /endpoints/global-key Create or retrieve the endpoint for an EdgeID #
PUT /endpoints/relations Update relations for a list of environments #
POST /endpoints/snapshot Snapshot all environments(endpoints) #

Documentation

📖
Documentation
https://docs.portainer.io/
📖
APIReference
https://api-docs.portainer.io/
📖
GettingStarted
https://docs.portainer.io/start

Specifications

⚙
OpenAPI
https://artifacts.apis.io/portainer/openapi/portainer-endpoints-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/portainer/json-schema/portainer-portainer-endpoint-schema.json
📊
JSONSchema
https://artifacts.apis.io/portainer/json-schema/portainer-edge-stack-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/portainer/json-schema/portainer-portainer-registry-schema.json
📊
JSONSchema
https://artifacts.apis.io/portainer/json-schema/portainer-endpoints-endpoint-update-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/portainer/json-schema/portainer-endpoints-endpoint-settings-update-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/portainer/json-schema/portainer-endpointedge-endpoint-edge-status-inspect-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/portainer:portainer-endpoints-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

portainer-endpoints-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  contact:
    email: info@portainer.io
  description: Portainer API is an HTTP API served by Portainer.
  license:
    name: zlib
    url: https://github.com/portainer/portainer/blob/develop/LICENSE
  title: PortainerCE Endpoints API
  version: 2.39.1
servers:
- url: /api
tags:


# --- truncated at 32 KB (65 KB total) ---
# Full source: https://artifacts.apis.io/portainer/openapi/portainer-endpoints-api-openapi.yml