Skip to content
Developer Docs
Citrix Application Delivery Management 13.0 NITRO API Reference
Type to start searching
Citrix Application Delivery Management 13.0 NITRO API Reference
Versions
Versions
12.1
Home
Configuration
Configuration
Configuration
Analytics
Analytics
Analytics
Common Resources
Common Resources
Common Resources
adaptive_threshold_feature
adaptive_threshold
advanced_analytics_config
af_config_info
af_cpx_support
af_database_cleanup
af_database_duration
af_database_index
af_persistant_stat_info
af_vserver_policy
anomaly_item
db_cache
ica_session_timeout
insight_threshold
log_datarecord
multihop_feature
si_log_expression
sla_collection_enable
tcp_insight_feature
threshold_breach_count
threshold_breach_timeline
threshold_config_timeline
threshold_expression
threshold_group_list
threshold_key_list
threshold_metric_list
threshold_resource_list
threshold
Gateway Insight
Gateway Insight
Gateway Insight
vpn_active_sessions
vpn_app_info
vpn_error_counts
vpn_error_details_timeline
vpn_error_details
vpn_error_reports
vpn_gateway_info
vpn_info
vpn_user_info
vpn_user
HDX Insight
HDX Insight
HDX Insight
active_ica_session
hdx_desktop_session_inactive
hdx_desktop_session
hdx_desktop_timeline
hdx_desktop
ica_app_active
ica_app_timeline
ica_app
ica_channel
ica_client_user_agent
ica_device_active
ica_device_session_hop_detail
ica_device_skip_flow_details
ica_device_skip_flow
ica_device
ica_l7_latency_update
ica_license
ica_server_session_hop_detail
ica_session_hop_detail
ica_session_inactive
ica_session
ica_user_session_hop_detail
ica_user_timeline
ica_user
inactive_ica_session
related_desktop_session
related_ica_session
session_hop_distribution
Security Insight
Security Insight
Security Insight
security_insight_feature
security_violation_types
security-insight
si_app_summary
si_app_unit
si_attack_category
si_device
si_geo_location
si_ip_reputation
si_safety_app_firewall
si_safety_overview
si_safety_security_check
si_safety_signature
si_safety_system_security
si_security_overview
si_security_violation
si_sig_violation
si_tcp_counter
si_violation_action
si_violation_severity
TCP Insight
TCP Insight
TCP Insight
tcp_bitrate
tcp_direction_stacked
tcp_direction
tcp_interface_stacked
tcp_interface
tcp_port_stacked
tcp_port
tcp_side
Video Insight
Video Insight
Video Insight
video_bandwidth
video_datavolume
video_plays
video_playtime
video_session
video_txn
video-insight
WAN Insight
WAN Insight
WAN Insight
cb_application
cb_branch
cb_client
Web Insight
Web Insight
Web Insight
af_attribute_description
af_geoclient
af_geolocation
af_report_description
af_url_collection
app_unit_mapping
app_unit
client
device
domain_mapping
domain
http_content_type
http_header
http_media_type
http_req_method
http_resp_status
ic_no_store_reason
operating_system
server
sla_doi
sla_mcb
sla_sub_doi
ssl_certificate
ssl_cipher_negotiated
ssl_cipher
ssl_failure_backend
ssl_failure_frontend
ssl_failure
ssl_key_strength
ssl_protocol
ssl_vpn_license
uri_dom
uri
url_parameter
user_agent
web_detail_data_collection_config
web_insight_feature
Applications
Applications
Applications
app_category
app_device
app_info
app_summary
app_template_info
application
appscore_threshold_config
security_app_dashboard_details
swg_domain_summary
swg_ssl_details
swg_trans_details
swg_user_details
swg_user_summary
Configuration Audit
Configuration Audit
Configuration Audit
config_advice_file
config_advice_result
config_advice
config_audit_notification
ns_conf
ns_config_audit_settings
Configuration Jobs
Configuration Jobs
Configuration Jobs
config_command
config_job_details
config_job
config_variable
configuration_template
job_execution_profile
maintenance_job
variable_values
Device SSL Certificates
Device SSL Certificates
Device SSL Certificates
ns_ssl_cert
ns_ssl_csr
ns_ssl_key
ssl_cert_threshold
Events
Events
Events
active_event
device_event_summary
event_category
event_cb_device_report
event_cbsdx_device_report
event_cbsdx_resrc_threshold_violation_report
event_config_changes_report
event_device_report
event_device_summary
event_entity_state_changes_report
event_filter
event_hardware_failure_report
event_login_failure_report
event_ns_device_report
event_nssdx_device_report
event_nssdx_resrc_threshold_violation_report
event_persistant_stat_info
event_purge_setting
event_resrc_threshold_violation_report
event_severity_report
event_summary
event
eventhistory
eventrule_config_command
eventrule_config_variable
eventrule_configuration_template
eventrule_variable_values
fault_severity
ns_event_message
ns_event_summary
ns_event
poll_activity_status
syslog_filter
syslog_generic
syslog_severity
trap_settings
vwan_event
Instances
Instances
Instances
Common Resources
Common Resources
Common Resources
device_generic_resrc
device_group
device_info
device_license_info
device_profile
device_summary
device_usage
device_version_update
devicewise_detail_summary
host_device
managed_device_summary
managed_device
network_interface
ns_vm_image
ping
traceroute
vm_device
Docker Host
Docker Host
Docker Host
docker_host
docker_nscpx_image
kubernetes_param
marathon_param
triton_config
HAProxy
HAProxy
HAProxy
haproxy_device_profile
haproxyconfig
haproxyhost
managed_tp_vserver
tp_loadbalancer
user_managed_tp_vserver
NetScaler ADC
NetScaler ADC
NetScaler ADC
ns_aaasession
ns_appflow_param_config
ns_appflow_policies_diagnostic
ns_application
ns_callhome_poll_policy
ns_clag_interface
ns_clag_node
ns_cluster_nodegroup
ns_cluster
ns_clusternode
ns_command
ns_conf_download_policy
ns_conf_revision_history
ns_conf_upgrade_history
ns_config_diff
ns_config_replicate
ns_configtemplate_scheduler
ns_configtemplate
ns_detail_vlan
ns_device_profile
ns_emon_poll_policy
ns_filterpolicy_template
ns_hapair_template
ns_image
ns_insight_diagnostic
ns_interface
ns_l7_latency_config
ns_mpxcluster_template
ns_network_interface
ns_nonlbvserver_diagnostic
ns_ns_appflowparam
ns_ns_ip
ns_ns_ipv6
ns_ns_license
ns_ns_mode
ns_ns_rollbackcmd
ns_ns_runningconfig
ns_ns_savedconfig
ns_ns_timeout
ns_partition
ns_poll_data
ns_pre_upgrade
ns_save_config
ns_service_diagnostic
ns_servicegroup_diagnostic
ns_sla_appflow_action
ns_sla_bind
ns_sla_config
ns_snmp_config
ns_ssl_certkey_policy
ns_ssl_certkey
ns_ssl_certlink
ns_sslprofile
ns_summary
ns_syslog_config
ns_syslog_task
ns_system_param
ns_upgrade
ns_version
ns_visualizer_cs_bindings
ns_visualizer_csvserver
ns_visualizer_gslb_bindings
ns_visualizer_gslbdomain
ns_visualizer_lb_bindings
ns_visualizer_lbvserver
ns_visualizer_network_bindings
ns_visualizer_network
ns_vlan
ns_vmacs_free_count
ns_vmacs
ns_vpnicaconnection
ns_vserver_appflow_config
ns_vserver_info
ns_vserver_license
ns
NetScaler SD-WAN SE-EE
NetScaler SD-WAN SE-EE
NetScaler SD-WAN SE-EE
enable_ipv6_traffic
sdwanvw_appflowconfig
sdwanvw_device_profile
sdwanvw_image
sdwanvw_summary
sdwanvw_upgrade
sdwanvw
NetScaler SD-WAN WO
NetScaler SD-WAN WO
NetScaler SD-WAN WO
cbwanopt_appflowconfig
cbwanopt_currentconfig
cbwanopt_device_profile
cbwanopt_image
cbwanopt_snmp_config
cbwanopt_summary
cbwanopt_upgrade
cbwanopt
NetScaler SDX
NetScaler SDX
NetScaler SDX
nssdx_device_profile
nssdx
sdx_image
sdx_snmp_config
sdx_summary
sdx_syslog_config
sdx_syslog_template
sdx_upgrade
sdx
Licenses
Licenses
Licenses
license_expiry_info
license_file
license_info
license_proxy_server
license_server_info
license_server_pool
license_server
license_threshold
license_user_detail
sdx_license
Network Functions
Network Functions
Network Functions
Authentication
Authentication
Authentication
ns_authenticationvserver
Cache Redirection
Cache Redirection
Cache Redirection
ns_crvserver
Common Resources
Common Resources
Common Resources
lb_export_report
network_function_config
network_function_param
networking_param
ns_sslvserver
Content Switching
Content Switching
Content Switching
ns_csvserver_lbvserver_binding
ns_csvserver
GSLB
GSLB
GSLB
ns_gslb_service_cert
ns_gslb_service
ns_gslbservice
ns_gslbvserver_domain
ns_gslbvserver
HAProxy
HAProxy
HAProxy
haproxy_backend
haproxy_frontend_backend_mapping
haproxy_frontend_stats
haproxy_frontend
haproxy_server
Load Balancing
Load Balancing
Load Balancing
ns_lbvserver_service_binding
ns_lbvserver
ns_server
ns_service
ns_servicegroup
ns_servicegroupmember_binding
NetScaler Gateway
NetScaler Gateway
NetScaler Gateway
ns_vpnvserver
user_managed_vserver
Network Reporting
Network Reporting
Network Reporting
cbwanopt_poll_data
haproxy_poll_data
perf_authentication_report
perf_cache_redirection_report
perf_cmp_bytes_rxtx_report
perf_cmp_decmp_bytes_rxtx_report
perf_cmp_decmp_ratiosaving_report
perf_cmp_tcp_bytes_rxtx_report
perf_cmp_tcp_ratiosaving_report
perf_content_switching_report
perf_custom_dashboard
perf_device_counters
perf_global_server_load_balancing_report
perf_http_bytes_rx_report
perf_http_gets_posts_report
perf_http_req_tcp_conn_report
perf_icmp_bytes_rxtx_report
perf_icmp_pkt_rxtx_report
perf_icmpv6_bytes_rxtx_report
perf_icmpv6_pkt_rxtx_report
perf_ip_bytes_rxtx_report
perf_ip_pkt_rxtx_report
perf_ipv6_bytes_rxtx_report
perf_ipv6_pkt_rxtx_report
perf_lb_ssl_traffic_report
perf_lb_vserver_report
perf_network_interface_report
perf_ns_throughput_report
perf_persistant_stat_info
perf_poll_config
perf_purge_setting
perf_report_counters
perf_report_instances
perf_reports
perf_res_util_report
perf_ssl_backend_ciphers_report
perf_ssl_be_rsa_dhkey_report
perf_ssl_client_auth_report
perf_ssl_cpu_keyexchange_report
perf_ssl_frontend_ciphers_report
perf_ssl_rsa_dhkey_report
perf_ssl_transactions_hits_report
perf_ssl_vpn_report
perf_tcp_server_conn_report
perf_tcp_surgelen_spareconn_report
perf_threshold
perf_udp_bytes_rxtx_report
perf_udp_packets_rxtx_report
perf_wsappstatstable_application_report
perf_wsdevice_connected_plugins_report
perf_wsdevice_cpu_utilization_report
perf_wsdevice_data_reduction_report
perf_wsdevice_link_utilization_report
perf_wsdevice_send_compression_ratio_report
perf_wslinkstatstable_packet_loss_report
perf_wslinkstatstable_throughput_report
perf_wsqosstatstable_qos_report
perf_wsserviceclassstatstable_acceleration_report
perf_wsserviceclassstatstable_service_class_report
Orchestration
Orchestration
Orchestration
Admin
Admin
Admin
allocationgroup
clouduser
devicegroup_devices
devicegroup_platforms
devicegroup
groupmember
images
lbdevice
licenses
management_networks
partitionspec
platformspecs
profiles
provision_setting
resource
sdxvmspec
server_boundaries
servicepackage
spec
tenantgroup_tenants
tenantgroup
Common
Common
Common
journalcontext
journalcontextscope
journaltask
Openstack
Openstack
Openstack
image
member
network
placementpolicy
pool
tenant
vip
vipdiameter
vipsessionpersistence
Stylebooks
Stylebooks
Stylebooks
allconfigpacks
configpacks
graph
jobs
schema
System
System
System
aaa_server
activity_status
audit_log
authorized_application
authorized_scope_app
authorized_scope
autoselection_preference
backup_component
backup_external_storage
backup_file
backup_policy
backup
capacity
cas_config
cc_profile
cipher_config
cipher_group
cipher_suite
command_execution_profile
counter_info
counter_item
criteria
csv_export
current_hostname
current_timezone
device_backup_policy
device_backup
device_registration
device_values_map
dns_domain_entry
dns_param
entity_map
export_report_job
export_report
external_server
failure_obj
fault_category
fault_failure_object
filter_action_props
filter_action
filter_criteria
filter_schedule_details
filter_scheduler
geodb_file
inventory_status
inventory
ip_block
ipm_user_info
jazz_license
keystone_server
ldap_server
login
logout
mail_attachment
mail_profile
managed_app
managed_vserver
mas_agent_image
mas_health
mas_license
mas_service_license
mas_summary
metering_data
metering_export
metering_summary
mps_agent
mps_datacenter
mps_disk_usage
mps_geolocation_country
mps_geolocation_region
mps_health
mps_image
mps_network_config
mps_ssl_certkey
mps_upgrade
mps_user_heatmap
mps
mpsgroup
mpssession
mpsuser
notification_digest_settings
ntp_param
ntp_server
ntp_sync
password_policy
poll_lock_check
property_map
prune_policy
radius_server
rba_authscope_props
rba_childmodule_client_data
rba_client_data
rba_module_client_data
rba_operation_client_data
rba_policy
rba_resourcegroup_props
rba_resourcegroup
rba_role
rba_statement
rba_submodule_client_data
rba_ui
redis_ha_update
remote_backup_config
remote_backup
report_timezone
response_header_settings
restore
sdx_backup_restore
sdx_network_config
sdxtools_image
sdxtools_upgrade
sent_mails
sent_sms
server_connection
server_info
server_nodes
service
sms_profile
sms_server
smtp_server
snmp_alarm_config
snmp_info
snmp_manager
snmp_mib
snmp_parameters
snmp_trap
snmp_user
snmp_varbind
snmp_view
ssl_cert
ssl_key
ssl_settings
static_route
syslog_facility
syslog_messages
syslog_params
syslog_persistant_stat_info
syslog_purge_setting_details
syslog_purge_setting
syslog_server
system_settings
system_threshold
tacacs_server
task_command_log
task_device_log
task_log
techsupport
tenant_auth_server
tenant_company_info
tenant_info
tenant_network_pool
tenant_system_info
tenant_system_resource
tenant
timezone_enum
trap_forward_profile
trigger_detail
trust_preauthtoken
user_lockout_policy
Tools
Tools
Tools
ace_conf_file
ace_context_conf_file
ace_result_file
ace_to_ns
f5_conf_file
f5_result_file
f5_to_ns
pe_to_pi_comparison
pe_to_pi_conf_file
pe_to_pi_result_file
pe_to_pi
visualizer_conf_file
Error Messages
Questions?
WAN Insight
¶
cb_application
cb_branch
cb_client