ADC NITRO APIs

sc

Statistics for sc.

Properties

(click to see Operations )

Name Data Type Permissions Description
clearstats <String> Read-write Clear the statsistics / counters.

Possible values = basic, full
sctotcondtriggered <Double> Read-only Number of times that SureConnect conditions were triggered.
sccondtriggeredrate <Double> Read-only Rate (/s) counter for sctotcondtriggered
scpolicyurlhits <Double> Read-only Total number of incoming requests that matched configured sureconnect policies.
scpolicyurlhitsrate <Double> Read-only Rate (/s) counter for scpolicyurlhits
scpopups <Double> Read-only Total number of in-memory java script served which throws the pop-up window.
scpopupsrate <Double> Read-only Rate (/s) counter for scpopups
sctotreissuedrequests <Double> Read-only Total number of reissued SureConnect requests.
screissuedrequestsrate <Double> Read-only Rate (/s) counter for sctotreissuedrequests
scsessionreqs <Double> Read-only Total number of requests that were handled in a single SureConnect session.
scsessionreqsrate <Double> Read-only Rate (/s) counter for scsessionreqs
scaltconturls <Double> Read-only Total number of alternate content served which throws the pop-up window.
scaltconturlsrate <Double> Read-only Rate (/s) counter for scaltconturls
scpostreqs <Double> Read-only Total number of HTTP POST requests that triggered SureConnect feature.
scpostreqsrate <Double> Read-only Rate (/s) counter for scpostreqs
scresetstats <Double> Read-only Toal number of times that SureConnect statistics were reset.
scresetstatsrate <Double> Read-only Rate (/s) counter for scresetstats
scunsupbrow <Double> Read-only Total number of requests that came from all unsupported browsers.
scunsupbrowrate <Double> Read-only Rate (/s) counter for scunsupbrow
scfaultycookies <Double> Read-only Total number of corrupted SureConnect cookies.
scfaultycookiesrate <Double> Read-only Rate (/s) counter for scfaultycookies

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/stat/sc

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/stat/sc? args=detail: <Boolean_value> ,fullvalues: <Boolean_value> ,ntimes: <Double_value> ,logfile: <String_value> ,clearstats: <String_value>

Use this query-parameter to get sc resources based on additional properties.

HTTP Method: GET

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Accept:application/json

Response:

HTTP Status Code on Success: 200 OK

HTTP Status Code on Failure: 4xx <string> (for general HTTP errors) or 5xx <string> (for NetScaler-specific errors). The response payload provides details of the error

Response Header:

Content-Type:application/json

Response Payload:


{  "sc": [ {
      "scfaultycookies":<Double_value>,
      "scpopups":<Double_value>,
      "screissuedrequestsrate":<Double_value>,
      "scresetstats":<Double_value>,
      "scpostreqsrate":<Double_value>,
      "scresetstatsrate":<Double_value>,
      "scpopupsrate":<Double_value>,
      "sctotreissuedrequests":<Double_value>,
      "scpostreqs":<Double_value>,
      "scpolicyurlhitsrate":<Double_value>,
      "scaltconturlsrate":<Double_value>,
      "sctotcondtriggered":<Double_value>,
      "scunsupbrow":<Double_value>,
      "sccondtriggeredrate":<Double_value>,
      "scsessionreqsrate":<Double_value>,
      "scsessionreqs":<Double_value>,
      "scfaultycookiesrate":<Double_value>,
      "scunsupbrowrate":<Double_value>,
      "scaltconturls":<Double_value>,
      "scpolicyurlhits":<Double_value>
}]}

<!--NeedCopy-->
sc