ADC NITRO APIs

service

August 17, 2023

Contributed by:

Configuration for service resource.

Properties

(click to see Operations )

Name	Permissions	Description
name	Read-write	Name for the service. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Cannot be changed after the service has been created. Minimum length = 1
ip	Read-write	IP to assign to the service. Minimum length = 1
servername	Read-write	Name of the server that hosts the service. Minimum length = 1
servicetype	Read-write	Protocol in which data is exchanged with the service. Possible values = HTTP, FTP, TCP, UDP, SSL, SSL_BRIDGE, SSL_TCP, DTLS, NNTP, RPCSVR, DNS, ADNS, SNMP, RTSP, DHCPRA, ANY, SIP_UDP, SIP_TCP, SIP_SSL, DNS_TCP, ADNS_TCP, MYSQL, MSSQL, ORACLE, MONGO, MONGO_TLS, RADIUS, RADIUSListener, RDP, DIAMETER, SSL_DIAMETER, TFTP, SMPP, PPTP, GRE, SYSLOGTCP, SYSLOGUDP, FIX, SSL_FIX, USER_TCP, USER_SSL_TCP, QUIC, IPFIX, LOGSTREAM, LOGSTREAM_SSL
port	Read-write	Port number of the service. Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
cleartextport	Read-write	Port to which clear text data must be sent after the appliance decrypts incoming SSL traffic. Applicable to transparent SSL services. Minimum value = 1
cachetype	Read-write	Cache type supported by the cache server. Possible values = TRANSPARENT, REVERSE, FORWARD
maxclient	Read-write	Maximum number of simultaneous open connections to the service. Minimum value = 0 Maximum value = 4294967294
healthmonitor	Read-write	Monitor the health of this service. Available settings function as follows YES - Send probes to check the health of the service. NO - Do not send probes to check the health of the service. With the NO option, the appliance shows the service as UP at all times. Default value: YES Possible values = YES, NO
maxreq	Read-write	Maximum number of requests that can be sent on a persistent connection to the service. Note: Connection requests beyond this value are rejected. Minimum value = 0 Maximum value = 65535
cacheable	Read-write	Use the transparent cache redirection virtual server to forward requests to the cache server. Note: Do not specify this parameter if you set the Cache Type parameter. Default value: NO Possible values = YES, NO
cip	Read-write	Before forwarding a request to the service, insert an HTTP header with the client’s IPv4 or IPv6 address as its value. Used if the server needs the client’s IP address for security, accounting, or other purposes, and setting the Use Source IP parameter is not a viable option. Possible values = ENABLED, DISABLED
cipheader	Read-write	Name for the HTTP header whose value must be set to the IP address of the client. Used with the Client IP parameter. If you set the Client IP parameter, and you do not specify a name for the header, the appliance uses the header name specified for the global Client IP Header parameter (the cipHeader parameter in the set ns param CLI command or the Client IP Header parameter in the Configure HTTP Parameters dialog box at System > Settings > Change HTTP parameters). If the global Client IP Header parameter is not specified, the appliance inserts a header with the name “client-ip.”. Minimum length = 1
usip	Read-write	Use the client’s IP address as the source IP address when initiating a connection to the server. When creating a service, if you do not set this parameter, the service inherits the global Use Source IP setting (available in the enable ns mode and disable ns mode CLI commands, or in the System > Settings > Configure modes > Configure Modes dialog box). However, you can override this setting after you create the service. Possible values = YES, NO
pathmonitor	Read-write	Path monitoring for clustering. Possible values = YES, NO
pathmonitorindv	Read-write	Individual Path monitoring decisions. Possible values = YES, NO
useproxyport	Read-write	Use the proxy port as the source port when initiating connections with the server. With the NO setting, the client-side connection port is used as the source port for the server-side connection. Note: This parameter is available only when the Use Source IP (USIP) parameter is set to YES. Possible values = YES, NO
sc	Read-write	State of SureConnect for the service. Default value: OFF Possible values = ON, OFF
sp	Read-write	Enable surge protection for the service. Possible values = ON, OFF
rtspsessionidremap	Read-write	Enable RTSP session ID mapping for the service. Default value: OFF Possible values = ON, OFF
clttimeout	Read-write	Time, in seconds, after which to terminate an idle client connection. Minimum value = 0 Maximum value = 31536000
svrtimeout	Read-write	Time, in seconds, after which to terminate an idle server connection. Minimum value = 0 Maximum value = 31536000
customserverid	Read-write	Unique identifier for the service. Used when the persistency type for the virtual server is set to Custom Server ID. Default value: “None”
serverid	Read-write	The identifier for the service. This is used when the persistency type is set to Custom Server ID.
cka	Read-write	Enable client keep-alive for the service. Possible values = YES, NO
tcpb	Read-write	Enable TCP buffering for the service. Possible values = YES, NO
cmp	Read-write	Enable compression for the service. Possible values = YES, NO
maxbandwidth	Read-write	Maximum bandwidth, in Kbps, allocated to the service. Minimum value = 0 Maximum value = 4294967287
accessdown	Read-write	Use Layer 2 mode to bridge the packets sent to this service if it is marked as DOWN. If the service is DOWN, and this parameter is disabled, the packets are dropped. Default value: NO Possible values = YES, NO
monthreshold	Read-write	Minimum sum of weights of the monitors that are bound to this service. Used to determine whether to mark a service as UP or DOWN. Minimum value = 0 Maximum value = 65535
state	Read-write	Initial state of the service. Default value: ENABLED Possible values = ENABLED, DISABLED
downstateflush	Read-write	Flush all active transactions associated with a service whose state transitions from UP to DOWN. Do not enable this option for applications that must complete their transactions. Default value: ENABLED Possible values = ENABLED, DISABLED
tcpprofilename	Read-write	Name of the TCP profile that contains TCP configuration settings for the service. Minimum length = 1 Maximum length = 127
httpprofilename	Read-write	Name of the HTTP profile that contains HTTP configuration settings for the service. Minimum length = 1 Maximum length = 127
contentinspectionprofilename	Read-write	Name of the ContentInspection profile that contains IPS/IDS communication related setting for the service. Minimum length = 1 Maximum length = 127
hashid	Read-write	A numerical identifier that can be used by hash based load balancing methods. Must be unique for each service. Minimum value = 1
comment	Read-write	Any information about the service.
appflowlog	Read-write	Enable logging of AppFlow information. Default value: ENABLED Possible values = ENABLED, DISABLED
netprofile	Read-write	Network profile to use for the service. Minimum length = 1 Maximum length = 127
td	Read-write	Integer value that uniquely identifies the traffic domain in which you want to configure the entity. If you do not specify an ID, the entity becomes part of the default traffic domain, which has an ID of 0. Minimum value = 0 Maximum value = 4094
processlocal	Read-write	By turning on this option packets destined to a service in a cluster will not under go any steering. Turn this option for single packet request response mode or when the upstream device is performing a proper RSS for connection based distribution. Default value: DISABLED Possible values = ENABLED, DISABLED
dnsprofilename	Read-write	Name of the DNS profile to be associated with the service. DNS profile properties will applied to the transactions processed by a service. This parameter is valid only for ADNS and ADNS-TCP services. Minimum length = 1 Maximum length = 127
monconnectionclose	Read-write	Close monitoring connections by sending the service a connection termination message with the specified bit set. Default value: NONE Possible values = RESET, FIN
ipaddress	Read-write	The new IP address of the service.
weight	Read-write	Weight to assign to the monitor-service binding. When a monitor is UP, the weight assigned to its binding with the service determines how much the monitor contributes toward keeping the health of the service above the value configured for the Monitor Threshold parameter. Minimum value = 1 Maximum value = 100
monitor_name_svc	Read-write	Name of the monitor bound to the specified service. Minimum length = 1
delay	Read-write	Time, in seconds, allocated to the Citrix ADC for a graceful shutdown of the service. During this period, new requests are sent to the service only for clients who already have persistent sessions on the appliance. Requests from new clients are load balanced among other available services. After the delay time expires, no requests are sent to the service, and the service is marked as unavailable (OUT OF SERVICE).
graceful	Read-write	Shut down gracefully, not accepting any new connections, and disabling the service when all of its connections are closed. Default value: NO Possible values = YES, NO
all	Read-write	Display both user-configured and dynamically learned services.
Internal	Read-write	Display only dynamically learned services.
newname	Read-write	New name for the service. Must begin with an ASCII alphabetic or underscore (_) character, and must contain only ASCII alphanumeric, underscore, hash (#), period (.), space, colon (:), at (@), equals (=), and hyphen (-) characters. Minimum length = 1
numofconnections	Read-only	This will tell the number of client side connections are still open.
policyname	Read-only	The name of the policyname for which this service is bound.
serviceconftype	Read-only	The configuration type of the service.
serviceconftype2	Read-only	The configuration type of the service (Internal/Dynamic/Configured). Possible values = Configured, Dynamic, Internal
value	Read-only	SSL status. Possible values = Certkey not bound, SSL feature disabled
gslb	Read-only	The GSLB option for the corresponding virtual server. Possible values = REMOTE, LOCAL
dup_state	Read-only	Added this field for getting state value from table. Possible values = ENABLED, DISABLED
publicip	Read-only	public ip.
publicport	Read-only	public port. Minimum value = 1 Range 1 - 65535 * in CLI is represented as 65535 in NITRO API
svrstate	Read-only	The state of the service. Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
monitor_state	Read-only	The running state of the monitor on this service. Possible values = UP, DOWN, UNKNOWN, BUSY, OUT OF SERVICE, GOING OUT OF SERVICE, DOWN WHEN GOING OUT OF SERVICE, NS_EMPTY_STR, Unknown, DISABLED
monstatcode	Read-only	The code indicating the monitor response.
lastresponse	Read-only	The string form of monstatcode.
responsetime	Read-only	Response time of this monitor.
monstatparam1	Read-only	First parameter for use with message code.
monstatparam2	Read-only	Second parameter for use with message code.
monstatparam3	Read-only	Third parameter for use with message code.
statechangetimesec	Read-only	Time when last state change happened. Seconds part.
statechangetimemsec	Read-only	Time at which last state change happened. Milliseconds part.
tickssincelaststatechange	Read-only	Time in 10 millisecond ticks since the last state change.
stateupdatereason	Read-only	Checks state update reason on the secondary node.
clmonowner	Read-only	Tells the mon owner of the service. Minimum value = 0 Maximum value = 32
clmonview	Read-only	Tells the view id of the monitoring owner.
serviceipstr	Read-only	This field has been intorduced to show the dbs services ip.
oracleserverversion	Read-only	Oracle server version. Default value: 10G Possible values = 10G, 11G
nodefaultbindings	Read-only	to determine if the configuration will have default ssl CIPHER and ECC curve bindings. Default value: NO Possible values = YES, NO
monuserstatusmesg	Read-only	This field has been introduced to show user monitor failure reasons.
__count	Read-only	count parameter

Operations

(click to see Properties )

ADD
DELETE
UPDATE
UNSET
ENABLE
DISABLE
GET (ALL)
GET
COUNT
RENAME

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

add

URL: http:// <netscaler-ip-address> /nitro/v1/config/service

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"service":{
<b>      "name":<String_value>,
</b>      "ip":<String_value>,
      "servername":<String_value>,
<b>      "servicetype":<String_value>,
</b><b>      "port":<Integer_value>,
</b>      "cleartextport":<Integer_value>,
      "cachetype":<String_value>,
      "maxclient":<Double_value>,
      "healthmonitor":<String_value>,
      "maxreq":<Double_value>,
      "cacheable":<String_value>,
      "cip":<String_value>,
      "cipheader":<String_value>,
      "usip":<String_value>,
      "pathmonitor":<String_value>,
      "pathmonitorindv":<String_value>,
      "useproxyport":<String_value>,
      "sc":<String_value>,
      "sp":<String_value>,
      "rtspsessionidremap":<String_value>,
      "clttimeout":<Double_value>,
      "svrtimeout":<Double_value>,
      "customserverid":<String_value>,
      "serverid":<Double_value>,
      "cka":<String_value>,
      "tcpb":<String_value>,
      "cmp":<String_value>,
      "maxbandwidth":<Double_value>,
      "accessdown":<String_value>,
      "monthreshold":<Double_value>,
      "state":<String_value>,
      "downstateflush":<String_value>,
      "tcpprofilename":<String_value>,
      "httpprofilename":<String_value>,
      "contentinspectionprofilename":<String_value>,
      "hashid":<Double_value>,
      "comment":<String_value>,
      "appflowlog":<String_value>,
      "netprofile":<String_value>,
      "td":<Double_value>,
      "processlocal":<String_value>,
      "dnsprofilename":<String_value>,
      "monconnectionclose":<String_value>
}}

