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
| Name | Description | Type | Additional 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/0C03-D24C-0B1A-4DE9-A781/sites/e3e3aa06-9274-4d8a-a3a9-4a40cb9cf8eb/endpoints/deactivate
|
Body Parameters
Additional information for deactivating endpoints.
SetCommandReOrDeactivateRequestModel| Name | Description | Type | Additional 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": "21369b79-2732-4090-8ac8-b7267950139e,f9037bd8-8b65-4e6e-9d40-2907ab8b64b6"
}
<SetCommandReOrDeactivateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndpointsList>21369b79-2732-4090-8ac8-b7267950139e,f9037bd8-8b65-4e6e-9d40-2907ab8b64b6</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).