Isolates devices.

Isolates the specified devices.

post/api/v1/accounts/{accountId}/devices/isolation

Request

Base URL
https://api.usa.cloud.watchguard.com/rest/aether-endpoint-security/aether-mgmt
Auth
API key in header WatchGuard-API-Key and HTTP bearer
TypeScript
https://skmtc.dev/watchguard/apis/aether-endpoint-security-api/docs/api/v1/accounts/:accountId/devices/isolation/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountIdstring required

Your WatchGuard Cloud account ID.

Request body

device_idsstring[]

exclusion_programsstring[]

List of programs to exclude from isolation and allow to communicate normally.

customized_messagestring

Text to show in an alert message on the isolated devices.

hide_customized_alertboolean

Indicates whether to hide the customized alert message on isolated devices.

Example request

{
  "device_ids": [
    "00ab3e54-7bb7-4bd3-bd39-237a9d191a44"
  ],
  "customized_message": "This computer has been isolated by an administrator.",
  "hide_customized_alert": true
}

Response

OK. Returns the IDs of devices isolated in this operation.

processed_device_idsstring[]

no_executed_by_not_found_device_idsstring[]

Example response

{
  "processed_device_ids": [
    "00ab3e54-7bb7-4bd3-bd39-237a9d191a44, 287324d8-194f-4f5a-a7ad-e2480d5ad1b2"
  ],
  "no_executed_by_not_found_device_ids": [
    "00ab3e54-7bb7-4bd3-bd39-237a9d191a44, 287324d8-194f-4f5a-a7ad-e2480d5ad1b2"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.