Requirements

Access Requirements for Neurons Platform APIs

REST API commands can be executed from any machine that has access to your Ivanti Neurons tenant.

The following are required to use the Ivanti Neurons for API:

  • Ivanti Neurons license key for each module (For example: Patch Management, People and Devices, Neurons Bots etc.)
  • Access to Ivanti Neurons tenant (For example: Patch Management, People and Devices, Neurons Bots etc.)
  • A Rapid API subscription
    For access to the Ivanti Neurons API, you must create a Rapid API account and connect your Rapid API application to a particular landscape. The landscape selected should match the landscape of your Ivanti Neurons tenant.

Security Requirements

The Neurons API uses JWT authentication. Every request needs to be authenticated via the Authorization header using the Bearer scheme. The authentication endpoint should be used to retrieve the access token. See Patch Management, People and Devices, and Neurons Bots for detain on authentication endpoints. By default, the JWT scope provided is read only. All GET endpoints provided in the Neurons API are authorized against this read-only role. Any HTTP endpoints that are not GET have an elevated scope or role assigned, so check the endpoint reference to verify the required scopes needed for each action.