endpoint_groups

Create an Environment(Endpoint) Group

Create a new environment(endpoint) group. Access policy: administrator

post/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

Request body

AssociatedEndpointsinteger[]

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

Descriptionstring

Environment(Endpoint) group description

Namestring required

Environment(Endpoint) group name

TagIDsinteger[]

List of tag identifiers to which this environment(endpoint) group is associated

Example request

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

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

Changes

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