<!--NeedCopy-->

Response:

HTTP Status Code on Success: 201 Created

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

delete

URL: http:// <netscaler-ip-address> /nitro/v1/config/service/ name_value<String>

HTTP Method: DELETE

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

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

update

URL: http:// <netscaler-ip-address> /nitro/v1/config/service

HTTP Method: PUT

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"service":{
<b>      "name":<String_value>,
</b>      "ipaddress":<String_value>,
      "maxclient":<Double_value>,
      "maxreq":<Double_value>,
      "cacheable":<String_value>,
      "cip":<String_value>,
      "cipheader":<String_value>,
      "usip":<String_value>,
      "pathmonitor":<String_value>,
      "pathmonitorindv":<String_value>,
      "useproxyport":<String_value>,
      "sc":<String_value>,
      "sp":<String_value>,
      "rtspsessionidremap":<String_value>,
      "healthmonitor":<String_value>,
      "clttimeout":<Double_value>,
      "svrtimeout":<Double_value>,
      "customserverid":<String_value>,
      "serverid":<Double_value>,
      "cka":<String_value>,
      "tcpb":<String_value>,
      "cmp":<String_value>,
      "maxbandwidth":<Double_value>,
      "accessdown":<String_value>,
      "monthreshold":<Double_value>,
      "weight":<Double_value>,
      "monitor_name_svc":<String_value>,
      "downstateflush":<String_value>,
      "tcpprofilename":<String_value>,
      "httpprofilename":<String_value>,
      "contentinspectionprofilename":<String_value>,
      "hashid":<Double_value>,
      "comment":<String_value>,
      "appflowlog":<String_value>,
      "netprofile":<String_value>,
      "processlocal":<String_value>,
      "dnsprofilename":<String_value>,
      "monconnectionclose":<String_value>
}}

