Portainer

Portainer Edge Groups API

Manage Edge Groups

GitHub OpenAPI

Operations 5

GET /edge_groups list EdgeGroups #
POST /edge_groups Create an EdgeGroup #
DELETE /edge_groups/{id} Deletes an EdgeGroup #
GET /edge_groups/{id} Inspects an EdgeGroup #
PUT /edge_groups/{id} Updates an EdgeGroup #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/openapi/portainer-edge-groups-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-edgegroups-decorated-edge-group-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-portainer-edge-group-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-edgegroups-edge-group-create-payload-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-edgegroups-edge-group-update-payload-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-edge-groups-api"
All apis 
curl "https://apis.io/api/v1/apis?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.

OpenAPI Specification

portainer-edge-groups-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 Edge Groups API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Manage Edge Groups
  name: edge_groups
paths:
  /edge_groups:
    get:
      description: '**Access policy**: administrator'
      operationId: EdgeGroupList
      responses:
        '200':
          description: EdgeGroups
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/edgegroups.decoratedEdgeGroup'
                type: array
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: list EdgeGroups
      tags:
      - edge_groups
    post:
      description: '**Access policy**: administrator'
      operationId: EdgeGroupCreate
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.EdgeGroup'
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Create an EdgeGroup
      tags:
      - edge_groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/edgegroups.edgeGroupCreatePayload'
        description: EdgeGroup data
        required: true
  /edge_groups/{id}:
    delete:
      description: '**Access policy**: administrator'
      operationId: EdgeGroupDelete
      parameters:
      - description: EdgeGroup Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: No Content
        '409':
          description: Edge group is in use by an Edge stack or Edge job
        '500':
          description: Server error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Deletes an EdgeGroup
      tags:
      - edge_groups
    get:
      description: '**Access policy**: administrator'
      operationId: EdgeGroupInspect
      parameters:
      - description: EdgeGroup Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.EdgeGroup'
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Inspects an EdgeGroup
      tags:
      - edge_groups
    put:
      description: '**Access policy**: administrator'
      operationId: EdgeGroupUpdate
      parameters:
      - description: EdgeGroup Id
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.EdgeGroup'
        '500':
          description: Internal Server Error
        '503':
          description: Edge compute features are disabled
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Updates an EdgeGroup
      tags:
      - edge_groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/edgegroups.edgeGroupUpdatePayload'
        description: EdgeGroup data
        required: true
components:
  schemas:
    roar.Roar-portainer_EndpointID:
      type: object
    edgegroups.edgeGroupCreatePayload:
      properties:
        Dynamic:
          type: boolean
        Endpoints:
          items:
            type: integer
          type: array
        Name:
          type: string
        PartialMatch:
          type: boolean
        TagIDs:
          items:
            type: integer
          type: array
      type: object
    edgegroups.edgeGroupUpdatePayload:
      properties:
        Dynamic:
          type: boolean
        Endpoints:
          items:
            type: integer
          type: array
        Name:
          type: string
        PartialMatch:
          type: boolean
        TagIDs:
          items:
            type: integer
          type: array
      type: object
    edgegroups.decoratedEdgeGroup:
      properties:
        Dynamic:
          type: boolean
        EndpointIds:
          description: Shadow to avoid exposing in the API
          type: integer
        EndpointTypes:
          items:
            $ref: '#/components/schemas/portainer.EndpointType'
          type: array
        Endpoints:
          description: 'Deprecated: only used for API responses'
          items:
            type: integer
          type: array
        HasEdgeJob:
          type: boolean
        HasEdgeStack:
          type: boolean
        Id:
          description: EdgeGroup Identifier
          example: 1
          type: integer
        Name:
          type: string
        PartialMatch:
          type: boolean
        TagIds:
          items:
            type: integer
          type: array
        TrustedEndpoints:
          items:
            type: integer
          type: array
      type: object
    portainer.EdgeGroup:
      properties:
        Dynamic:
          type: boolean
        EndpointIds:
          $ref: '#/components/schemas/roar.Roar-portainer_EndpointID'
        Endpoints:
          description: 'Deprecated: only used for API responses'
          items:
            type: integer
          type: array
        Id:
          description: EdgeGroup Identifier
          example: 1
          type: integer
        Name:
          type: string
        PartialMatch:
          type: boolean
        TagIds:
          items:
            type: integer
          type: array
      type: object
    portainer.EndpointType:
      enum:
      - 0
      - 1
      - 2
      - 3
      - 4
      - 5
      - 6
      - 7
      type: integer
      x-enum-varnames:
      - _
      - DockerEnvironment
      - AgentOnDockerEnvironment
      - AzureEnvironment
      - EdgeAgentOnDockerEnvironment
      - KubernetesLocalEnvironment
      - AgentOnKubernetesEnvironment
      - EdgeAgentOnKubernetesEnvironment
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey