ADM NITRO APIs

swg_domain_summary

June 20, 2023

Contributed by:

Configuration for swg_domain_summary resource.

Properties

(click to see Operations )

Name	Permissions	Description
total_ssl_intercepts_prev	Read-write	Total Intercepts.
protocol	Read-write	protocol used.
__count	Read-write	count..
operating_system	Read-write	Client Operating System Name.. Maximum length = 255
total_ssl_intercepts	Read-write	Total Intercepts.
total_bytes_in	Read-write	Total bytes in.
url_group_category	Read-write	URL Group Category.
total_bytes_out_prev	Read-write	Total bytes out.
user_agent	Read-write	User Agent Name.. Maximum length = 255
total_bytes	Read-write	Total bytes .
rpt_sample_time	Read-write	Report Sample time..
total_bytes_in_prev	Read-write	Total bytes in.
port	Read-write	protocol used.
total_bytes_prev	Read-write	Total bytes out.
domain_name	Read-write	Domain Name. Maximum length = 255
exporter_id	Read-write	Exporter ID.
total_bytes_out	Read-write	Total bytes out.
url_reputation	Read-write	URL reputation.
total_requests_prev	Read-write	Total transactions.
total_requests	Read-write	Total transactions.

Operations

(click to see Properties )

GET (ALL)

Some options that you can use for each operations:

Getting warnings in response: NITRO allows you to get warnings in an operation by specifying the 'warning' query parameter as 'yes'. For example, to get warnings while connecting to the NetScaler appliance, the URL is as follows:

http:// <netscaler-ip-address> /nitro/v1/config/login?warning=yes

If any, the warnings are displayed in the response payload with the HTTP code '209 X-NITRO-WARNING'.
Authenticated access for individual NITRO operations: NITRO allows you to logon to the NetScaler appliance to perform individual operations. You can use this option instead of creating a NITRO session (using the login object) and then using that session to perform all operations,

To do this, you must specify the username and password in the request header of the NITRO request as follows:

X-NITRO-USER: <username>

X-NITRO-PASS: <password>

Note: In such cases, make sure that the request header DOES not include the following:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

*Note:* Mandatory parameters are marked in red and placeholder content is marked in green

The following parameters can be used in the nitro request : onerror <String_value>

Use this parameter to set the onerror status for nitro request. Applicable only for bulk requests.

Default value: EXIT

Possible values = EXIT, CONTINUE

get (all)

URL: https://<MGMT-IP>/nitro/v2/config/swg_domain_summary Query-parameters:

group_by Use this query-parameter to get the result that is grouped by according to the given property.

Possible Values: domain_name, url_group_category, port, protocol, operating_system HTTPS Method: GET

Response: HTTPS Status Code on Success: 200 OK HTTPS Status Code on Failure: 4xx (for general HTTPS errors) or 5xx (for NetScaler-MAS-specific errors). The response payload provides details of the error

Response Headers:

Content-Type:application/json

Response Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "swg_domain_summary":[{
"total_ssl_intercepts_prev":<Double_value>,
"protocol":<String_value>,
"__count":<Double_value>,
"operating_system":<String_value>,
"total_ssl_intercepts":<Double_value>,
"total_bytes_in":<Double_value>,
"url_group_category":<String_value>,
"total_bytes_out_prev":<Double_value>,
"user_agent":<String_value>,
"total_bytes":<Double_value>,
"rpt_sample_time":<Double_value>,
"total_bytes_in_prev":<Double_value>,
"port":<Double_value>,
"total_bytes_prev":<Double_value>,
"domain_name":<String_value>,
"exporter_id":<Double_value>,
"total_bytes_out":<Double_value>,
"url_reputation":<Double_value>,
"total_requests_prev":<Double_value>,
"total_requests":<Double_value>}]}

<!--NeedCopy-->

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

swg_domain_summary

June 20, 2023

Contributed by:

June 20, 2023

Contributed by:

swg_domain_summary

Properties

Operations

get (all)

In this article