<!--NeedCopy-->

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

unset

URL: http:// <netscaler-ip-address> /nitro/v1/config/service? action=unset

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"service":{
<b>      "name":<String_value>,
</b>      "maxclient":true,
      "maxreq":true,
      "cacheable":true,
      "cip":true,
      "usip":true,
      "pathmonitor":true,
      "pathmonitorindv":true,
      "useproxyport":true,
      "sc":true,
      "sp":true,
      "rtspsessionidremap":true,
      "customserverid":true,
      "serverid":true,
      "cka":true,
      "tcpb":true,
      "cmp":true,
      "maxbandwidth":true,
      "accessdown":true,
      "monthreshold":true,
      "clttimeout":true,
      "svrtimeout":true,
      "tcpprofilename":true,
      "httpprofilename":true,
      "contentinspectionprofilename":true,
      "hashid":true,
      "appflowlog":true,
      "netprofile":true,
      "processlocal":true,
      "dnsprofilename":true,
      "monconnectionclose":true,
      "cipheader":true,
      "healthmonitor":true,
      "downstateflush":true,
      "comment":true
}}

<!--NeedCopy-->

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

enable

URL: http:// <netscaler-ip-address> /nitro/v1/config/service? action=enable

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"service":{
<b>      "name":<String_value>
</b>}}

