Skip to content
|
Developer Docs
Citrix Application Delivery Management NITRO API Reference
Initializing search
Citrix Application Delivery Management NITRO API Reference
Citrix ADM 13.1 NITRO API Reference
Configuration
Configuration
Configuration
Analytics
Analytics
Aa dplite transaction
Analytics
Common resources
Common resources
Account takeover config
Adm learn profile
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
App devices info
Appsec profile config
Common resources
Db cache
Diagnostics details
Ica session timeout
Insight threshold
Log datarecord
Model settings info
Multihop feature
Ns app config group
Nssslvserver aplus commands
Nssslvserver rating
Nssslvserver rating details
Nssslvserver rating job mapping
Nssslvserver revert commands
Ssl aplus config
Tcp insight feature
Threshold
Threshold breach count
Threshold breach timeline
Threshold expression
Threshold group list
Threshold key list
Threshold metric list
Threshold resource list
Website scanning config
Gateway insight
Gateway insight
Gateway insight
Vpn active sessions
Vpn app info
Vpn error counts
Vpn error details
Vpn error details timeline
Vpn error reports
Vpn gateway info
Vpn info
Vpn user
Vpn user info
Hdx insight
Hdx insight
Active ica session
Hdx insight
Hdx desktop
Hdx desktop session
Hdx desktop session inactive
Hdx desktop timeline
Ica app
Ica app active
Ica app timeline
Ica channel
Ica client user agent
Ica device
Ica device active
Ica device session hop detail
Ica device skip flow
Ica device skip flow details
Ica edt
Ica l7 latency update
Ica license
Ica server session hop detail
Ica session
Ica session hop detail
Ica session inactive
Ica user
Ica user session hop detail
Ica user timeline
Inactive ica session
Related desktop session
Related ica session
Session hop distribution
Security insight
Security insight
Dns details
Security insight
Security insight feature
Security violation types
Si app summary
Si app unit
Si attack category
Si device
Si geo location
Si ip reputation
Si log expression
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
Waf profile devices
Waf security settings
Tcp insight
Tcp insight
Tcp insight
Tcp bitrate
Tcp direction
Tcp direction stacked
Tcp interface
Tcp interface stacked
Tcp port
Tcp port stacked
Tcp side
Video insight
Video insight
Video insight
Video bandwidth
Video datavolume
Video plays
Video playtime
Video session
Video txn
Wan insight
Wan insight
Cb application
Cb branch
Cb client
Wan insight
Web insight
Web insight
Af generic api
Af geoclient
Af geolocation
Af url collection
Api auth
Api endpoint
Api endpoint discovery
Api endpoint perf dashboard bytes
Api endpoint perf dashboard request
Api endpoint perf dashboard response
Api endpoint rate limit dashboard
Api endpoint security dashboard
Api geolocation
Api http resp status
Api instance
Api instance dashboard
Api instance discovery
Api instance perf dashboard
Api instance security dashboard
Api most access endpoint
Api rate limit
Api rate limit dashboard
Api ssl certificate
Api ssl cipher
Api ssl failure backend
Api ssl failure frontend
Api ssl key strength
Api ssl protocol
App unit
App unit backend
App unit mapping
Client
Device
Domain
Domain mapping
Http header
Http req method
Http resp status
Operating system
Server
Ssl certificate
Ssl cipher
Ssl cipher negotiated
Ssl failure
Ssl failure backend
Ssl failure backend cipher mismatch
Ssl failure backend cipher unsupported
Ssl failure frontend
Ssl failure frontend cipher mismatch
Ssl failure frontend cipher unsupported
Ssl key strength
Ssl protocol
Ssl vpn license
Uri
User agent
Useragent attr
Web insight
Web detail data collection config
Web insight feature
Web summary
Applications
Applications
Aa ind details l2
Adc application summary
Anomaly details
Anomaly events
Anomaly summary
App category
App device
App info
App service graph node edges
App template info
Application
Applications
Appscore factor
Appscore threshold config
Authorized application
Global service graph config mapping
Global service graph node edges
Job trigger
Security app dashboard details
Swg domain summary
Swg ssl details
Swg trans details
Swg user details
Swg user summary
Configuration audit
Configuration audit
Config advice
Config advice file
Config advice result
Configuration audit
Ns conf
Ns conf download policy
Ns conf revision history
Ns conf upgrade history
Ns config audit settings
Ns config diff
Ns configtemplate
Ns configtemplate scheduler
Ns filediff
Ns filediff settings
Configuration jobs
Configuration jobs
Config command
Config job
Config job details
Config template temp
Config variable
Configuration jobs
Configuration template
Device values map
Job execution profile
Maintenance job
Variable values
Device ssl certificates
Device ssl certificates
Cert store
Cert store data
Certificate authority management
Certificate policy
Device ssl certificates
Ns ssl cert
Ns ssl certkey
Ns ssl certkey policy
Ns ssl certlink
Ns ssl csr
Ns ssl files
Ns ssl key
Ns sslcertkey binding
Ssl cert threshold
Events
Events
Active event
Command execution profile
Device event summary
Event
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
Eventhistory
Eventrule config command
Eventrule config variable
Eventrule configuration template
Eventrule variable values
Events
Fault category
Fault failure object
Fault severity
Filter action
Filter action props
Filter criteria
Filter schedule details
Filter scheduler
Ns event
Ns event archive
Ns event message
Ns event summary
Poll activity status
Syslog filter
Syslog generic
Syslog severity
Trap settings
Vwan event
Instances
Instances
Instances
Upgrade advisory settings
Citrix ADC
Citrix ADC
Citrix ADC
Adc disk space
Adc disk space details
Adc params
Adc update appflow info
Adc vserver appflow config
Adc vserver appflow info
Autoscale activity status
Autoscalegroup
Autoscalegroup config
Autoscalegroup profile map
Autoscalegroup upgrade
Blx device profile
Ns
Ns appflow param config
Ns application
Ns callhome poll policy
Ns cluster
Ns cluster nodegroup
Ns clusternode
Ns command
Ns config replicate
Ns device profile
Ns emon poll policy
Ns filterpolicy template
Ns hapair template
Ns image
Ns interface
Ns l7 latency config
Ns mpxcluster template
Ns network interface
Ns ns appflowcollector
Ns ns appflowparam
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 snmp config
Ns sslcipher binding
Ns sslparameter
Ns sslprofile
Ns sslprofile cipher binding
Ns sslvserver cipher binding
Ns summary
Ns syslog config
Ns syslog task
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
Ns visualizer network bindings
Ns vm image
Ns vserver appflow config
Ns vserver info
Citrix ADC SDX
Citrix ADC SDX
Citrix ADC SDX
Nssdx
Nssdx device profile
Sdx
Sdx image
Sdx snmp config
Sdx summary
Sdx syslog config
Sdx syslog template
Sdx upgrade
Citrix SD WAN SE EE
Citrix SD WAN SE EE
Citrix SD WAN SE EE
Sdwanvw
Sdwanvw device profile
Sdwanvw summary
Citrix SD WAN WO
Citrix SD WAN WO
Citrix SD WAN WO
Cbwanopt
Cbwanopt appflowconfig
Cbwanopt currentconfig
Cbwanopt device profile
Cbwanopt image
Cbwanopt snmp config
Cbwanopt summary
Cbwanopt upgrade
Common resources
Common resources
Common resources
Device generic resrc
Device group
Device info
Device license info
Device profile
Device registration
Device summary
Devicewise detail summary
Host device
Image
Instance score
Instance score notification
Instance score settings
Instance score threshold
Inventory
Inventory status
Managed device
Managed device summary
Ping
Traceroute
Vm device
Haproxy
Haproxy
Haproxy
Haproxy device profile
Haproxy summary
Haproxyconfig
Haproxyhost
Managed tp vserver
Tp loadbalancer
User managed tp vserver
Licenses
Licenses
Adc feature usage
Device usage
License config
License expiry info
License file
License info
License server info
License threshold
License usage hour
License usage month
License user detail
Licenses
Network functions
Network functions
Network functions
Cache Redirection
Cache Redirection
CacheRedirection
Ns crvserver
Citrix Gateway
Citrix Gateway
CitrixGateway
Ns vpnvserver
User managed vserver
Common Resources
Common Resources
CommonResources
Lb export report
Network function config
Network function param
Ns sslvserver
Visualizer conf file
Content Switching
Content Switching
ContentSwitching
Ns csvserver
Ns csvserver lbvserver binding
Load Balancing
Load Balancing
LoadBalancing
Ns csvserver policy binding
Ns lbvserver
Ns lbvserver policy binding
Ns lbvserver service binding
Ns server
Ns service
Ns servicegroup
Ns servicegroupmember binding
Ns services
Ns vpnvserver policy binding
Ns vserver
Ns waf learning group
Ns waf relaxation
Authentication
Authentication
Authentication
Ns authenticationvserver
Gslb
Gslb
Gslb
Ns gslbservice
Ns gslbservicegroup
Ns gslbservicegroupmember binding
Ns gslbvserver
Ns gslbvserver domain
Haproxy
Haproxy
Haproxy
Haproxy backend
Haproxy frontend
Haproxy frontend backend mapping
Haproxy frontend stats
Haproxy server
Network reporting
Network reporting
Af waf relaxation rules
Cbwanopt poll data
Haproxy poll data
Network reporting
Perf aaa report
Perf agg config
Perf authentication report
Perf cache redirection report
Perf capacity utilization 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 service report
Perf lb servicegroup report
Perf lb ssl traffic report
Perf lb vserver report
Perf network interface report
Perf ns throughput report
Perf poll config
Perf purge setting
Perf report counters
Perf report instances
Perf reports
Perf res util report
Perf sdx res util report
Perf sdx throughput 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 pass through connection report
Perf wsserviceclassstatstable service class report
Orchestration
Orchestration
Orchestration
Admin
Admin
Admin
Allocationgroup
Clouduser
Devicegroup
Devicegroup devices
Devicegroup platforms
Groupmember
Images
Lbdevice
Licenses
Management networks
Partitionspec
Platformspecs
Profiles
Provision setting
Resource
Sdxvmspec
Server boundaries
Servicepackage
Spec
Tenantgroup
Tenantgroup tenants
Common
Common
Common
Journalcontext
Journalcontextscope
Journaltask
Openstack
Openstack
Image
Member
Network
Openstack
Placementpolicy
Pool
Tenant
Vip
Vipdiameter
Vipsessionpersistence
Stylebooks
Stylebooks
Allconfigpacks
Configpacks
Stylebooks
System
System
Adc script
Adc script output file
Adc script stats
Af waf deploy rules l2
Built in agent
Cli prompt
Device techsupport
System
Agent
Agent
Agent
Agent cert upload
Agent resource threshold
Mas agent image
Mps agent
Mps datacenter
Trust preauthtoken
Authentication
Authentication
Authentication
Aaa server
External server
Ldap server
Login
Logout
Radius server
Tacacs server
Backup
Backup
Backup
Backup component
Backup external storage
Backup file
Backup policy
Device backup
Device backup policy
Restore
CommonResources
CommonResources
CommonResources
Aa adc prediction l2
Activity status
Adm deployment
App component
Capacity
Counter info
Counter item
Csv export
Entity map
Export report
Export report job
Ha info
Ip block
Jazz license
Mas health
Mas summary
Mps
Mps disk usage
Mps geolocation country
Mps geolocation region
Mps health
Mps user heatmap
Property map
Public ip block lookup
Redis ha update
Server connection
Server info
Server nodes
Service
System threshold
Trigger detail
DataPruning
DataPruning
DataPruning
Module purge setting
Prune policy
Syslog purge setting
Syslog purge setting details
Diagnostics
Diagnostics
Diagnostics
Task command log
Task device log
Task log
Techsupport
LicensingandAnalytics
LicensingandAnalytics
LicensingandAnalytics
Autoselection preference
Managed app
Managed vserver
Mas license
Mas service license
NetworkConfiguration
NetworkConfiguration
NetworkConfiguration
Adm ports info
Current hostname
Dns domain entry
Mps mgmt network config
Mps network config
Ntp param
Ntp server
Ntp sync
Proxy server
Static route
Notification
Notification
Notification
Mail attachment
Mail profile
Notification digest settings
Notify service
Pagerduty profile
Sent mails
Sent sms
Servicenow profile
Servicenow tickets
Slack profile
Sms profile
Sms server
Smtp server
Test mail
SNMP
SNMP
SNMP
Snmp alarm config
Snmp info
Snmp manager
Snmp mib
Snmp trap
Snmp user
Snmp view
Trap forward profile
SSLSettings
SSLSettings
SSLSettings
Cipher config
Cipher group
Cipher suite
Mps ssl certkey
Ssl cert
Ssl key
Ssl settings
Syslog
Syslog
Syslog
Audit log
Syslog facility
Syslog messages
Syslog params
Syslog persistant stat info
Syslog server
SystemMaintenance
SystemMaintenance
SystemMaintenance
Adm upgrade
Feature migration status
Mps image
Mps upgrade
Remote backup
Remote backup config
SystemSettings
SystemSettings
SystemSettings
Cc profile
Current timezone
Mps feature
Mps fingerprint
Report timezone
Response header settings
System settings
Timezone enum
Tenants
Tenants
Tenants
Tenant
Tenant auth server
Tenant company info
Tenant info
Tenant network pool
Tenant provisioning status
Tenant system info
Tenant system resource
UserAdministration
UserAdministration
UserAdministration
Authorized scope
Mpsgroup
Mpssession
Mpsuser
Password policy
Rba authscope props
Rba childmodule client data
Rba client data
Rba module client data
Rba operation client data
Rba policy
Rba role
Rba statement
Rba submodule client data
Rba ui
User lockout policy
Error messages
Error messages
Error messages
Was this article helpful?
Provide Feedback
WAN-Insight
¶
cb_application
cb_branch
cb_client
Was this article helpful?
Provide Feedback