Citrix ADM NITRO API Reference

http_header

Configuration for Enable/Disable HTTP header info for user_agent, http_req_method, http_resp_status, operating_system as 1st level tree nodes. resource.

Properties

(click to see Operations )

Name Data Type Permissions Description
http_content_type <Boolean> Read-write Enable/Disable Http Content Type report.
__count <Double> Read-write Count..
http_resp_status <Boolean> Read-write Enable/Disable Http Resp Status report.
user_agent <Boolean> Read-write Enable/Disable user agent report.
operating_system <Boolean> Read-write Enable/Disbale Operating System report .
http_media_type <Boolean> Read-write Enable/Disable Http Media Type report.
http_req_method <Boolean> Read-write Enable/Disable http req method report.
domain <Boolean> Read-write Enable/Disbale Domain report .
ic_nostore_reason <Boolean> Read-write Enable/Disable Cache No Store Reason report.

Operations

(click to see Properties )

  • GET (ALL)
  • MODIFY

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/http_header Query-parameters:

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, "http_header":[{
"http_content_type":<Boolean_value>,
"__count":<Double_value>,
"http_resp_status":<Boolean_value>,
"user_agent":<Boolean_value>,
"operating_system":<Boolean_value>,
"http_media_type":<Boolean_value>,
"http_req_method":<Boolean_value>,
"domain":<Boolean_value>,
"ic_nostore_reason":<Boolean_value>}]}

<!--NeedCopy-->

modify

URL: https://<MGMT-IP>/nitro/v2/config/http_header/ Query-parameters: HTTPS Method: PUT

Request Payload:

{"http_header":{
"domain":<Boolean_value>,
"__count":<Double_value>,
"http_content_type":<Boolean_value>,
"user_agent":<Boolean_value>,
"http_resp_status":<Boolean_value>,
"ic_nostore_reason":<Boolean_value>,
"operating_system":<Boolean_value>,
"http_req_method":<Boolean_value>,
"http_media_type":<Boolean_value>}}

<!--NeedCopy-->

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 Payload:

{ "errorcode": 0, "message": "Done", "severity": ;ltString_value;gt, "http_header":[{
"http_content_type":<Boolean_value>,
"__count":<Double_value>,
"http_resp_status":<Boolean_value>,
"user_agent":<Boolean_value>,
"operating_system":<Boolean_value>,
"http_media_type":<Boolean_value>,
"http_req_method":<Boolean_value>,
"domain":<Boolean_value>,
"ic_nostore_reason":<Boolean_value>}]}

<!--NeedCopy-->
http_header