<!--NeedCopy-->

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

disable

URL: http:// <netscaler-ip-address> /nitro/v1/config/service? action=disable

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"service":{
<b>      "name":<String_value>,
</b>      "delay":<Double_value>,
      "graceful":<String_value>
}}

<!--NeedCopy-->

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

rename

URL: http:// <netscaler-ip-address> /nitro/v1/config/service? action=rename

HTTP Method: POST

Request Headers:

Cookie:NITRO_AUTH_TOKEN= <tokenvalue>

Content-Type:application/json

Request Payload:

{"service":{
<b>      "name":<String_value>,
</b><b>      "newname":<String_value>
</b>}}

<!--NeedCopy-->

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

get (all)

URL: http:// <netscaler-ip-address> /nitro/v1/config/service

Query-parameters:

args

http:// <netscaler-ip-address> /nitro/v1/config/service? args=name: <String_value> ,all: <Boolean_value> ,Internal: <Boolean_value>

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

attrs

http:// <netscaler-ip-address> /nitro/v1/config/service? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

filter

http:// <netscaler-ip-address> /nitro/v1/config/service? filter=property-name1:property-val1,property-name2:property-val2

Use this query-parameter to get the filtered set of service resources configured on NetScaler.Filtering can be done on any of the properties of the resource.

