Skip to content

|

Developer Docs Citrix Application Delivery Management 13.0 NITRO API Reference

Initializing search

Citrix Application Delivery Management 13.0 NITRO API Reference

Versions
Versions
- 12.1
Home
configuration
configuration
- configuration
- Analytics
  Analytics
  - 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
    
    Common-Resources
    
    db_cache
    
    diagnostics_details
    
    ica_session_timeout
    
    insight_threshold
    
    log_datarecord
    
    multihop_feature
    
    tcp_insight_feature
    
    threshold
    
    threshold_breach_count
    
    threshold_breach_timeline
    
    threshold_expression
    
    threshold_group_list
    
    threshold_key_list
    
    threshold_metric_list
    
    threshold_resource_list
  - 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_geoclient
    
    af_geolocation
    
    af_url_collection
    
    api_auth
    
    api_endpoint
    
    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_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_frontend
    
    ssl_key_strength
    
    ssl_protocol
    
    ssl_vpn_license
    
    uri
    
    useragent_attr
    
    user_agent
    
    Web-Insight
    
    web_detail_data_collection_config
    
    web_insight_feature
    
    web_summary
- Applications
  Applications
- Configuration-Audit
  Configuration-Audit
- Configuration-Jobs
  Configuration-Jobs
- Device-SSL-Certificates
  Device-SSL-Certificates
- Events
  Events
- Instances
  Instances
  - autoscalegroup_profile_map
  - Instances
  - Citrix-ADC
    Citrix-ADC
    
    adc_params
    
    adc_update_appflow_info
    
    adc_vserver_appflow_config
    
    adc_vserver_appflow_info
    
    autoscalegroup
    
    autoscalegroup_config
    
    autoscalegroup_upgrade
    
    autoscale_activity_status
    
    blx_device_profile
    
    Citrix-ADC
    
    ns
    
    ns_appflow_param_config
    
    ns_application
    
    ns_callhome_poll_policy
    
    ns_cluster
    
    ns_clusternode
    
    ns_cluster_nodegroup
    
    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_sslprofile
    
    ns_summary
    
    ns_syslog_config
    
    ns_syslog_task
    
    ns_upgrade
    
    ns_version
    
    ns_visualizer_csvserver
    
    ns_visualizer_cs_bindings
    
    ns_visualizer_gslbdomain
    
    ns_visualizer_gslb_bindings
    
    ns_visualizer_lbvserver
    
    ns_visualizer_lb_bindings
    
    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
    
    cbwanopt
    
    cbwanopt_appflowconfig
    
    cbwanopt_currentconfig
    
    cbwanopt_device_profile
    
    cbwanopt_image
    
    cbwanopt_snmp_config
    
    cbwanopt_summary
    
    cbwanopt_upgrade
    
    Citrix-SD-WAN-WO
  - Common-Resources
    Common-Resources
    
    Common-Resources
    
    devicewise_detail_summary
    
    device_generic_resrc
    
    device_group
    
    device_info
    
    device_license_info
    
    device_profile
    
    device_registration
    
    device_summary
    
    host_device
    
    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
    
    haproxyconfig
    
    haproxyhost
    
    haproxy_device_profile
    
    haproxy_summary
    
    managed_tp_vserver
    
    tp_loadbalancer
    
    user_managed_tp_vserver
- Licenses
  Licenses
- Network-Functions
  Network-Functions
  - Network-Functions
  - Authentication
    Authentication
    
    Authentication
    
    ns_authenticationvserver
  - Cache-Redirection
    Cache-Redirection
    
    Cache-Redirection
    
    ns_crvserver
  - Citrix-Gateway
    Citrix-Gateway
    
    Citrix-Gateway
    
    ns_vpnvserver
    
    user_managed_vserver
  - Common-Resources
    Common-Resources
    
    Common-Resources
    
    lb_export_report
    
    network_function_config
    
    network_function_param
    
    ns_sslvserver
    
    visualizer_conf_file
  - Content-Switching
    Content-Switching
    
    Content-Switching
    
    ns_csvserver
    
    ns_csvserver_lbvserver_binding
  - 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
  - Load-Balancing
    Load-Balancing
    
    Load-Balancing
    
    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
- Network-Reporting
  Network-Reporting
- 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
  - graph
  - jobs
  - schema
  - Stylebooks
- System
  System
  - System
  - website_scanning_config
  - Agent
    Agent
    
    Agent
    
    agent_cert_upload
    
    mas_agent_image
    
    mps_agent
    
    mps_datacenter
    
    trust_preauthtoken
  - Authentication
    Authentication
    
    aaa_server
    
    Authentication
    
    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
    
    aa_adc_prediction_l2
    
    activity_status
    
    app_component
    
    capacity
    
    CommonResources
    
    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
    
    autoselection_preference
    
    LicensingandAnalytics
    
    managed_app
    
    managed_vserver
    
    mas_license
    
    mas_service_license
  - NetworkConfiguration
    NetworkConfiguration
    
    adm_ports_info
    
    current_hostname
    
    dns_domain_entry
    
    mps_mgmt_network_config
    
    mps_network_config
    
    NetworkConfiguration
    
    ntp_param
    
    ntp_server
    
    ntp_sync
    
    proxy_server
    
    static_route
  - Notification
    Notification
    
    mail_attachment
    
    mail_profile
    
    Notification
    
    notification_digest_settings
    
    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
    
    cipher_config
    
    cipher_group
    
    cipher_suite
    
    mps_ssl_certkey
    
    SSLSettings
    
    ssl_cert
    
    ssl_key
    
    ssl_settings
  - Syslog
    Syslog
    
    audit_log
    
    Syslog
    
    syslog_facility
    
    syslog_messages
    
    syslog_params
    
    syslog_persistant_stat_info
    
    syslog_server
  - SystemMaintenance
    SystemMaintenance
    
    adm_upgrade
    
    feature_migration_status
    
    mps_image
    
    mps_upgrade
    
    remote_backup
    
    remote_backup_config
    
    SystemMaintenance
  - SystemSettings
    SystemSettings
    
    cc_profile
    
    current_timezone
    
    mps_feature
    
    mps_fingerprint
    
    report_timezone
    
    response_header_settings
    
    SystemSettings
    
    system_settings
    
    timezone_enum
  - Tenants
    Tenants
    
    tenant
    
    Tenants
    
    tenant_auth_server
    
    tenant_company_info
    
    tenant_info
    
    tenant_network_pool
    
    tenant_provisioning_status
    
    tenant_system_info
    
    tenant_system_resource
  - 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
    
    UserAdministration
    
    user_lockout_policy
error-messages
error-messages
- error-messages

Was this article helpful?

Provide Feedback

GSLB¶

ns_gslbservice
ns_gslbservicegroup
ns_gslbservicegroupmember_binding
ns_gslbvserver
ns_gslbvserver_domain

Was this article helpful?

Provide Feedback

Previous ns_csvserver_lbvserver_binding

Next ns_gslbservice

Privacy and legal terms | Cookie preferences

© 1999-2021 Citrix Systems, Inc. All rights reserved.