The Zscaler Private Access (ZPA) API gives you programmatic access to manage the following ZPA features:

• Alternative Cloud Domains

  Alternative cloud domain API resources allow you to read alternative cloud domains. To learn more, see:

  • Reference Guide > Zscaler Path Cloud Controller
  • Obtaining Alternative Cloud Domain Details Using API

  Close
• Application Segments

  Application segment API resources allow you to create, read, update, and delete application segments. To learn more, see:

  • Reference Guide > Application Segment Management
  • Configuring Application Segments Using API
  • Configuring Browser Access Application Segments Using API
  • Managing Application Load Balancing and High Availability Using API
  • AppProtection Support
  • Microtenant Support
  • About Applications

  Close
• Segment Groups

  Segment group API resources allow you to create, read, update, and delete segment groups. To learn more, see:

  • Reference Guide > Segment Group Controller
  • Configuring Segment Groups Using API
  • About Segment Groups

  Close
• App Connectors

  App Connector API resources allow you to read, update, and delete App Connectors. To learn more, see:

  • Reference Guide > App Connector Controller
  • Managing App Connectors Using API
  • Configuring Auto Delete for Disconnected App Connectors
  • About App Connectors

  Close
• App Connector Groups

  App Connector Group API resources allow you to create, read, update, and delete App Connector Groups. To learn more, see:

  • Reference Guide > App Connector Group Controller
  • Configuring App Connector Groups Using API
  • About App Connector Groups

  Close
• Certificates

  Certificate API resources allow you to create, read, update, and delete certificates. To learn more, see:

  • Reference Guide > Certificate Controller
  • Configuring Certificates Using API
  • About Certificates

  Close
• Cloud Connector Groups

  Cloud Connector Group API resources allow you to read Cloud Connector Groups. To learn more, see:

  • Reference Guide > Cloud Connector Group Controller
  • Obtaining Cloud Connector Group Details Using API
  • About Cloud Connector Groups

  Close
• Customers

  Customer API resources allow you to read authentication domains for a customer. To learn more, see:

  • Reference Guide > Customer Controller
  • Obtaining Customer Details Using API

  Close
• Emergency Access

  Emergency access API resources allow you to create, read, update, and delete emergency access users. To learn more, see:

  • Reference Guide > Emergency Access Controller
  • Configuring Emergency Access Users Using API
  • About Emergency Access Users

  Close
• Enrollment Certificates

  Enrollment certificate API resources allow you to read enrollment certificates. To learn more, see:

  • Reference Guide > Enrollment Cert Controller
  • Configuring Enrollment Certificate Details Using API
  • About Enrollment (CA) Certificates

  Close
• IdP Configurations

  IdP configuration API resources allow you to read IdP configurations. To learn more, see:

  • Reference Guide > IdP Controller
  • Configuring IdP Configuration Details Using API
  • About IdP Configuration

  Close
• Isolation Profiles

  Isolation Profiles API resources allow you to read isolation profiles. To learn more, see:

  • Reference Guide > Isolation Profile Controller
  • Obtaining Isolation Profile Details Using API

  Close
• Access Policies

  Policy Set Controller API resources allow you to create, read, update, and delete access policies. To learn more, see:

  • Reference Guide > Policy Set Controller
  • Configuring Access Policies Using API
  • About Access Policy

  Close
• Client Forwarding Policies

  Policy Set Controller API resources allow you to create, read, update, and delete client forwarding policies. To learn more, see:

  • Reference Guide > Policy Set Controller
  • Configuring Client Forwarding Policies Using API
  • About Client Forwarding Policy

  Close
• Timeout Policies

  Policy Set Controller API resources allow you to create, read, update, and delete timeout policies. To learn more, see:

  • Reference Guide > Policy Set Controller
  • Configuring Timeout Policies Using API
  • About Timeout Policy

  Close
• AppProtection Policies

  Policy Set Controller API resources allow you to create, read, update, and delete AppProtection (formerly Inspection) policies. To learn more, see:

  • Reference Guide > Policy Set Controller
  • Configuring AppProtection Policies Using API
  • About AppProtection Policy

  Close
• Isolation Policies

  Policy Set Controller API resources allow you to create, read, update, and delete isolation policies. To learn more, see:

  • Reference Guide > Policy Set Controller
  • Configuring Isolation Policies Using API
  • About Isolation Policy

  Close
• Privileged Policies

  Policy Set Controller API resources allow you to create, read, update, and delete privileged credential policies. To learn more, see:

  • Reference Guide > Policy Set Controller
  • Configuring Privileged Policies Using API
  • About Privileged Credentials Policy
  • About Privileged Capabilities Policy

  Close
• Redirection Policies

  Policy Set Controller API resources allow you to create, read, update, and delete redirection policies. To learn more, see:

  • Reference Guide > Policy Set Controller
  • Configuring Redirection Policies Using API
  • About Redirection Policy

  Close
