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/3A2D-04C6-974C-4AC6-9D1A/sites/e548e826-c3ea-4a1e-a1aa-f0d0113695c4/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": "524123f8-9950-44bc-92cc-f8537491c5b6,a6bbf4c7-4f1f-4d98-9b2f-181cfb36bbd9"
}
<SetCommandReOrDeactivateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndpointsList>524123f8-9950-44bc-92cc-f8537491c5b6,a6bbf4c7-4f1f-4d98-9b2f-181cfb36bbd9</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).