To create a system dump, send the following request:
POST https://<IA_IP_address>/config/v1/system/generatedump
Note
To use this request, you must belong to the sudo group.
Required header:
--user <username>:<password>
Options
IA_IP_address—IP address of the NDR appliance running the NDR API.
username—Administrator user name.
password—Administrator password.
Example
POST https://xxx.xxx.xxx.xxx/config/v1/system/generatedump
Required header:
--user npadmin:hammerhead
Create a system dump: Response
HTTP/1.1 [Response Code] [Response Message] Date: [Date] Content-Type: [Content Type] Status: [Status]
Response fields
Response Code—A standard HTTP response code.
Response Message—A standard HTTP response message.
Date—Standard HTML date format.
Content Type—The response format.
Status—Status of system dump generation. "Null" if the system dump file is generated successfully. You will see an error message if the system dump generation fails.
Example
HTTP/1.1 200 OK
Date: Thu, 26 Jan 2017 19:09:53 GMT
Content-Type: application/json; charset=utf-8
{
"status": "null"
}cURL code sample: Create a system dump
The code sample was run with cURL 7.57.0.
curl -k --user npadmin:hammerhead https://xxx.xxx.xxx.xxx/config/v1/system/generatedump -X POST
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.--user npadmin:hammerhead—Replacenpadminwith the user name for your NDR appliance. Replacehammerheadwith the password for your NDR appliance.https://xxx.xxx.xxx.xxx/config/v1/system/generatedump—The system dump request URL. Replacexxx.xxx.xxx.xxxwith the IP address of your NDR appliance.-X POST—This option specifies using the POST method.
Results
This example creates a system dump.