• Log Streaming Service (LSS) Configurations

  LSS configuration API resources allow you to create, read, update, and delete LSS configurations. To learn more, see:

  • Reference Guide > Log Streaming Service (LSS) Configuration
  • Managing Log Streaming Service Configurations Using API
  • About the Log Streaming Service

  Close
• Machine Groups

  Machine Group API resources allow you to read Machine Groups. To learn more, see:

  • Reference Guide > Machine Group Controller
  • Obtaining Machine Group Details Using API
  • About Machine Groups

  Close
• Microtenants

  Microtenant API resources allow you to create, read, update, and delete Microtenants. To learn more, see:

  • Reference Guide > Microtenant Controller
  • Configuring Microtenants Using API
  • About Microtenants

  Close
• Posture Profiles

  Posture profile API resources allow you to read posture profiles. To learn more, see:

  • Reference Guide > Posture Profile Controller
  • Obtaining Posture Profile Details Using API
  • Configuring Device Posture Profiles

  Close
• Privileged Approvals

  Privileged approval API resources allow you to create, read, update, and delete privileged approvals. To learn more, see:

  • Reference Guide > Privileged Approval Controller
  • Configuring Privileged Approvals Using API
  • About Privileged Approvals

  Close
• Privileged Consoles

  Privileged console API resources allow you to create, read, update, and delete privileged consoles. To learn more, see:

  • Reference Guide > Privileged Console Controller
  • Configuring Privileged Consoles Using API
  • About Privileged Consoles

  Close
• Privileged Credentials

  Privileged credential API resources allow you to create, read, update, and delete privileged credentials. To learn more, see:

  • Reference Guide > Privileged Credential Controller
  • Configuring Privileged Credentials Using API
  • About Privileged Credentials

  Close
• Privileged Portals

  Privileged portal API resources allow you to create, read, update, and delete privileged portals. To learn more, see:

  • Reference Guide > Privileged Portal Controller
  • Configuring Privileged Portals Using API
  • About Privileged Portals

  Close
• Provisioning Keys

  Provisioning key API resources allow you to create, read, update, and delete provisioning keys. To learn more, see:

  • Reference Guide > Provisioning Key Controller
  • Configuring Provisioning Keys Using API
  • About App Connector Provisioning Keys
  • About ZPA Private Service Edge Provisioning Keys

  Close
• SAML Attributes

  SAML attribute API resources allow you to read SAML attributes. To learn more, see:

  • Reference Guide > SAML Attribute Controller
  • Configuring SAML Attribute Details Using API
  • About SAML Attributes

  Close
• SCIM Attributes

  SCIM attribute API resources allow you to read SCIM attributes. To learn more, see:

  • Reference Guide > SCIM Attribute Header Controller
  • Obtaining SCIM Attribute Details Using API
  • About SCIM

  Close
• SCIM Groups

  SCIM Group API resources allow you to read SCIM Groups.

  • Reference Guide > SCIM Group Controller
  • Obtaining SCIM Group Details Using API
  • About SCIM Groups

  Close
• Servers

  Server API resources allow you to create, read, update, and delete servers. To learn more, see:

  • Reference Guide > Server Controller
  • Configuring Servers Using API
  • About Servers

  Close
• Server Groups

  Server group API resources allow you to create, read, update, and delete server groups. To learn more, see:

  • Reference Guide > Server Group Controller
  • Configuring Server Groups Using API
  • About Server Groups

  Close
• Service Edges

  ZPA Private Service Edge API resources allow you to read, update, and delete ZPA Private Service Edges. To learn more, see:

  • Reference Guide > Private Service Edge Controller
  • Managing Private Service Edges Using API
  • About ZPA Private Service Edges

  Close
• Service Edge Groups

  ZPA Private Service Edge Group API resources allow you to create, read, update, and delete ZPA Private Service Edge Groups. To learn more, see:

  • Reference Guide > Private Service Edge Group Controller
  • Configuring ZPA Private Service Edge Groups Using API
  • About ZPA Private Service Edge Groups

  Close
• Trusted Networks

  Trusted network API resources allow you to read trusted networks. To learn more, see:

  • Reference Guide > Trusted Network Controller
  • Obtaining Trusted Network Details Using API
  • Configuring Trusted Networks for Zscaler Client Connector

  Close
• Version Profiles

  Version profile API resources allow you to read version profiles. To learn more, see:

  • Reference Guide > Customer Version Profile Controller
  • Obtaining Version Profile Details Using API
  • Configuring a Version Profile

  Close

Zscaler can make periodic updates to the query and response parameters used by the ZPA API.

Prior to using the API, Zscaler recommends reviewing Getting Started for information regarding prerequisites, authentication, and making API calls.

For detailed information on all available API calls, endpoints, and parameters, see the ZPA API Reference. For information on rate limits, see Understanding Rate Limiting. To learn more about HTTP status codes, see API Response Codes and Error Messages. If you encounter any issues with the ZPA API, contact Zscaler Support.