Add or update licenses: Request

Prev Next

To add or update licenses, send the following request:

POST https://<IA_IP_address>:<port_number>/config/v1/licenses

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:

<license_string>

Example

POST https://xxx.xxx.xxx.xxx:443/config/v1/licenses

Required header:

Cookie: px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Add or update licenses: 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 license was added or updated.

    • 400—The new information was invalid.

  • Response Message—A standard HTTP response message.

    • OK—Request successful; the license was updated.

  • Date—Standard HTML date format.

Example
HTTP/1.1 200 OK
Date: Thu, 15 Aug 2019 17:32:21 GMT

cURL code sample: Add or update licenses

curl -k --cookie "px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -X POST https://xxx.xxx.xxx.xxx:443/config/v1/licenses -d LK2-FIREEYE_APPLIANCE-413H-K76A-6J19-8TU4-3A44-4MM4-DBAQ-5H39-L2Q5-J739-54KT-45K7-12MA-K288-2F0V-K0CH-H64U-KAC1-G63H-F1U6-JTK1-F5GJ-VV3F-DHLN-4UUR-D5P6-2G36-D5R6-ARBR-CLP6-6UUD-6414-87GL-121K-8PD9-VVCT

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 POST—This option specifies using the POST method.

  • https://xxx.xxx.xxx.xxx:443/config/v1/licenses—The license request URL. Replace xxx.xxx.xxx.xxx with the IP address of your NDR appliance.

  • -d LK2-FIREEYE_APPLIANCE-413H-K76A-6J19-8TU4-3A44-4MM4-DBAQ-5H39-L2Q5-J739-54KT-45K7-12MA-K288-2F0V-K0CH-H64U-KAC1-G63H-F1U6-JTK1-F5GJ-VV3F-DHLN-4UUR-D5P6-2G36-D5R6-ARBR-CLP6-6UUD-6414-87GL-121K-8PD9-VVCT—Specifies the new or updated license string. Replace the string with your license string.

Results

This example adds or updates a license.