view

http:// <netscaler-ip-address> /nitro/v1/config/service? view=summary

Use this query-parameter to get the summary output of service resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

pagination

http:// <netscaler-ip-address> /nitro/v1/config/service? pagesize=#no;pageno=#no

Use this query-parameter to get the service resources in chunks.

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:

{ "service": [ {
name:<String_value>,all:<Boolean_value>,Internal:<Boolean_value>      "numofconnections":<Integer_value>,
      "servername":<String_value>,
      "policyname":<String_value>,
      "servicetype":<String_value>,
      "serviceconftpye":<Boolean_value>,
      "serviceconftype":<Boolean_value>,
      "serviceconftype2":<String_value>,
      "port":<Integer_value>,
      "value":<String_value>,
      "cleartextport":<Integer_value>,
      "gslb":<String_value>,
      "cachetype":<String_value>,
      "maxclient":<Double_value>,
      "maxreq":<Double_value>,
      "cacheable":<String_value>,
      "cip":<String_value>,
      "cipheader":<String_value>,
      "usip":<String_value>,
      "pathmonitor":<String_value>,
      "pathmonitorindv":<String_value>,
      "useproxyport":<String_value>,
      "sc":<String_value>,
      "dup_state":<String_value>,
      "sp":<String_value>,
      "rtspsessionidremap":<String_value>,
      "clttimeout":<Double_value>,
      "svrtimeout":<Double_value>,
      "publicip":<String_value>,
      "publicport":<Integer_value>,
      "customserverid":<String_value>,
      "serverid":<Double_value>,
      "cka":<String_value>,
      "tcpb":<String_value>,
      "processlocal":<String_value>,
      "cmp":<String_value>,
      "maxbandwidth":<Double_value>,
      "accessdown":<String_value>,
      "svrstate":<String_value>,
      "delay":<Double_value>,
      "ipaddress":<String_value>,
      "monthreshold":<Double_value>,
      "monitor_state":<String_value>,
      "monstatcode":<Integer_value>,
      "lastresponse":<String_value>,
      "responsetime":<Double_value>,
      "monstatparam1":<Integer_value>,
      "monstatparam2":<Integer_value>,
      "monstatparam3":<Integer_value>,
      "downstateflush":<String_value>,
      "statechangetimesec":<String_value>,
      "statechangetimemsec":<Double_value>,
      "timesincelaststatechange":<Double_value>,
      "tickssincelaststatechange":<Double_value>,
      "stateupdatereason":<Double_value>,
      "clmonowner":<Double_value>,
      "clmonview":<Double_value>,
      "tcpprofilename":<String_value>,
      "httpprofilename":<String_value>,
      "contentinspectionprofilename":<String_value>,
      "hashid":<Double_value>,
      "graceful":<String_value>,
      "comment":<String_value>,
      "healthmonitor":<String_value>,
      "appflowlog":<String_value>,
      "netprofile":<String_value>,
      "serviceipstr":<String_value>,
      "weight":<Double_value>,
      "td":<Double_value>,
      "oracleserverversion":<String_value>,
      "dnsprofilename":<String_value>,
      "monconnectionclose":<String_value>,
      "nodefaultbindings":<String_value>,
      "monuserstatusmesg":<String_value>
}]}

