PUT /service/api/console/gsm/{gsmKey}/sites/{siteId}/endpoints

Moves endpoints to a different group.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

string

Required

siteId

The site identifier.

string

Required

Body Parameters

Additional information for setting a group for endpoints.

Either use EndpointsList or SourceGroupId to specify the endpoints being moved. If both are specified, EndpointsList is used. If both are left empty, all endpoints on the site are moved to the group specified by TargetGroupId.

SetGroupEndpointsRequestModel
NameDescriptionTypeAdditional Information
EndpointsList

Comma delimited string of endpoint ids. The endpoints are moved to the group specified by TargetGroupId.

string

None.

SourceGroupId

The id of the group where endpoints are moved from.

string

None.

TargetGroupId

The id of the group where endpoints are moved to.

string

Required

Inheritance

Value defining which policy should take effect.

  • 0 = The current policies of the endpoints will be left unchanged.
  • 1 = The target group's policy will be applied to all endpoints added to the group.
  • 3 = The target group's policy will be applied to endpoints which had their previous group's policy assigned.
Default value is 0.

integer

None.

Sample Request

{
  "EndpointsList": null,
  "SourceGroupId": "8d905e07-c3e9-4da1-b7f4-f73e48bd26c1",
  "TargetGroupId": "5dfadd0f-8b44-4d10-87c2-b3b421c4cd1b",
  "Inheritance": 1
}                    
<SetGroupEndpointsRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <EndpointsList i:nil="true" />
  <Inheritance>1</Inheritance>
  <SourceGroupId>8d905e07-c3e9-4da1-b7f4-f73e48bd26c1</SourceGroupId>
  <TargetGroupId>5dfadd0f-8b44-4d10-87c2-b3b421c4cd1b</TargetGroupId>
</SetGroupEndpointsRequestModel>                    

Response Information

Resource Description

None. If successful, this API action does not return any data and the response status code will be 204 (No Content).