Portainer · Schema

portainer.EdgeStack

Container ManagementContainersDockerKubernetesKubernetes ManagementEnterprise IdentityGitOps

Properties

Name	Type	Description
CreatedBy	string	The username which created this stack
CreatedByUserId	string	The username id which created this stack
CreationDate	integer	StatusArray map[EndpointID][]EdgeStackStatus `json:"StatusArray"`
DeploymentType	object
EdgeGroups	array
EntryPoint	string
Id	integer	EdgeStack Identifier
ManifestPath	string
Name	string
NumDeployments	integer
ProjectPath	string
Status	object
UseManifestNamespaces	boolean	Uses the manifest's namespaces instead of the default one
Version	integer

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/portainer/main/json-schema/portainer-portainer-edge-stack-schema.json",
  "title": "portainer.EdgeStack",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/portainer-edge-stacks-api-openapi.yml#/components/schemas/portainer.EdgeStack",
  "properties": {
    "CreatedBy": {
      "description": "The username which created this stack",
      "type": "string"
    },
    "CreatedByUserId": {
      "description": "The username id which created this stack",
      "type": "string"
    },
    "CreationDate": {
      "description": "StatusArray    map[EndpointID][]EdgeStackStatus `json:\"StatusArray\"`",
      "type": "integer"
    },
    "DeploymentType": {
      "$ref": "#/$defs/portainer.EdgeStackDeploymentType"
    },
    "EdgeGroups": {
      "items": {
        "type": "integer"
      },
      "type": "array"
    },
    "EntryPoint": {
      "type": "string"
    },
    "Id": {
      "description": "EdgeStack Identifier",
      "type": "integer"
    },
    "ManifestPath": {
      "type": "string"
    },
    "Name": {
      "type": "string"
    },
    "NumDeployments": {
      "type": "integer"
    },
    "ProjectPath": {
      "type": "string"
    },
    "Status": {
      "additionalProperties": {
        "$ref": "#/$defs/portainer.EdgeStackStatus"
      },
      "type": "object"
    },
    "UseManifestNamespaces": {
      "description": "Uses the manifest's namespaces instead of the default one",
      "type": "boolean"
    },
    "Version": {
      "type": "integer"
    }
  },
  "type": "object",
  "$defs": {
    "portainer.EdgeStackDeploymentStatus": {
      "properties": {
        "Error": {
          "type": "string"
        },
        "RollbackTo": {
          "description": "EE only feature",
          "type": "integer"
        },
        "Time": {
          "type": "integer"
        },
        "Type": {
          "$ref": "#/$defs/portainer.EdgeStackStatusType"
        },
        "Version": {
          "type": "integer"
        }
      },
      "type": "object"
    },
    "portainer.EdgeStackDeploymentType": {
      "enum": [
        0,
        1
      ],
      "type": "integer",
      "x-enum-varnames": [
        "EdgeStackDeploymentCompose",
        "EdgeStackDeploymentKubernetes"
      ]
    },
    "portainer.EdgeStackStatus": {
      "properties": {
        "DeploymentInfo": {
          "allOf": [
            {
              "$ref": "#/$defs/portainer.StackDeploymentInfo"
            }
          ],
          "description": "EE only feature"
        },
        "Details": {
          "allOf": [
            {
              "$ref": "#/$defs/portainer.EdgeStackStatusDetails"
            }
          ],
          "description": "Deprecated"
        },
        "EndpointID": {
          "type": "integer"
        },
        "Error": {
          "description": "Deprecated",
          "type": "string"
        },
        "ReadyRePullImage": {
          "description": "ReadyRePullImage is a flag to indicate whether the auto update is trigger to re-pull image",
          "type": "boolean"
        },
        "Status": {
          "items": {
            "$ref": "#/$defs/portainer.EdgeStackDeploymentStatus"
          },
          "type": "array"
        },
        "Type": {
          "allOf": [
            {
              "$ref": "#/$defs/portainer.EdgeStackStatusType"
            }
          ],
          "description": "Deprecated"
        }
      },
      "type": "object"
    },
    "portainer.EdgeStackStatusDetails": {
      "properties": {
        "Acknowledged": {
          "type": "boolean"
        },
        "Error": {
          "type": "boolean"
        },
        "ImagesPulled": {
          "type": "boolean"
        },
        "Ok": {
          "type": "boolean"
        },
        "Pending": {
          "type": "boolean"
        },
        "RemoteUpdateSuccess": {
          "type": "boolean"
        },
        "Remove": {
          "type": "boolean"
        }
      },
      "type": "object"
    },
    "portainer.EdgeStackStatusType": {
      "enum": [
        0,
        1,
        2,
        3,
        4,
        5,
        6,
        7,
        8,
        9,
        10,
        11,
        12,
        13
      ],
      "type": "integer",
      "x-enum-varnames": [
        "EdgeStackStatusPending",
        "EdgeStackStatusDeploymentReceived",
        "EdgeStackStatusError",
        "EdgeStackStatusAcknowledged",
        "EdgeStackStatusRemoved",
        "EdgeStackStatusRemoteUpdateSuccess",
        "EdgeStackStatusImagesPulled",
        "EdgeStackStatusRunning",
        "EdgeStackStatusDeploying",
        "EdgeStackStatusRemoving",
        "EdgeStackStatusPausedDeploying",
        "EdgeStackStatusRollingBack",
        "EdgeStackStatusRolledBack",
        "EdgeStackStatusCompleted"
      ]
    },
    "portainer.StackDeploymentInfo": {
      "properties": {
        "ConfigHash": {
          "description": "ConfigHash is the commit hash of the git repository used for deploying the stack",
          "type": "string"
        },
        "FileVersion": {
          "description": "FileVersion is the version of the stack file, used to detect changes",
          "type": "integer"
        },
        "Version": {
          "description": "Version is the version of the stack and also is the deployed version in edge agent",
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}

Work with this as data

Every JSON Schema 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 schemas

4 MCP tools reach this

find_json_schemasBrowse and filter every JSON Schema in the catalog.
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 JSON Schema

curl "https://apis.io/api/v1/json-schemas/portainer-portainer-edge-stack"

All schemas

curl "https://apis.io/api/v1/json-schemas?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.