---
title: Cover page
slug: ps/help/en_us/nsa/22x/nsa-ics/api/cover-page
docTags: 
createdAt: 2026-07-24T13:58:35.524Z
---

Neurons for Secure Access REST API Guide

PCS 22.8R1.9 Build 421

Default ESAP Version: ESAP 3.4.8

|   | [Revision History](docId\:k4k7U4f910RVFhi6d6wkN) |   |
| - | ------------------------------------------------ | - |

|   | [Ivanti Neurons for Secure Access Overview](docId\:Jf_CidO57_9f2_lHhTctk) |   |
| - | ------------------------------------------------------------------------- | - |

|   | [Retrieving the Authentication DSID](docId\:aMIYczoi3ikSGBLZTBp9g) |   |
| - | ------------------------------------------------------------------ | - |

|   | [Retrieving the DSID Using the API](docId\:aMIYczoi3ikSGBLZTBp9g) |   |
| - | ----------------------------------------------------------------- | - |

|   | [Retrieving the DSID Using a Browser](docId\:aMIYczoi3ikSGBLZTBp9g) |   |
| - | ------------------------------------------------------------------- | - |

|   | [Retrieving the nSA API Details using Browser](docId\:Y_cy14wHxI6xl6fohRd-H) |   |
| - | ---------------------------------------------------------------------------- | - |

|   | [Authentication Server (admin user)](docId:_HWWh186keBL4if8l6hOH) |   |
| - | ----------------------------------------------------------------- | - |

|   | [Retrieving All Authentication Servers](docId:_HWWh186keBL4if8l6hOH) |   |
| - | -------------------------------------------------------------------- | - |

|   | [Creating a Local Authentication Server](docId:_HWWh186keBL4if8l6hOH) |   |
| - | --------------------------------------------------------------------- | - |

|   | [Creating a SAML Authentication Server](docId:_HWWh186keBL4if8l6hOH) |   |
| - | -------------------------------------------------------------------- | - |

