Portainer

Portainer Endpoint Groups API

Manage environment(endpoint) groups

GitHub OpenAPI

Operations 7

GET /endpoint_groups List Environment(Endpoint) groups #
POST /endpoint_groups Create an Environment(Endpoint) Group #
DELETE /endpoint_groups/{id} Remove an environment(endpoint) group #
GET /endpoint_groups/{id} Inspect an Environment(Endpoint) group #
PUT /endpoint_groups/{id} Update an environment(endpoint) group #
DELETE /endpoint_groups/{id}/endpoints/{endpointId} Removes environment(endpoint) from an environment(endpoint) group #
PUT /endpoint_groups/{id}/endpoints/{endpointId} Add an environment(endpoint) to an environment(endpoint) group #

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-endpoint-groups-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-portainer-endpoint-group-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-endpointgroups-endpoint-group-update-payload-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/portainer/refs/heads/main/json-schema/portainer-endpointgroups-endpoint-group-create-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-endpoint-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-endpoint-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 Endpoint Groups API
  version: 2.39.1
servers:
- url: /api
tags:
- description: Manage environment(endpoint) groups
  name: endpoint_groups
paths:
  /endpoint_groups:
    get:
      description: 'List all environment(endpoint) groups based on the current user authorizations. Will

        return all environment(endpoint) groups if using an administrator account otherwise it will

        only return authorized environment(endpoint) groups.

        **Access policy**: restricted'
      operationId: EndpointGroupList
      responses:
        '200':
          description: Environment(Endpoint) group
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/portainer.EndpointGroup'
                type: array
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: List Environment(Endpoint) groups
      tags:
      - endpoint_groups
    post:
      description: 'Create a new environment(endpoint) group.

        **Access policy**: administrator'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.EndpointGroup'
        '400':
          description: Invalid request
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Create an Environment(Endpoint) Group
      tags:
      - endpoint_groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/endpointgroups.endpointGroupCreatePayload'
        description: Environment(Endpoint) Group details
        required: true
      operationId: postEndpointGroups
      x-operation-id-source: derived
  /endpoint_groups/{id}:
    delete:
      description: 'Remove an environment(endpoint) group.

        **Access policy**: administrator'
      operationId: EndpointGroupDelete
      parameters:
      - description: EndpointGroup identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request
        '404':
          description: EndpointGroup not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Remove an environment(endpoint) group
      tags:
      - endpoint_groups
    get:
      description: 'Retrieve details abont an environment(endpoint) group.

        **Access policy**: administrator'
      parameters:
      - description: Environment(Endpoint) group identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.EndpointGroup'
        '400':
          description: Invalid request
        '404':
          description: EndpointGroup not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Inspect an Environment(Endpoint) group
      tags:
      - endpoint_groups
      operationId: getEndpointGroupsById
      x-operation-id-source: derived
    put:
      description: 'Update an environment(endpoint) group.

        **Access policy**: administrator'
      operationId: EndpointGroupUpdate
      parameters:
      - description: EndpointGroup identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/portainer.EndpointGroup'
        '400':
          description: Invalid request
        '404':
          description: EndpointGroup not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Update an environment(endpoint) group
      tags:
      - endpoint_groups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/endpointgroups.endpointGroupUpdatePayload'
        description: EndpointGroup details
        required: true
  /endpoint_groups/{id}/endpoints/{endpointId}:
    delete:
      description: '**Access policy**: administrator'
      operationId: EndpointGroupDeleteEndpoint
      parameters:
      - description: EndpointGroup identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      - description: Environment(Endpoint) identifier
        in: path
        name: endpointId
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request
        '404':
          description: EndpointGroup not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Removes environment(endpoint) from an environment(endpoint) group
      tags:
      - endpoint_groups
    put:
      description: 'Add an environment(endpoint) to an environment(endpoint) group

        **Access policy**: administrator'
      operationId: EndpointGroupAddEndpoint
      parameters:
      - description: EndpointGroup identifier
        in: path
        name: id
        required: true
        schema:
          type: integer
      - description: Environment(Endpoint) identifier
        in: path
        name: endpointId
        required: true
        schema:
          type: integer
      responses:
        '204':
          description: Success
        '400':
          description: Invalid request
        '404':
          description: EndpointGroup not found
        '500':
          description: Server error
      security:
      - ApiKeyAuth: []
      - jwt: []
      summary: Add an environment(endpoint) to an environment(endpoint) group
      tags:
      - endpoint_groups
