Manage Edge related environment(endpoint) settings
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/portainer-edge-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
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.
A second provider on the same verified email joins the account you already have.
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 Edge API
version: 2.39.1
servers:
- url: /api
tags:
- description: Manage Edge related environment(endpoint) settings
name: Edge
paths:
/endpoints/{id}/edge/jobs/{jobID}/logs:
post:
description: Authorized only if the request is done by an Edge Environment(Endpoint)
parameters:
- description: environment(endpoint) Id
in: path
name: id
required: true
schema:
type: integer
- description: Job Id
in: path
name: jobID
required: true
schema:
type: integer
responses:
'200':
description: OK
'400':
description: Bad Request
'403':
description: Forbidden
'500':
description: Internal Server Error
summary: Update the logs collected from an Edge Job
tags:
- Edge
operationId: postEndpointsByIdEdgeJobsByJobIDLogs
x-operation-id-source: derived
/endpoints/{id}/edge/stacks/{stackId}:
get:
description: '**Access policy**: public'
parameters:
- description: environment(endpoint) Id
in: path
name: id
required: true
schema:
type: integer
- description: EdgeStack Id
in: path
name: stackId
required: true
schema:
type: integer
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/edge.StackPayload'
'400':
description: Bad Request
'404':
description: Not Found
'500':
description: Internal Server Error
summary: Inspect an Edge Stack for an Environment(Endpoint)
tags:
- Edge
operationId: getEndpointsByIdEdgeStacksByStackId
x-operation-id-source: derived
components:
schemas:
edge.StackPayload:
properties:
AlwaysCloneGitRepoForRelativePath:
description: 'AlwaysCloneGitRepoForRelativePath is a flag indicating if the agent must always clone the git repository for relative path.
This field is only valid when SupportRelativePath is true.
Used only for EE'
type: boolean
CreatedBy:
description: 'CreatedBy is the username that created this stack
Used for adding labels to Kubernetes manifests'
type: string
CreatedByUserId:
description: 'CreatedByUserId is the user ID that created this stack
Used for adding labels to Kubernetes manifests'
type: string
DeployerOptionsPayload:
$ref: '#/components/schemas/edge.DeployerOptionsPayload'
DirEntries:
description: Content of stack folder
items:
$ref: '#/components/schemas/filesystem.DirEntry'
type: array
EdgeUpdateID:
description: 'EdgeUpdateID is the ID of the edge update related to this stack.
Used only for EE'
type: integer
EntryFileName:
description: Name of the stack entry file
type: string
EnvVars:
description: 'Used only for EE
EnvVars is a list of environment variables to inject into the stack'
items:
$ref: '#/components/schemas/portainer.Pair'
type: array
FilesystemPath:
description: Mount point for relative path
type: string
ForceUpdate:
description: 'ForceUpdate is a flag indicating if the agent must force the update of the stack.
Used only for EE'
type: boolean
HelmConfig:
allOf:
- $ref: '#/components/schemas/portainer.HelmConfig'
description: HelmConfig represents the Helm configuration for an edge stack
ID:
description: ID of the stack
type: integer
Name:
description: Name of the stack
type: string
Namespace:
description: Namespace to use for kubernetes stack. Keep empty to use the manifest namespace.
type: string
PrePullImage:
description: 'PrePullImage is a flag indicating if the agent must pull the image before deploying the stack.
Used only for EE'
type: boolean
RePullImage:
description: 'RePullImage is a flag indicating if the agent must pull the image if it is already present on the node.
Used only for EE'
type: boolean
ReadyRePullImage:
description: 'Used only for EE async edge agent
ReadyRePullImage is a flag to indicate whether the auto update is trigger to re-pull image
Deprecated(2.36): use DeployerOptionsPayload.ForceRecreate instead'
type: boolean
RegistryCredentials:
description: 'RegistryCredentials holds the credentials for a Docker registry.
Used only for EE'
items:
$ref: '#/components/schemas/edge.RegistryCredentials'
type: array
RetryDeploy:
description: 'RetryDeploy is a flag indicating if the agent must retry to deploy the stack if it fails.
Used only for EE'
type: boolean
RetryPeriod:
description: 'RetryPeriod specifies the duration, in seconds, for which the agent should continue attempting to deploy the stack after a failure
Used only for EE'
type: integer
RollbackTo:
description: RollbackTo specifies the stack file version to rollback to (only support to rollback to the last version currently)
type: integer
StackFileContent:
description: Content of the stack file (for compatibility to agent version less than 2.19.0)
type: string
SupportRelativePath:
description: Is relative path supported
type: boolean
Version:
description: Version of the stack file
type: integer
type: object
filesystem.DirEntry:
properties:
Content:
type: string
IsFile:
type: boolean
Name:
type: string
Permissions:
$ref: '#/components/schemas/os.FileMode'
type: object
portainer.Pair:
properties:
name:
example: name
type: string
value:
example: value
type: string
type: object
portainer.HelmConfig:
properties:
Atomic:
description: Enable automatic rollback on deployment failure (equivalent to helm --atomic flag)
example: true
type: boolean
ChartPath:
description: Path to a Helm chart folder for Helm git deployments
example: charts/my-app
type: string
Timeout:
description: Timeout for Helm operations (equivalent to helm --timeout flag)
example: 5m0s
type: string
ValuesFiles:
description: Array of paths to Helm values YAML files for Helm git deployments
example:
- '[''values/prod.yaml'''
- ' ''values/secrets.yaml'']'
items:
type: string
type: array
Version:
description: Helm chart version from Chart.yaml (read-only, extracted during Git sync)
example: 1.2.3
type: string
type: object
edge.DeployerOptionsPayload:
properties:
ForceRecreate:
description: 'ForceRecreate is a flag indicating if the agent must force the redeployment of the stack.
This field is only used when the Force Redeployment is triggered.
Once the stack is redeployed, this field will be reset to false.
For standard edge agent, this field is used in agent side
For async edge agent, this field is used in both agent side and server side.
This flag drives `docker compose up --force-recreate` option'
type: boolean
Prune:
description: 'Prune is a flag indicating if the agent must prune the containers or not when creating/updating an edge stack
This flag drives `docker compose up --remove-orphans` and `docker stack up --prune` options
Used only for EE'
type: boolean
RemoveVolumes:
description: 'RemoveVolumes is a flag indicating if the agent must remove the named volumes declared
in the compose file and anonymouse volumes attached to containers
This flag drives `docker compose down --volumes` option
Used only for EE'
type: boolean
type: object
os.FileMode:
enum:
- 2147483648
- 1073741824
- 536870912
- 268435456
- 134217728
- 67108864
- 33554432
- 16777216
- 8388608
- 4194304
- 2097152
- 1048576
- 524288
- 2401763328
- 511
- 2147483648
- 1073741824
- 536870912
- 268435456
- 134217728
- 67108864
- 33554432
- 16777216
- 8388608
- 4194304
- 2097152
- 1048576
- 524288
- 2401763328
- 511
type: integer
x-enum-comments:
ModeAppend: 'a: append-only'
ModeCharDevice: 'c: Unix character device, when ModeDevice is set'
ModeDevice: 'D: device file'
ModeDir: 'd: is a directory'
ModeExclusive: 'l: exclusive use'
ModeIrregular: '?: non-regular file; nothing else is known about this file'
ModeNamedPipe: 'p: named pipe (FIFO)'
ModePerm: Unix permission bits, 0o777
ModeSetgid: 'g: setgid'
ModeSetuid: 'u: setuid'
ModeSocket: 'S: Unix domain socket'
ModeSticky: 't: sticky'
ModeSymlink: 'L: symbolic link'
ModeTemporary: 'T: temporary file; Plan 9 only'
x-enum-varnames:
- ModeDir
- ModeAppend
- ModeExclusive
- ModeTemporary
- ModeSymlink
- ModeDevice
- ModeNamedPipe
- ModeSocket
- ModeSetuid
- ModeSetgid
- ModeCharDevice
- ModeSticky
- ModeIrregular
- ModeType
- ModePerm
edge.RegistryCredentials:
properties:
Secret:
type: string
ServerURL:
type: string
Username:
type: string
type: object
securitySchemes:
ApiKeyAuth:
in: header
name: X-API-KEY
type: apiKey
jwt:
in: header
name: Authorization
type: apiKey