Returns optimization details for a specific Entitlement, including a suggested operation and suggested action removals based on usage data. Requires the Optimizer licensed feature.
ID of the object.
Optimization details for the Entitlement.
Optimization details and suggestions for an Entitlement based on usage data.
ID of the object.
Name of the object.
Notes for the object. Used for documentation purposes.
Create date.
Last update date.
Whether the entity is protected from manual updates and deletes.
Array of tags.
The type of the Entitlement.
If true, the Entitlement will be disregarded during authorization.
ID of the Site for this Entitlement.
Name of the Site for this Entitlement. For convenience only.
Whether all the Conditions must succeed to have access to this Entitlement or just one.
List of Condition IDs applied to this Entitlement.
Indicates how optimized this Entitlement is based on usage data. Actions or hosts/ports/types/methods marked as optimizationExempt are excluded from this calculation. Licensed feature.
Numeric percentage score representing how optimized this Entitlement is based on usage data. Licensed feature.
List of all IP Access actions in this Entitlement.
IP Access action.
Type of the IP Access action. Required unless the action is exclude.
Applied action to the traffic.
Hosts to apply the action to. See admin manual for possible values.
Destination port. Multiple ports can be entered comma separated. Port ranges can be entered dash separated. Only valid for tcp, udp, ssh, and rdp subtypes
ICMP type. Only valid for icmp subtypes.
HTTP method. Only valid for http subtypes. Leave it empty to allow all types.
Only available for tcp_up and http_up subtypes. If enabled, Gateways will monitor this action for responsiveness and act accordingly. See admin manual for more details.
Number of seconds the action needs to be unresponsive to mark the action unhealthy.
Hosts exempt from Entitlement Optimization analysis. Traffic to these hosts will not be considered when calculating the optimization score for this action. Uses the same format as hosts.
Destination ports exempt from Entitlement Optimization analysis. Traffic on these ports will not be considered when calculating the optimization score for this action. Only valid for tcp, udp, ssh, and rdp subtypes. Uses the same format as ports.
ICMP types exempt from Entitlement Optimization analysis. Traffic of these types will not be considered when calculating the optimization score for this action. Only valid for icmp subtypes. Uses the same format as types.
HTTP methods exempt from Entitlement Optimization analysis. Traffic using these methods will not be considered when calculating the optimization score for this action. Only valid for http subtypes.
Array of App Shortcuts.
Publishes the configured URL as an app on the client using the display name as the app name.
Name for the App Shortcut which will be visible on the Client UI.
Description for the App Shortcut which will be visible on the Client UI.
The URL that will be triggered on the OS to be handled. For example, an HTTPS URL will start the browser for the given URL.
The color code of the shortcut on the client.
- 1: Light Green
- 2: Green
- 3: Indigo
- 4: Deep Purple
- 5: Yellow
- 6: Lime
- 7: Light Blue
- 8: Blue
- 9: Amber
- 10: Orange
- 11: Cyan
- 12: Teal
- 13: Deep Orange
- 14: Red
- 15: Gray
- 16: Brown
- 17: Pink
- 18: Purple
- 19: Blue Gray
- 20: Near Black
The group name this shortcut is to be grouped by
List of Entitlement Script IDs used for creating App Shortcuts dynamically.
Suggested optimization operation for the Entitlement.
List of optimization actions with suggested removals based on usage analysis.
An IP access action with optimization analysis results for its hosts and ports/types.
Applied action to the traffic.
Type of the IP Access action. Required unless the action is exclude.
Hosts with their optimization analysis results.
A single value (host, port, or type) with its optimization analysis metadata.
The host, port, or type value.
Optimization range classification for this value.
Whether this value is exempt from optimization analysis.
Whether this value is suggested to be removed based on usage analysis.
Whether this value could not be analyzed (unsupported host, or a port in an action with an unsupported host).
Ports or ICMP types with their optimization analysis results.
A single value (host, port, or type) with its optimization analysis metadata.
The host, port, or type value.
Optimization range classification for this value.
Whether this value is exempt from optimization analysis.
Whether this value is suggested to be removed based on usage analysis.
Whether this value could not be analyzed (unsupported host, or a port in an action with an unsupported host).
IDs of policies linked to this Entitlement.
Overall usage classification across all actions in this Entitlement.
Whether broad IP ranges were detected across actions in this Entitlement.
Recommended number of days of usage data to consider for optimization.
Number of days remaining until the optimization recommendation expires.
Token error. Login again.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Insufficient license.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Insufficient permissions to access this resource.
Generic HTTP error.
Machine readable error code.
Human readable error details.
The requested resource can not be found.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Invalid 'Accept' header.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Precondition failed. ZTP is not registered or Optimizer is not enabled.
Generic HTTP error.
Machine readable error code.
Human readable error details.
Unexpected server side error.
Generic HTTP error.
Machine readable error code.
Human readable error details.