Sign in

v13

latestOpenAPI 3.0.0zlibraw.githubusercontent.com2026-08-01265409652.5 KB
endpoint_groups

Inspect an Environment(Endpoint) group

Retrieve details abont an environment(endpoint) group. Access policy: administrator

get/endpoint_groups/{id}

Path parameters

idinteger required

Environment(Endpoint) group identifier

Query parameters

sizeboolean

If true, include the number of environments and breakdown by type

Response

Success

Descriptionstring required

Description associated to the environment(endpoint) group

Idinteger required

Environment(Endpoint) group Identifier

Namestring required

Environment(Endpoint) group name

TagIdsinteger[]

List of tags associated to this environment(endpoint) group

TeamAccessPoliciesPortainerTeamAccessPolicies
Totalinteger
UserAccessPoliciesPortainerUserAccessPolicies

Example response

{
  "Description": "Environment(Endpoint) group description",
  "Id": 1,
  "Name": "my-environment-group"
}