api_instance_security_dashboard¶
Configuration for AF API Instance Security Dashboard Report table resource.
Properties¶
(click to see Operations )
Name | Data Type | Permissions | Description |
---|---|---|---|
ctnssource_ip_address | <String> | Read-write | Client IP Address.
Minimum length = 1 Maximum length = 64 |
api_instance | <String> | Read-write | API Instance Name.
Maximum length = 255 |
__count | <Double> | Read-write | count.. |
total_api_endpoint | <Double> | Read-write | Total API Endpoint. |
rpt_sample_time | <Double> | Read-write | Report Sample time.. |
total_bytes | <Double> | Read-write | Total bytes accounted by this URL in sampled timeframe.. |
http_req_method | <String> | Read-write | HTTP Request Method..
Maximum length = 30 |
server_response_time | <Double> | Read-write | Server response time.. |
total_auth_success | <Double> | Read-write | Total Authentication Success in sampled timeframe.. |
response_time | <Double> | Read-write | Response time.. |
total_auth_failure | <Double> | Read-write | Total Auth Failure. |
api_endpoint | <String> | Read-write | API Endpoint Name.
Maximum length = 255 |
total_requests | <Double> | Read-write | Total Requests for this device in given sampled timeframe.. |
authentication_status_code | <String> | Read-write | Authentication Failure Reason.
Maximum length = 255 |
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/api_instance_security_dashboard
Query-parameters:
report_start_time Use this query-parameter to specify the start time from which the summary for report is considered.
Possible Values: time in milli seconds
report_end_time Use this query-parameter to specify the end time until where summary for report is considered.
Possible Values: time in milli seconds
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, "api_instance_security_dashboard":[{
"ctnssource_ip_address":<String_value>,
"api_instance":<String_value>,
"__count":<Double_value>,
"total_api_endpoint":<Double_value>,
"rpt_sample_time":<Double_value>,
"total_bytes":<Double_value>,
"http_req_method":<String_value>,
"server_response_time":<Double_value>,
"total_auth_success":<Double_value>,
"response_time":<Double_value>,
"total_auth_failure":<Double_value>,
"api_endpoint":<String_value>,
"total_requests":<Double_value>,
"authentication_status_code":<String_value>}]}