edge_groups

list EdgeGroups

Access policy: administrator

get/edge_groups

Request

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

Response

EdgeGroups

Dynamicboolean
EndpointIdsinteger

Shadow to avoid exposing in the API

EndpointTypesPortainerEndpointType[]
Endpointsinteger[]

Deprecated: only used for API responses

HasEdgeJobboolean
HasEdgeStackboolean
Idinteger

EdgeGroup Identifier

Namestring
PartialMatchboolean
TagIdsinteger[]
TrustedEndpointsinteger[]

Example response

[
  {
    "Id": 1
  }
]

Changes

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