|   | [Gateways](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | --------------------------------------- | - |

|   | [Create Gateway on nSA UI](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | ------------------------------------------------------- | - |

|   | [Gateway Registration Code and FQDN](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | ----------------------------------------------------------------- | - |

|   | [Gateway Registration](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | --------------------------------------------------- | - |

|   | [Gateway Registration Status](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | ---------------------------------------------------------- | - |

|   | [All Gateways List](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | ------------------------------------------------ | - |

|   | [Getting Single Gateway Details based on Gateway ID](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | --------------------------------------------------------------------------------- | - |

|   | [Salient Tasks](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | -------------------------------------------- | - |

|   | [Gateway Upgrade from nSA](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | ------------------------------------------------------- | - |

|   | [Getting Available Upgrade Package Details](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | ------------------------------------------------------------------------ | - |

|   | [ICS Gateway Upgrade](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | -------------------------------------------------- | - |

|   | [Multinode Upgrade](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | ------------------------------------------------ | - |

|   | [ICS Cluster Upgrade](docId:3iYZqlxsb9GZykHo8i8A4) |   |
| - | -------------------------------------------------- | - |

|   | [Analytics and Dashboard](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ------------------------------------------------------- | - |

|   | [Ribbon Summary Counts](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ----------------------------------------------------- | - |

|   | [Gateway Map View](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ------------------------------------------------ | - |

|   | [Gateway User-specific Map View](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | -------------------------------------------------------------- | - |

|   | [Plotting Sankey Chart](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ----------------------------------------------------- | - |

|   | [Top Active Gateways](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | --------------------------------------------------- | - |

|   | [Top Device Types](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ------------------------------------------------ | - |

|   | [Top User Locations](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | -------------------------------------------------- | - |

|   | [Active Session Duration](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ------------------------------------------------------- | - |

|   | [Connected Clients Active Users](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | -------------------------------------------------------------- | - |

|   | [Connected Clients All Users](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ----------------------------------------------------------- | - |

|   | [Top Non Compliances](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | --------------------------------------------------- | - |

|   | [Pre-Auth Non Compliances](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | -------------------------------------------------------- | - |

|   | [Gateway Info Panel](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | -------------------------------------------------- | - |

|   | [Active Users Info Panel](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ------------------------------------------------------- | - |

|   | [Devices Info Panel](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | -------------------------------------------------- | - |

|   | [Active Sessions Info Panel](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ---------------------------------------------------------- | - |

|   | [Active Applications Info Panel](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | -------------------------------------------------------------- | - |

|   | [Non Compliances Info Panel](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ---------------------------------------------------------- | - |

|   | [Auth Failure Info Panel](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ------------------------------------------------------- | - |

|   | [Anomalies Info Panel](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ---------------------------------------------------- | - |

|   | [Summary Strip with Gateway Filter](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ----------------------------------------------------------------- | - |

|   | [Search Logs](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ------------------------------------------- | - |

|   | [Top Busy Users](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ---------------------------------------------- | - |

|   | [Applications by Type](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ---------------------------------------------------- | - |

|   | [Top Gateways by Health](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ------------------------------------------------------ | - |

|   | [Policy Failures Trend](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ----------------------------------------------------- | - |

|   | [Audit Logs](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ------------------------------------------ | - |

|   | [Report Templates](docId\:dCX-ZAO3c17nzg2a9C-B7) |   |
| - | ------------------------------------------------ | - |

|   | [Licensing and Subscriptions](docId\:z3uyUJdFym4o70mXoA2uI) |   |
| - | ----------------------------------------------------------- | - |

|   | [Subscriptions](docId\:z3uyUJdFym4o70mXoA2uI) |   |
| - | --------------------------------------------- | - |

|   | [Delete Users from nSA Named Users Table](docId\:z3uyUJdFym4o70mXoA2uI) |   |
| - | ----------------------------------------------------------------------- | - |

|   | [User Details](docId\:z3uyUJdFym4o70mXoA2uI) |   |
| - | -------------------------------------------- | - |

|   | [License Consumption Count](docId\:z3uyUJdFym4o70mXoA2uI) |   |
| - | --------------------------------------------------------- | - |

|   | [Search String](docId\:z3uyUJdFym4o70mXoA2uI) |   |
| - | --------------------------------------------- | - |

|   | [Advanced Filter](docId\:z3uyUJdFym4o70mXoA2uI) |   |
| - | ----------------------------------------------- | - |

|   | [Admin Login-related APIs](docId\:HfWn5YGv3EMnObq4gWntH) |   |
| - | -------------------------------------------------------- | - |

|   | [User Rule Groups](docId\:HfWn5YGv3EMnObq4gWntH) |   |
| - | ------------------------------------------------ | - |

|   | [nSA Roles](docId\:HfWn5YGv3EMnObq4gWntH) |   |
| - | ----------------------------------------- | - |

|   | [Install ESAP](docId\:HfWn5YGv3EMnObq4gWntH) |   |
| - | -------------------------------------------- | - |

|   | [Trusted Server](docId\:mvJCd5qdRuJ9IFj2ethQC) |   |
| - | ---------------------------------------------- | - |

:::Paragraph{indent="1"}
Ivanti
2700 Zanker Road,
Suite 200 San Jose
CA 95134
:::

:::Paragraph{indent="1"}
[https://www.ivanti.com/
](http://www.pulsesecure.net)
© 2026 by Ivanti. All rights reserved.
:::

:::Paragraph{indent="1"}
Ivanti and the Ivanti logo are trademarks of Ivanti in the United States.
All other trademarks, service marks, registered trademarks, or registered service marks are the
property of their respective owners.
:::

:::Paragraph{indent="1"}
Ivanti assumes no responsibility for any inaccuracies in this document. Ivanti
reserves the right to change, modify, transfer, or otherwise revise this publication without
notice.
:::

:::Paragraph{indent="1"}
Neurons for Secure Access REST API Guide

The information in this document is current as of the date on the title page.
:::

:::Paragraph{indent="1"}
**END USER LICENSE AGREEMENT**

The Ivanti product that is the subject of this technical documentation consists of (or is
intended for use with) Ivanti software. Use of such software is subject to the terms and
conditions of the End User License Agreement (“EULA”) posted at
[http://www.pulsesecure.net/support/eula/](http://www.pulsesecure.net/support/eula/). By downloading, installing or using such software,
you agree to the terms and conditions of that EULA.
:::
