createIsolateEndpointTask
This method creates one or more tasks to isolate the specified endpoint or endpoints.
Important
This method has been updated to version 1.2.
For information applicable to version 1.1, refer to the Version 1.1 section.
For information applicable to version 1.0, refer to the Version 1.0 section.
You must have a license that includes access to incidents to use this method.
Parameters
Parameter | Type | Optional | Description and value requirements |
|---|---|---|---|
| Array of Strings | No, it is mandatory | The IDs of the endpoints to be isolated. Each string in the array should consist of exactly 24 hexadecimal characters. The array is limited to a maximum of 1000 items. If any endpoint ID in the array is invalid, no endpoints will be isolated. |
These are common parameters, available across all public API methods:
Parameter | Description | Included in request | Type | Values |
|---|---|---|---|---|
| This parameter adds an identifier to the request, linking it to its corresponding response. The target replies with the same value in the response, allowing easy call tracking. | Mandatory | String | No additional requirements. |
| The name of the method you are using to send the request. | Mandatory | String | Must be a valid method name. |
| The version of JSON-RPC used by the request and the response. | Mandatory | String | The only possible value is |
| An object containing the configuration of the request. | Mandatory | Object | No additional requirements. |
Return value
Attribute | Type | Description |
|---|---|---|
| Array of Strings | A list of task IDs, with one task generated per company associated with the listed endpoints. |
Example
Request:
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"method": "createIsolateEndpointTask",
"params": {
"endpointIds": ["5b680f6fb1a43d860a7b23c1", "3c780f6fb1a43d860a7b23c1"]
}
} Response:
{
"id": "5399c9b5-0b46-45e4-81aa-889952433d86",
"jsonrpc": "2.0",
"result": [
"652feab6b9684f3ba80685d5",
"7f3c21d8e4a9424e9c3fbb17"
]
}Version 1.1
Parameters
Parameter | Type | Optional | Description and value requirements |
|---|---|---|---|
| String | No, it is mandatory | The ID of the endpoint to be isolated. The parameter should consist of exactly 24 hexadecimal characters. |
These are common parameters, available across all public API methods:
Parameter | Description | Included in request | Type | Values |
|---|---|---|---|---|
| This parameter adds an identifier to the request, linking it to its corresponding response. The target replies with the same value in the response, allowing easy call tracking. | Mandatory | String | No additional requirements. |
| The name of the method you are using to send the request. | Mandatory | String | Must be a valid method name. |
| The version of JSON-RPC used by the request and the response. | Mandatory | String | The only possible value is |
| An object containing the configuration of the request. | Mandatory | Object | No additional requirements. |
Return value
This method returns an array containing the parent task ID of the created task.
Example
Request:
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"method": "createIsolateEndpointTask",
"params": {
"endpointId": "5b680f6fb1a43d860a7b23c1"
}
} Response:
{
"id": "5399c9b5-0b46-45e4-81aa-889952433d86",
"jsonrpc": "2.0",
"result": [
"652feab6b9684f3ba80685d5"
]
} Version 1.0
Parameters
Parameter | Type | Optional | Description and value requirements |
|---|---|---|---|
| String | No, it is mandatory | The ID of the endpoint to be isolated. The parameter should consist of exactly 24 hexadecimal characters. |
These are common parameters, available across all public API methods:
Parameter | Description | Included in request | Type | Values |
|---|---|---|---|---|
| This parameter adds an identifier to the request, linking it to its corresponding response. The target replies with the same value in the response, allowing easy call tracking. | Mandatory | String | No additional requirements. |
| The name of the method you are using to send the request. | Mandatory | String | Must be a valid method name. |
| The version of JSON-RPC used by the request and the response. | Mandatory | String | The only possible value is |
| An object containing the configuration of the request. | Mandatory | Object | No additional requirements. |
Return value
This method returns a Boolean, which is true if the operation was successful.
Example
Request:
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"method": "createIsolateEndpointTask",
"params": {
"endpointId": "5b680f6fb1a43d860a7b23c1"
}
} Response:
{
"id": "0df7568c-59c1-48e0-a31b-18d83e6d9810",
"jsonrpc": "2.0",
"result": true
}