PX host statistics: Request

To get the specified statistics from a Packet Capture appliance connected to an NDR appliance, send the following request:

POST https://<IA_IP_address>:<port_number>/stats/v1/pxstats/<cluster_name>/host/<PX_host>/<measurement>

Required header:

Cookie: px=<token>

Request body:

{
  "from" : "date-time",
  "to" : "date-time", 
}

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.
cluster_name—The name of the cluster.
PX_host—The name of the PX appliance.
measurement—See the "Statistics" chapter of the Packet Capture API Guide for the types of statistics available.
token—This token authenticates the session. By default, the session times out after 24 hours.

Parameters

from—The UTC start time. The format is yyyy-MM-dd'T'HH:mm:ss.SSS'Z.
to—The UTC end time. The format is yyyy-MM-dd'T'HH:mm:ss.SSS'Z.

Example

POST https://xxx.xxx.xxx.xxx:443/api/4.0/stats/v1/pxstats/ia150/host/xxx.xxx.xxx.xxx/capstats

Required header:

Cookie: px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Request body:

{
  "from": "2016-08-05T16:51:00.821Z",
  "to": "2016-08-05T17:51:00.821Z",
}

PX host statistics: Response

The response varies depending on the type of statistics requested.

HTTP/1.1 [Response Code] [Response Message]
Server: [Server]
Date: [Date]
Content-Type: [Content Type]

Response fields

See the "Statistics" chapter of the Packet Capture API Guide for statistics-specific response fields.

Response Code—A standard HTTP response code.
Response Message—A standard HTTP response message.
Server—The server being used.
Date—Standard HTML date format.
Content Type—The response format.

Example

HTTP/1.1 200 OK
Server: nginx
Date: Fri, 29 Apr 2016 17:22:00 GMT
Content-Type: application/json; charset=utf-8	

{
   "results": [
   {
	"series": [
	{
	   "name": "Streams",
	   "tags": {
		"stream": "0",
		"type": "Dfps"
	   },
	   "values": [
		[
		   1470419400,
		   0
		],
		[
		   1470418800,
		   0
		],
		[
		   1470418200,
		   0
		],
		[
		   1470417600,
		   0
		],
		[
		   1470417000,
		   0
		],
		[
		   1470416400,
		   0
		],
		[
		   1470415800,
		   null
		]
	   ],
	   "columns": [
		"time",
		"mean"
	   ]
	},
...

cURL code sample: PX host statistics

curl -k -X POST -H "Content-Type: application/json" --cookie "px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" https://xxx.xxx.xxx.xxx:443/stats/v1/pxstats/ia150/host/xxx.xxx.xxx.xxx/capstats -d '{"from":"2016-08-05T16:51:00.821Z", "to":"2016-08-05T17:51:00.821Z"}'

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.
-X POST—This option changes the HTTP method to POST.
-H "Content-Type: application/json"—This header specifies that the request body is in JSON format.
--cookie "px=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"—This option specifies the authentication token for this session.
https:/xxx.xxx.xxx.xxx:443/stats/v1/pxstats/ia150/host/xxx.xxx.xxx.xxx/capstats—The statistics request URL. Replace the first xxx.xxx.xxx.xxx with the IP address of your NDR appliance. Replace ia150 with the cluster name of interest. Replace the second xxx.xxx.xxx.xxx with the IP address of a PX appliance connected to your NDR appliance.
-d '{"from":"2016-08-05T16:51:00.821Z", "to":"2016-08-05T17:51:00.821Z"}'—The beginning and end of the time range to collect statistics.

Results

This example returns the specified statistics from a PX appliance connected to an NDR appliance. The output is in JSON format.