Applications API: Hybrid REST API mode differences

This document outlines only the differences and important notes when using Secure Private Access Applications APIs in Hybrid REST API mode.

Not applicable parameters in hybrid mode

The following parameters are not applicable and are optional in the hybrid environment and should not be used in request bodies or relied upon in responses for Applications APIs:

  • policies
  • agentlessAccess
  • customerDomainFields
  • locations
  • mobileSecurity
  • sbsOnlyLaunch
  • sso
  • templateName
  • usingTemplate

If present, these fields will be ignored or omitted in hybrid mode.

Request and response schema

  • Applications object schemas and API behaviors are otherwise identical to the standard API, except that the above fields are not supported in the hybrid environment.
  • Ensure your API client does not send or expect these parameters when interacting with the hybrid endpoint.

Endpoint and authentication

  • Use the hybrid API base URL and credentials as provided for your hybrid deployment.
  • Header and error-handling requirements remain the same as in the standard API.

Migration note

If you are migrating from the on-premises or cloud API to hybrid mode, update your integrations to remove the unsupported parameters listed above from all create, update, and query operations on Applications APIs.

Reference

For all other details and request/response examples, refer to the main Applications API documentation. This document lists only the differences relevant to Hybrid REST API mode.

Resources
Citrix Secure Private Access Hybrid REST API Differences OpenAPI Specification
Copy Download
Applications API: Hybrid REST API mode differences