Sign in

v13

latestOpenAPI 3.0.0zlibraw.githubusercontent.com2026-08-01265409652.5 KB
edge_agent
edge_stacks

Inspect an Edge Stack for an Environment

Access policy: Edge agent only — requires X-PortainerAgent-EdgeID header

get/endpoints/{id}/edge/stacks/{stackId}

Path parameters

idinteger required

environment Id

stackIdinteger required

EdgeStack Id

Response

OK

AlwaysCloneGitRepoForRelativePathboolean

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

CreatedBystring

CreatedBy is the username that created this stack Used for adding labels to Kubernetes manifests

CreatedByUserIdstring

CreatedByUserId is the user ID that created this stack Used for adding labels to Kubernetes manifests

EdgeUpdateIDinteger

EdgeUpdateID is the ID of the edge update related to this stack. Used only for EE

EntryFileNamestring

Name of the stack entry file

FilesystemPathstring

Mount point for relative path

ForceUpdateboolean

ForceUpdate is a flag indicating if the agent must force the update of the stack. Used only for EE

IDinteger

ID of the stack

Namestring

Name of the stack

Namespacestring

Namespace to use for kubernetes stack. Keep empty to use the manifest namespace.

PrePullImageboolean

PrePullImage is a flag indicating if the agent must pull the image before deploying the stack. Used only for EE

RePullImageboolean

RePullImage is a flag indicating if the agent must pull the image if it is already present on the node. Used only for EE

ReadyRePullImageboolean

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

RetryDeployboolean

RetryDeploy is a flag indicating if the agent must retry to deploy the stack if it fails. Used only for EE

RetryPeriodinteger

RetryPeriod specifies the duration, in seconds, for which the agent should continue attempting to deploy the stack after a failure Used only for EE

RollbackTointeger

RollbackTo specifies the stack file version to rollback to (only support to rollback to the last version currently)

StackFileContentstring

Content of the stack file (for compatibility to agent version less than 2.19.0)

SupportPerDeviceConfigsboolean

Whether the edge stack supports per device configs

SupportRelativePathboolean

Is relative path supported

Versioninteger

Version of the stack file

Example response

{
  "EnvVars": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "HelmConfig": {
    "Atomic": true,
    "ChartName": "nginx",
    "ChartPath": "charts/my-app",
    "ChartURL": "https://charts.bitnami.com/bitnami",
    "ChartVersion": "15.0.0",
    "Namespace": "default",
    "Timeout": "5m0s",
    "ValuesFiles": [
      "['values/prod.yaml'",
      " 'values/secrets.yaml']"
    ],
    "ValuesInline": "replicaCount: 2"
  }
}