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

URI Sample(s)

PUT
https://unityapi.webrootcloudav.com/service/api/console/gsm/D302-3DE3-5FD3-4517-AE7F/sites/9e3841a1-14b2-4edb-a81f-78a4d9641c99/endpoints

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 policy assignment of moved endpoints does not change. Endpoints which previously inherited their policies from the group's endpoint policy setting will inherit from the target group's endpoint policy setting.
  • 1 = The target group's policy will be applied to all moved endpoints.
  • 3 = No longer supported.
Default value is 0.

Note: Inheritance value 3 is no longer supported and behaves as if 0 was specified. If you used value 3 before, it is recommended to switch to value 0 instead.

 integer

None.

Sample Request

{
  "EndpointsList": null,
  "SourceGroupId": "464ded98-d808-4d06-8873-d172e9045c89",
  "TargetGroupId": "005f7f5e-1852-4f17-b05d-a889bde27403",
  "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>464ded98-d808-4d06-8873-d172e9045c89</SourceGroupId>
  <TargetGroupId>005f7f5e-1852-4f17-b05d-a889bde27403</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).