How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Portainer endpoint_groups API

Manage environment(endpoint) groups

Portainer endpoint_groups API is one of 32 APIs that Portainer publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

This API exposes 7 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 2.39.1.

Requests are made against a single base URL, /api.

7 operations 3 paths 7 schemas 2 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.39.1
Base URL
https://api-docs.portainer.io
Authentication
API Key, API Key
License
Resource Areas
1

Authentication & Security 2

Portainer endpoint_groups API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-API-KEY (ApiKeyAuth). An API key is passed in the header as Authorization (jwt).

Paths & Operations 7

Across 3 paths, the API surfaces 7 operations — 2 DELETE, 2 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

endpoint_groups 7

Manage environment(endpoint) groups

GET
/endpoint_groups
List Environment(Endpoint) groups
EndpointGroupList → 200500
POST
/endpoint_groups
Create an Environment(Endpoint) Group
body → 200400500
DELETE
/endpoint_groups/{id}
Remove an environment(endpoint) group
EndpointGroupDelete 1 param → 204400404500
GET
/endpoint_groups/{id}
Inspect an Environment(Endpoint) group
1 param → 200400404500
PUT
/endpoint_groups/{id}
Update an environment(endpoint) group
EndpointGroupUpdate 1 param body → 200400404500
DELETE
/endpoint_groups/{id}/endpoints/{endpointId}
Removes environment(endpoint) from an environment(endpoint) group
EndpointGroupDeleteEndpoint 2 params → 204400404500
PUT
/endpoint_groups/{id}/endpoints/{endpointId}
Add an environment(endpoint) to an environment(endpoint) group
EndpointGroupAddEndpoint 2 params → 204400404500

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are portainer.EndpointGroup (10 properties), endpointgroups.endpointGroupUpdatePayload (6 properties), endpointgroups.endpointGroupCreatePayload (4 properties), portainer.AccessPolicy (2 properties). Each schema is shown below with its type and property counts.

portainer.Pair
object
2 properties
portainer.EndpointGroup
object
10 properties
portainer.TeamAccessPolicies
object
endpointgroups.endpointGroupUpdatePayload
object
6 properties
endpointgroups.endpointGroupCreatePayload
object
4 properties 1 required
portainer.UserAccessPolicies
object
portainer.AccessPolicy
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

portainer-endpoint-groups-api-openapi.yml Raw ↑

Other APIs Portainer publishes across the network.

Portainer auth API
Portainer backup API
Portainer custom_templates API
Portainer docker API
Portainer edge API
Portainer edge_groups API
Portainer edge_jobs API
Portainer edge_stacks API
Portainer endpoints API
Portainer gitops API
Portainer helm API
Portainer intel API
Where this information came from

This is an independent, third-party profile of Portainer endpoint_groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.