Enable alert polling: Request

Prev Next

To enable polling of the Endpoint Security (HX) host, send the following request:

PUT https://<IA_IP_address>:<port_number>/config/v1/device/<device_IP>/alertpoll/enabled/{true|false}

Required header:

Cookie: px=<token>

Note

To use this request, your user account must be assigned to the Admin role.

Options

  • IA_IP_address—The IP address of the NDR appliance running the NDR API.

  • port_number—The port number of the NDR appliance running the NDR API.

  • token—This token authenticates the session. By default, the session times out after 24 hours.

Parameters

  • device_IP—IP address of the configured device.

  • true|false—Enables or disables host polling.

Example

PUT https://xxx.xxx.xxx.xxx:443/config/v1/device/1.1.1.1/alertpoll/enabled/true

Required header:

Cookie: px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Enable alert polling: Response

HTTP/1.1 [Response Code] [Response Message]				
Date: [Date]				
Content-Type: [Content Type]
Response fields
  • Response Code—A standard HTTP response code.

    • 200—Request successful; polling enabled/disabled was changed.

    • 201—Request successful; polling was enabled/disabled for the first time.

  • Date—Standard HTML date format.

Example
HTTP/1.1 200 OK
Date: Fri, 16 Aug 2019 10:33:15 GMT

cURL code sample: Enable alert polling

curl -k --cookie "px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -X PUT https://xxx.xxx.xxx.xxx:443/config/v1/device/1.1.1.1/alertpoll/enabled/true

This cURL sample includes the following options:

  • -k—This option explicitly allows cURL to perform insecure SSL connections and transfers, which allows you to test your SSL connection without installing a CA certificate.

  • --cookie "px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"—This option specifies the authentication token for this session.

  • -X PUT—This option specifies using the PUT method.

  • https://xxx.xxx.xxx.xxx:443/config/v1/device/1.1.1.1/alertpoll/enabled/true—The polling request URL. Replace xxx.xxx.xxx.xxx with the IP address of your NDR appliance, 1.1.1.1 with the IP address of the configured device, and true with the desired Boolean value.

Results

This example enables Endpoint Security (HX) alert polling.