<!--NeedCopy-->

get

URL: http:// <netscaler-ip-address> /nitro/v1/config/service/ name_value<String>

Query-parameters:

attrs

http:// <netscaler-ip-address> /nitro/v1/config/service/ name_value<String> ? attrs=property-name1,property-name2

Use this query parameter to specify the resource details that you want to retrieve.

view

http:// <netscaler-ip-address> /nitro/v1/config/service/ name_value<String> ? view=summary

Use this query-parameter to get the summary output of service resources configured on NetScaler.

Note: By default, the retrieved results are displayed in detail view (?view=detail).

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:

{  "service": [ {
name:<String_value>,all:<Boolean_value>,Internal:<Boolean_value>      "numofconnections":<Integer_value>,
      "servername":<String_value>,
      "policyname":<String_value>,
      "servicetype":<String_value>,
      "serviceconftpye":<Boolean_value>,
      "serviceconftype":<Boolean_value>,
      "serviceconftype2":<String_value>,
      "port":<Integer_value>,
      "value":<String_value>,
      "cleartextport":<Integer_value>,
      "gslb":<String_value>,
      "cachetype":<String_value>,
      "maxclient":<Double_value>,
      "maxreq":<Double_value>,
      "cacheable":<String_value>,
      "cip":<String_value>,
      "cipheader":<String_value>,
      "usip":<String_value>,
      "pathmonitor":<String_value>,
      "pathmonitorindv":<String_value>,
      "useproxyport":<String_value>,
      "sc":<String_value>,
      "dup_state":<String_value>,
      "sp":<String_value>,
      "rtspsessionidremap":<String_value>,
      "clttimeout":<Double_value>,
      "svrtimeout":<Double_value>,
      "publicip":<String_value>,
      "publicport":<Integer_value>,
      "customserverid":<String_value>,
      "serverid":<Double_value>,
      "cka":<String_value>,
      "tcpb":<String_value>,
      "processlocal":<String_value>,
      "cmp":<String_value>,
      "maxbandwidth":<Double_value>,
      "accessdown":<String_value>,
      "svrstate":<String_value>,
      "delay":<Double_value>,
      "ipaddress":<String_value>,
      "monthreshold":<Double_value>,
      "monitor_state":<String_value>,
      "monstatcode":<Integer_value>,
      "lastresponse":<String_value>,
      "responsetime":<Double_value>,
      "monstatparam1":<Integer_value>,
      "monstatparam2":<Integer_value>,
      "monstatparam3":<Integer_value>,
      "downstateflush":<String_value>,
      "statechangetimesec":<String_value>,
      "statechangetimemsec":<Double_value>,
      "timesincelaststatechange":<Double_value>,
      "tickssincelaststatechange":<Double_value>,
      "stateupdatereason":<Double_value>,
      "clmonowner":<Double_value>,
      "clmonview":<Double_value>,
      "tcpprofilename":<String_value>,
      "httpprofilename":<String_value>,
      "contentinspectionprofilename":<String_value>,
      "hashid":<Double_value>,
      "graceful":<String_value>,
      "comment":<String_value>,
      "healthmonitor":<String_value>,
      "appflowlog":<String_value>,
      "netprofile":<String_value>,
      "serviceipstr":<String_value>,
      "weight":<Double_value>,
      "td":<Double_value>,
      "oracleserverversion":<String_value>,
      "dnsprofilename":<String_value>,
      "monconnectionclose":<String_value>,
      "nodefaultbindings":<String_value>,
      "monuserstatusmesg":<String_value>
}]}

<!--NeedCopy-->

count

URL: http:// <netscaler-ip-address> /nitro/v1/config/service? count=yes

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:

{ "service": [ { "__count": "#no"} ] }

<!--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

service

August 17, 2023

Contributed by:

August 17, 2023

Contributed by:

service

Properties

Operations

add

delete

update

unset

enable

disable

rename

get (all)

get

count

In this article