Routing Domains: Hybrid REST API mode differences

This page outlines how to handle routing domains using the Secure Private Access Hybrid REST APIs, highlighting only the differences from the standard API.

Key Differences for Routing Domains in hybrid mode

When using the Hybrid REST API mode for routing domain operations:

  • The type parameter must not be set to any of the following values:
    • external_via_connector
    • conflicting
    • internal_bypass_proxy
    • Any request including these values will be rejected.
  • The locationIds parameter is optional in hybrid mode (unlike the cloud API, where it is mandatory).
    • However, omitting locationIds will still result in a 400 Bad Request error, maintaining compatibility with the cloud API’s response behavior.

Example: Extract Routing Domains (hybrid mode)

Request:

GET https://{hybridHostUrl}/accesssecurity/routingDomains
Accept: application/json
Authorization: Bearer {token}
Citrix-CustomerId: {customerId}
...
<!--NeedCopy-->

Response:

  • The response structure and object schema remain the same as the standard API, except for the above differences in allowed values and parameter requirements.

Migration tip

When migrating from the standard or cloud API:

  • Ensure you do not use the restricted type values.
  • Include locationIds in your requests to avoid 400 errors, even though it is not mandatory in hybrid mode.

Reference

For full usage details, request/response handling, and examples, see the main Routing Domains API documentation.
This page lists only the differences and requirements for Hybrid REST API mode.

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