endpoint_groups

Inspect an Environment(Endpoint) group

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

get/endpoint_groups/{id}

Request

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

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

Changes

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