components:
  schemas:
    endpointgroups.endpointGroupCreatePayload:
      properties:
        AssociatedEndpoints:
          description: List of environment(endpoint) identifiers that will be part of this group
          example:
          - 1
          - 3
          items:
            type: integer
          type: array
        Description:
          description: Environment(Endpoint) group description
          example: description
          type: string
        Name:
          description: Environment(Endpoint) group name
          example: my-environment-group
          type: string
        TagIDs:
          description: List of tag identifiers to which this environment(endpoint) group is associated
          example:
          - 1
          - 2
          items:
            type: integer
          type: array
      required:
      - Name
      type: object
    portainer.EndpointGroup:
      properties:
        AuthorizedTeams:
          items:
            type: integer
          type: array
        AuthorizedUsers:
          description: Deprecated in DBVersion == 18
          items:
            type: integer
          type: array
        Description:
          description: Description associated to the environment(endpoint) group
          example: Environment(Endpoint) group description
          type: string
        Id:
          description: Environment(Endpoint) group Identifier
          example: 1
          type: integer
        Labels:
          description: Deprecated fields
          items:
            $ref: '#/components/schemas/portainer.Pair'
          type: array
        Name:
          description: Environment(Endpoint) group name
          example: my-environment-group
          type: string
        TagIds:
          description: List of tags associated to this environment(endpoint) group
          items:
            type: integer
          type: array
        Tags:
          description: Deprecated in DBVersion == 22
          items:
            type: string
          type: array
        TeamAccessPolicies:
          $ref: '#/components/schemas/portainer.TeamAccessPolicies'
        UserAccessPolicies:
          $ref: '#/components/schemas/portainer.UserAccessPolicies'
      type: object
    portainer.AccessPolicy:
      properties:
        Namespaces:
          description: Namespaces is a list of namespaces that this access policy applies to. Only used for namespaced level roles
          items:
            type: string
          type: array
        RoleId:
          description: Role identifier. Reference the role that will be associated to this access policy
          example: 1
          type: integer
      type: object
    portainer.TeamAccessPolicies:
      additionalProperties:
        $ref: '#/components/schemas/portainer.AccessPolicy'
      type: object
    portainer.Pair:
      properties:
        name:
          example: name
          type: string
        value:
          example: value
          type: string
      type: object
    endpointgroups.endpointGroupUpdatePayload:
      properties:
        AssociatedEndpoints:
          description: List of environment(endpoint) identifiers that will be part of this group
          example:
          - 1
          - 3
          items:
            type: integer
          type: array
        Description:
          description: Environment(Endpoint) group description
          example: description
          type: string
        Name:
          description: Environment(Endpoint) group name
          example: my-environment-group
          type: string
        TagIDs:
          description: List of tag identifiers associated to the environment(endpoint) group
          example:
          - 3
          - 4
          items:
            type: integer
          type: array
        TeamAccessPolicies:
          $ref: '#/components/schemas/portainer.TeamAccessPolicies'
        UserAccessPolicies:
          $ref: '#/components/schemas/portainer.UserAccessPolicies'
      type: object
    portainer.UserAccessPolicies:
      additionalProperties:
        $ref: '#/components/schemas/portainer.AccessPolicy'
      type: object
  securitySchemes:
    ApiKeyAuth:
      in: header
      name: X-API-KEY
      type: apiKey
    jwt:
      in: header
      name: Authorization
      type: apiKey