Routing Domains API: Hybrid REST API mode differences

This document outlines the differences and important notes for using Secure Private Access Routing Domains APIs in Hybrid REST API mode.

Not applicable or restricted values in hybrid mode

  • type parameter:
    • The following values are not allowed for the type parameter in hybrid mode:
      • external_via_connector
      • conflicting
      • internal_bypass_proxy
    • Requests using these values will be rejected.
  • locationIds parameter:
    • In hybrid mode, locationIds is optional (not mandatory as in cloud).
    • However, if locationIds is omitted, the API will still return a 400 Bad Request response, matching the cloud API behavior.

Schema and endpoint notes

  • All other request/response schemas and error handling remain unchanged from the standard API, except for the above differences.
  • Use the hybrid API base URL and credentials provided for your hybrid deployment.

Migration note

If migrating to hybrid mode:

  • Do not use the restricted type values listed above.
  • locationIds is optional, but omitting it will result in a 400 Bad Request error, so it is recommended to include it for compatibility.

Reference

For complete details and examples, refer to the main Routing Domains API documentation. This document highlights only the differences for Hybrid REST API mode.

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