How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Portainer

Portainer edge_stacks API

Manage Edge Stacks

Documentation Provider Profile APIs.io OpenAPI GitHub

Portainer edge_stacks API is one of 32 APIs that Portainer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 10 operations across 8 paths, and defines 20 schemas. It is described by OpenAPI 3.2.0, at version 2.39.1.

Requests are made against a single base URL, /api.

10 operations 8 paths 20 schemas 1 DELETE4 GET3 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.39.1
Base URL
https://api-docs.portainer.io
Authentication
API Key, API Key
Contact
info@portainer.io
License
zlib
Resource Areas
1

Authentication & Security 2

Portainer edge_stacks API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). An API key is passed in the header as Authorization (jwt).

Paths & Operations 10

Across 8 paths, the API surfaces 10 operations — 1 DELETE, 4 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

edge_stacks 10

Manage Edge Stacks

GET
/edge_stacks
Fetches the list of EdgeStacks
EdgeStackList 1 param → 200400500503
DELETE
/edge_stacks/{id}
Delete an EdgeStack
EdgeStackDelete 1 param → 204400500503
GET
/edge_stacks/{id}
Inspect an EdgeStack
EdgeStackInspect 1 param → 200400500503
PUT
/edge_stacks/{id}
Update an EdgeStack
EdgeStackUpdate 1 param body → 200400500503
GET
/edge_stacks/{id}/file
Fetches the stack file for an EdgeStack
EdgeStackFile 1 param → 200400500503
PUT
/edge_stacks/{id}/status
Update an EdgeStack status
EdgeStackStatusUpdate 1 param body → 200400403404500
POST
/edge_stacks/create/file
Create an EdgeStack from file
EdgeStackCreateFile 1 param body → 200400500503
POST
/edge_stacks/create/repository
Create an EdgeStack from a git repository
EdgeStackCreateRepository 1 param body → 200400500503
POST
/edge_stacks/create/string
Create an EdgeStack from a text
EdgeStackCreateString 1 param body → 200400500503
GET
/endpoints/{id}/edge/stacks/{stackId}
Inspect an Edge Stack for an Environment(Endpoint)
2 params → 200400404500

Schemas 20

The contract defines 20 schemas that model the data the API accepts and returns. The most detailed are edge.StackPayload (24 properties), portainer.EdgeStack (14 properties), edgestacks.edgeStackFromGitRepositoryPayload (13 properties), portainer.EdgeStackStatus (7 properties). Each schema is shown below with its type and property counts.

portainer.Pair
object
2 properties
portainer.EdgeStack
object
14 properties
portainer.EdgeStackStatusType
integer
portainer.EdgeStackDeploymentStatus
object
5 properties
portainer.HelmConfig
object
5 properties
portainer.StackDeploymentInfo
object
3 properties
edge.RegistryCredentials
object
3 properties
edgestacks.edgeStackFromStringPayload
object
6 properties 2 required
edgestacks.updateStatusPayload
object
5 properties
portainer.EdgeStackStatusDetails
object
7 properties
filesystem.DirEntry
object
4 properties
edgestacks.stackFileResponse
object
1 property
edge.DeployerOptionsPayload
object
3 properties
portainer.EdgeStackDeploymentType
integer
edge.StackPayload
object
24 properties
edgestacks.edgeStackFromGitRepositoryPayload
object
13 properties 3 required
os.FileMode
integer
gittypes.GitCredentialAuthType
integer
edgestacks.updateEdgeStackPayload
object
5 properties
portainer.EdgeStackStatus
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portainer-edge-stacks-api-openapi.yml Raw ↑

Other APIs Portainer publishes across the network.

Portainer auth API
AE Profile APIs.io
Portainer backup API
AE Profile APIs.io
Portainer custom_templates API
AE Profile APIs.io
Portainer docker API
AE Profile APIs.io
Portainer edge API
AE Profile APIs.io
Portainer edge_groups API
AE Profile APIs.io
Portainer edge_jobs API
AE Profile APIs.io
Portainer endpoint_groups API
AE Profile APIs.io
Portainer endpoints API
AE Profile APIs.io
Portainer gitops API
AE Profile APIs.io
Portainer helm API
AE Profile APIs.io
Portainer intel API
AE Profile APIs.io
← Back to P APIs
API Details
ID
portainer:portainer-edge-stacks-api
Base URL
https://api-docs.portainer.io
Docs
https://www.portainer.io/
Provider
Portainer
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=portainer-edge-stacks-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/portainer-edge-stacks-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Portainer edge_stacks API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.