endpoint_groups

List Environment(Endpoint) groups

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

get/endpoint_groups

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/endpoint_groups
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Query parameters

sizeboolean

If true, each environment(endpoint) group will include the number of environments(endpoints) associated to it and breakdown by type

Response

Environment(Endpoint) group

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"
  }
]

Changes

No recorded changes to this operation across all 21 revisions of this API.