HomeGuidesAPI Reference
API Reference

Create or Update Zscaler Subscription

Creates or updates the Zscaler subscription configuration. For new subscriptions, all fields including password are required. For updates, password is optional (existing password retained if not provided). On success, verifies Zscaler connectivity, downloads location data, and clears connection failure alarms.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Zscaler subscription configuration. Password required for new subscriptions, optional for updates.

Zscaler subscription configuration containing cloud connection and authentication details.

string
required

Zscaler cloud endpoint hostname for API communication.

string
required

Zscaler partner admin email address used for API authentication.

password

Zscaler partner admin password. Required on initial setup; optional for updates. Always returned empty in GET responses for security.

string
required

Zscaler third-party partner key provided by Zscaler for SilverPeak/Aruba integration.

string
required

Corporate domain used for VPN credential generation and location identification.

string | null

Zscaler subcloud identifier for surcharge data centers. Optional; if invalid, it will be cleared automatically.

boolean
Defaults to false

Enables Zscaler Digital Experience (ZDX) monitoring integration. When true, zdxCloud is required.

string | null

ZDX cloud endpoint hostname. Required when enableZDX is true.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json