POST /service/api/console/gsm/{gsmKey}/sites/{siteId}/endpoints/deactivate

Deactivates a list of endpoints, or all endpoints on a site.

Request Information

URI Parameters

NameDescriptionTypeAdditional Information
gsmKey

The GSM console keycode.

 string

Required
siteId

The site identifier.

 string

Required

URI Sample(s)
POST
https://unityapi.webrootcloudav.com/service/api/console/gsm/C4A0-5E7F-1C12-4608-8B95/sites/7f3bbf23-8c42-4c79-9cc1-44701ba38513/endpoints/deactivate

Body Parameters

Additional information for deactivating endpoints.

SetCommandReOrDeactivateRequestModel
NameDescriptionTypeAdditional Information
EndpointsList

Comma delimited string of endpoint ids. If not specified, the command gets applied to all endpoints on the site.

 string

None.

Sample Request

{
  "EndpointsList": "c04e1261-e639-441c-9415-f42be9f7c3e5,7d739a26-ce79-4b29-bf21-ee45e4361809"
}                    
<SetCommandReOrDeactivateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models">
  <EndpointsList>c04e1261-e639-441c-9415-f42be9f7c3e5,7d739a26-ce79-4b29-bf21-ee45e4361809</EndpointsList>
</SetCommandReOrDeactivateRequestModel>

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).