About Secure Private Access on-premises REST API

Last published : Oct 31, 2026
The Secure Private Access REST API can be used to directly configure multiple applications and policies. This API facilitates the automation of the following tasks:
  • Manage applications.
  • Manage application routing.
  • Manage access policies.

Prerequisites to use the Secure Private Access on-premises API

  • An account associated with a domain, and an appropriately configured domain controller.
  • The Secure Private Access on-premises admin service address.
  • An admin account with Full Administrator role if POST, PUT, DELETE operations are performed.
  • An admin account with Read-Only Administrator role if only GET operations are performed.

Disclaimer

  • The administrator is responsible for the sanity of the configuration.
    • There is no check for non-logical configuration (for example, contradicting rules in a policy)
    • There is no check for the validity of the overall configuration (for example, adding two or more policies with the same priority)
  • There is no help/wizard/autocomplete to create the configuration. The configuration syntax (access rules/conditions/actions) must be created earlier. HTTP get can be leveraged on the existing configuration.