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 |
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": "e5a65647-cbf2-4ee7-9d71-4e3234306cfb,812a7b1d-a4d8-4cd1-998d-882e7c4a46c5"
}
<SetCommandReOrDeactivateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Webroot.UnityAPI.ServiceExtension.Console.Models"> <EndpointsList>e5a65647-cbf2-4ee7-9d71-4e3234306cfb,812a7b1d-a4d8-4cd1-998d-882e7c4a46c5</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).