Download a system dump: Request

To download a system dump, send the following request:

GET https://<IA_IP_address>/config/v1/system/downloaddump/sysdump-{epochtime}.tar.gz -o sysdump-{epochtime}.tar.gz

Required header:

--user <username>:<password>

Options

IA_IP_address—IP address of the NDR appliance running the NDR API.
filename—System dump file name.
username—Administrator user name.
password—Administrator password.

Example

GET https://xxx.xxx.xxx.xxx/config/v1/system/downloaddump/sysdump-{epochtime}.tar.gz -o sysdump-{epochtime}.tar.gz

Required header:

--user npadmin:hammerhead

Download a system dump: Response

% Total: [Total Percentage]
% Received: [Percentage Received] 
% Xferd: [Percentage Transferred] 
Average Dload: [Download Speed] 
Speed Upload: [Upload Speed]  
Time Total: [Total Time]
Time Spent: [Time Spent]
Time Left: [Time Left]		
Current Speed: [Current Speed]

Response fields

Total Percentage—How much of the file was downloaded.
Percentage Received—How much of the file was received.
Percentage Transferred—How much of the file was transferred.
Download Speed—Average download speed.
Upload Speed—Average upload speed.
Total Time—Time required for downloading the file.
Time Spent—How much time has been spent downloading the file.
Time Left—How much time it will take to finish donloading the file.
Current Speed—Current download speed.

Example

% Total % Received % Xferd  Average Speed   Time  Time   Time  Current
		              Dload   Upload  Total Spent  Left  Speed 
100      9854k      100      9854k   0       0     1824k  0  0:00:05  0:00:05 --:--:-- 2006

cURL code sample: Download 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/downloaddump/sysdump-{epochtime}.tar.gz -o sysdump-{epochtime}.tar.gz

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—Replace npadmin with the user name for your NDR appliance. Replace hammerhead with the password for your NDR appliance.
https://xxx.xxx.xxx.xxx/config/v1/system/downloaddump/filename.tar.gz—The system dump request URL. Replace xxx.xxx.xxx.xxx with the IP address of your NDR appliance. Replace filename.tar.gz with the file name of the system dump file.

Results

This example downloads the specified system dump to your local machine.