Citrix Secure Private Access Hybrid REST API Differences
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
typeparameter must not be set to any of the following values:external_via_connectorconflictinginternal_bypass_proxy- Any request including these values will be rejected.
- The
locationIdsparameter is optional in hybrid mode (unlike the cloud API, where it is mandatory).- However, omitting
locationIdswill still result in a400 Bad Requesterror, maintaining compatibility with the cloud API’s response behavior.
- However, omitting
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
typevalues. - Include
locationIdsin 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.
Routing Domains: Hybrid REST API mode differences
Copied!
Failed!