edge_groups

Updates an EdgeGroup

Access policy: administrator

put/edge_groups/{id}

Request

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

Path parameters

idinteger required

EdgeGroup Id

Request body

Dynamicboolean
Endpointsinteger[]
Namestring
PartialMatchboolean
TagIDsinteger[]

Response

OK

Dynamicboolean
EndpointIdsRoarRoarPortainerEndpointID
Endpointsinteger[]

Deprecated: only used for API responses

Idinteger

EdgeGroup Identifier

Namestring
PartialMatchboolean
TagIdsinteger[]

Example response

{
  "Id": 1
}

Changes

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