Sign in

v13

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

Update an environment(endpoint) group

Update an environment(endpoint) group. Access policy: administrator

put/endpoint_groups/{id}

Path parameters

idinteger required

EndpointGroup identifier

Request body

AssociatedEndpointsinteger[]

List of environment(endpoint) identifiers that will be part of this group

Descriptionstring

Environment(Endpoint) group description

Namestring

Environment(Endpoint) group name

TagIDsinteger[]

List of tag identifiers associated to the environment(endpoint) group

TeamAccessPoliciesPortainerTeamAccessPolicies
UserAccessPoliciesPortainerUserAccessPolicies

Example request

{
  "AssociatedEndpoints": [
    1,
    3
  ],
  "Description": "description",
  "Name": "my-environment-group",
  "TagIDs": [
    3,
    4
  ]
}

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
UserAccessPoliciesPortainerUserAccessPolicies

Example response

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