Update Endpoint Security (HX) configuration: Request

Prev Next

To update the Endpoint Security (HX) integration configuration, send the following request:

PUT https://<IA_IP_address>:<port_number>/config/v1/device

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.

Request body:

{
  "type": "HX",
  "ip": "1.1.1.1",
  "port": "3000",
  "username": "iaanalyst",
  "password": "somepassword"
}

Example

PUT https://xxx.xxx.xxx.xxx:443/config/v1/device

Required header:

Cookie: px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Update Endpoint Security (HX) configuration: 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; the configuration was updated.

  • Response Message—A standard HTTP response message.

    • OK—Request successful; the configuration was updated.

  • Date—Standard HTML date format.

Example
HTTP/1.1 200 OK
Date: Fri, 16 Aug 2019 10:31:52 GMT

cURL code sample: Update Endpoint Security (HX) configuration

curl -k --cookie "px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -X PUT https://xxx.xxx.xxx.xxx:443/config/v1/device -d '{ "type": "HX", "ip": "1.1.1.1", "port": "3000", "username": "iaanalyst", "password": "somepassword" }'

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—The integration request URL. Replace xxx.xxx.xxx.xxx with the IP address of your NDR appliance.

  • -d '{ "type": "HX", "ip": "1.1.1.1", "port": "3000", "username": "iaanalyst", "password": "somepassword" }'—Specifies the new configuration. Replace the values with your own.

Results

This example updates the Endpoint Security (HX) integration configuration.