Applications Configuration: Hybrid REST API mode differences

This page describes how to use the Secure Private Access Hybrid REST APIs to list, create, update, and delete applications, highlighting only the differences for Hybrid mode compared to the standard API.

Key Differences for applications in hybrid mode

When using the Hybrid REST API mode for application management:

  • The following parameters are not supported in requests or responses:
    • policies
    • agentlessAccess
    • customerDomainFields
    • locations
    • mobileSecurity
    • sbsOnlyLaunch
    • sso
    • templateName
    • usingTemplate
  • If you include these parameters, they will be ignored or omitted in responses.
  • All other application object fields, endpoints, and behaviors remain consistent with the standard API.

Example: Create an application (hybrid mode)

Request

POST https://{hybridHostUrl}/accessSecurity/applications
Content-Type: application/json; charset=utf-8
Accept: application/json
Authorization: Bearer {token}
...
<!--NeedCopy-->

Request body sample for Hybrid Mode:

{
  "name": "Test",
  "type": "web",
  "description": "Test Description",
  "category": "Test Category",
  "url": "https://sample.com",
  "hidden": false,
  "destination": [],
  "policyCount": "Test Count",
  "createdTime": {},
  "relatedURLs": ["www.test.com"],
  "icon": "SXQgY2Fubm90IGJlIWdodGVyLgo=",
  "iconURL": "iconurl.com"
}
<!--NeedCopy-->

Note:
Omit any fields listed above as not supported in Hybrid mode.

Response example:

{
  "state": "incomplete",
  "name": "Test",
  "type": "web",
  "description": "Test Description",
  "category": "Test Category",
  "url": "https://sample.com",
  "hidden": false,
  "destination": [],
  "policyCount": null,
  "createdTime": "2023-01-18T14:43:17Z",
  "relatedURLs": ["www.test.com"],
  "icon": "iVBORw0KGg5CYII=",
  "iconURL": "iconurl.com",
  "id": "b20788e2-cdf0-490e-adac-5b100271ad3d"
}
<!--NeedCopy-->

Migration tip

If you are migrating automation or scripts from the standard API to Hybrid REST API mode, ensure you remove all unsupported fields from your application payloads for create and update actions.

Reference

For all other usage details, standard request/response handling, and additional examples, refer to the main Apps configuration using Secure Private Access API.

This document lists only the differences and requirements for Hybrid REST API mode.

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