API Calls

This chapter describes the Ivanti Neurons for Zero Trust Access (nZTA) entities and the API calls that can be made to them.

• Analytics, see Analytics.
• Applications, see Applications (resources).
• Authentication Servers, see Authentication Server (auth-servers).
• Device Policies, see Device Policies (device-policy/groups).
• Device Policy Rules, see Device Policy Rules (device-policy/rules).
• Gateways, see Gateway (gateways).
• Gateway Settings, see Gateway Settings.
• Gateway Groups, see Gateway Group (groups).
• Hostchecker Levels, see Hostchecker Levels (hostchecker/levels).
• Hostchecker Products, see Hostchecker Products (hostchecker/products).
• Resources, see "Applications" and "User Policies".
• Resource Groups, see Resource Group (resource-groups).
• Role Mapping Rules, see Role Mapping Rules (role-mapping-rules).
• Secure Access Policies, see Secure Access Policy (secure-access-policies).
• Enterprise Integrations Syslog Server Configuration, see Enterprise Integrations Configurations Service (integrations/syslog).
• Users, see Users (users).
• User Rule Groups, see User Rule Groups (user-rule-groups).
• User Policies, see User Policies (resources).
• Lockdown exceptions, see Lockdown Exceptions
• MDM Server, see MDM Server

For all calls, the following CURL command format uses the DSID cookie to query the REST API server:

curl -v --cookie "DSID=<value>" <api_request_url>

Analytics

The analytics resource provides API calls for components and elements within the Insights analytics pages of the Tenant Admin Portal. Analytics supports the following Network Overview activities:

•Retrieving data for the Summary Ribbon, see Retrieving Analytics Data for the Summary Ribbon.

•Retrieving data for the World Map Gateway Locations view, see Retrieving Analytics Data for the World Map Gateway Location View.

•Retrieving data for the World Map Users view, see Retrieving Analytics Data for the World Map Users View.

•Retrieving data for the Sankey chart view, see Retrieving Analytics Data for the Sankey Chart View.

•Retrieving data for the Top Active Gateways chart, see Retrieving Analytics Data for the Top Active Gateways Chart.

•Retrieving data for the Top Active Applications chart, see Retrieving Analytics Data for the Top Active Applications Chart.

•Retrieving data for the Top Active User Locations chart, see Retrieving Analytics Data for the Top Active User Locations Chart.

•Retrieving data for the Active Anomalies chart, see Retrieving Analytics Data for the Active Anomalies Chart.

•Retrieving data for the Connected Clients Version chart, see Retrieving Analytics Data for the Connected Clients Version Chart.

•Retrieving data for the Non-compliances chart, see Retrieving Analytics Data for the Non-compliances Chart.

•Retrieving data for the Gateways Info-panel, see Retrieving Analytics Data for the Gateways Info-panel.

•Retrieving data for the Users Info-panel, see Retrieving Analytics Data for the Users Info-panel.

•Retrieving data for the Devices Info-panel, see Retrieving Analytics Data for the Devices Info-panel.

•Retrieving data for the Applications Info-panel, see Retrieving Analytics Data for the Applications Info-panel.

•Retrieving data for the Non-compliances Info-panel, see Retrieving Analytics Data for the Non-compliances Info-panel.

•Retrieving data for the Anomalies Info-panel, see Retrieving Analytics Data for the Anomalies Info-panel.

The analytics resource also provides the following Logs activity:

•Retrieving log data, see Retrieving Log Data.

The analytics resource also provides the following Gateways activity:

•Retrieving Gateway metrics, see Retrieving Aggregated Gateway Statistics.

Retrieving Analytics Data for the Summary Ribbon

To retrieve a resource containing Summary Ribbon totals, use the REST API call below:

• Method: POST /api/analytics/summary
• Resource: Path
• JSON Data: JSON data structure representing the CommonFilterObject schema (see Schema) - containing date/time period selection, and optional filter for gateway selection.

Schema

The CommonFilterObject schema entity contains the following fields:

current_time	integer example: 1580515200 The time at which landing page was loaded. This is used to make sure that all the components on landing page have the same reference so that they summarize the same data set.
start_time	integer example: 1580515200 Start time (epoch). This needs to be the starting time for the selected time_duration_type below. Selecting current day will result in displaying data from start of the current day (in UTC) e.g., - Selecting day for time_duration_type indicates this value should be start of the calendar day (in UTC) * Selecting week for time_duration_type indicates this value should be start of the calendar week (in UTC) * Selecting month for time_duration_type indicates this value should be start of the calender month (in UTC) * When time_duration_type is active, the start_time will be ignored. Only (current_time) and (current_time - Active Window Period) will be considered as time duration
time_duration_type	string example: day default: active Details of what unit of time duration need to be considered for the data. Enum: [ active, current_day, day, week, month, last_24_hours, custom ]
timezone_offset	integer example: 330
gateway_type	string nullable: true example: pcs default: zta Type of the gateway Enum: [ zta, pcs, pps, vtm ]
overlay_filter_type	string example: non_compliance_users Dashboard overlay text filter type Enum: [ connected_users_in_last_one_hour, non_compliance_users, connected_users_in_more_than_one_day, users_from_most_busy_gateway, users_from_least_busy_gateway, top_risky_users, geo_anomaly_users, user_roles_with_most_non_compliances, top_users_with_auth_failures, users_with_mfa ]
global_filter	{ description: Global filter object that is applicable for all pages. If both overlay_filter_type and global_filter are set, only global_fiter would be used gateway_ids Array [ string ] example: List [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] default: List [] Filtering based on multiple gateway_ids. } nullable: true

Request

The following is an example request:

POST /api/analytics/summary Authorization: Content-Type: application/json Request Body { "current_time": 1648119483, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the World Map Gateway Location View

To retrieve a resource containing gateway data-points plotted on a map overlay using geographic coordinates, use the REST API call below:

• Method: POST /api/analytics/location_view
• Resource: Path
• JSON Data: JSON data structure containing map overlay coordinates, date/time period selection, and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains a list of data-points along with summary information and aggregated information. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/analytics/location_view Authorization: Content-Type: application/json Request Body { "top_left_lat": 23, "top_left_long": -12, "bottom_right_lat": -34, "bottom_right_long": 47, "current_time": 1648119483, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the World Map Users View

To retrieve a resource containing user data-points plotted on a map overlay using geographic coordinates, use the REST API call below:

• Method: POST /api/analytics/zta_users_location_view
• Resource: Path
• JSON Data: JSON data structure containing date/time period selection, and optional filter for gateway selection

If processed correctly, a JSON body is returned that contains a list of data-points along with summary information. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/analytics/location_view Authorization: Content-Type: application/json Request Body { "current_time": 1580515200, "start_time": 1580515200, "time_duration_type": "day", "timezone_offset": 330, "gateway_type": "pcs", "overlay_filter_type": "non_compliance_users", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Sankey Chart View

To retrieve a resource containing data-points for plotting a Sankey chart of data flow between user groups, devices, Gateways, and applications, use the REST API call below:

• Method: POST /api/analytics/sankey_chart
• Resource: Path
• JSON Data: JSON data structure representing the CommonFilterObject schema (see Schema) - containing date/time period selection, and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains a list of data-points for plotting a Sankey chart. Otherwise, a JSON body containing an error is returned.

Parameters

• max_items_per_pillar: (integer - in: query)

  When this value <= 0, all items in each pillar will be returned. Otherwise, only specified maximum number of items per pillar will be returned in response. Default: -1.

• apps_details: (string - in: query)

  Flag capturing whether to return all apps or discovered apps details. Available values : all (default), discovered, non_discovered, default_gateway.

Request

The following is an example request:

POST /api/analytics/sankey_chart?max_items_per_pillar=-1&apps_details=all Authorization: Content-Type: application/json Request Body { "current_time": 1648119483, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Top Active Gateways Chart

To retrieve a resource containing data used to create the top Active Gateways chart, use the REST API call below:

• Method: POST /api/analytics/widgets/top_gateways
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) - containing date/time period selection and optional filter for gateway selection.

Schema

The FilterObject schema entity contains the following fields:

current_time	integer example: 1580515200 The time at which the Network Overview page was loaded. This is used to make sure that all the components on the page have the same reference so that they summarize the same data set.
start_time	integer example: 1580515200 The start time for the filter period (epoch). This value should represent the starting time for the selected 'time_duration_type'. Note the following: * Selecting "day" for 'time_duration_type' indicates this value should be the start of a specific calendar day (in UTC) * Selecting "week" for 'time_duration_type' indicates this value should be the start of a specific calendar week (in UTC) * Selecting "month" for 'time_duration_type' indicates this value should be the start of a specific calender month (in UTC)
end_time	integer example: 1580515200 The end time for the filter period (epoch). This value should represent the ending time for the selected 'time_duration_time' window. Use this field only when the 'time_duration_type' is set to "custom".
time_duration_type	string example: day Details of what unit of time duration need to be considered for the data. Enum: [ active, current_day, day, week, month, last_24_hours, custom ]
timezone_offset	string nullable: true example: pcs default: zta Type of the gateway. Enum: [ zta, pcs, pps, vtm, null ]
user_locations	Array [ string ] example: List [ "Pune", "Bangalore" ] default: List [] User access location filters for queries. Filtering based on multiple locations is supported.
user_name	string example: List [ "ZTAUser" ] User name filter for queries.
period	integer minimum: 0 default: 0 example: 0 Time-range in days (from current_time) for queries. 0 (default) means current values.
gateway_names	Array [ string ] example: List [ "SanJose_Gateway_1", "Paris_Gateway_1" ] default: List [] Names of the Gateways to be filtered.
application_names	Array [ string ] example: List [ "JIRA", "Confluence" ] default: List [] Application name filters for queries.
application_name	string example: List [ "Confluence" ]
device_types	Array [ string ] example: List [ "Windows", "iOS" ] default: List []Device type filters for queries.
geo_filter	Array [ number ] example: List [ 90, -180, -90, 180 ] default: List [ 90, -180, -90, 180 ] Geo filter; co-ordinates to be specified in this order [top_left_lat, top_left_long, bottom_right_lat, bottom_right_long]
location	{ description: Optional location to filter records. granularity string default: city example: city Granularity of the location. Following fields will be set for different values of granularity: city - city, country, continent country - country, continent continent - continent Enum: [ city, country, continent ] city string example: Austin Name of the city. Set when granularity is city. country string example: USA Name of the country. Set when granularity is city or country. continent string example: North America Name of the continent. Set when granularity is city, country, or continent. }
overlay_filter_type	string example: non_compliance_users   Dashboard overlay text filter type Enum: [ connected_users_in_last_one_hour, non_compliance_users, connected_users_in_more_than_one_day, users_from_most_busy_gateway, users_from_least_busy_gateway, top_risky_users, geo_anomaly_users, user_roles_with_most_non_compliances, top_users_with_auth_failures, users_with_mfa ]
global_filter	{ description: Global filter object that is applicable for all pages. If both overlay_filter_type and global_filter are set, only global_fiter would be used gateway_ids Array [ string ] example: List [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] default: List [] Filtering based on multiple gateway_ids. } nullable: true

Parameters

• num_gateways: (integer - in: query)

  The maximum number of Gateways for which data is returned. Default: 10.

Request

The following is an example request:

POST /api/analytics/widgets/top_gateways?num_gateways=10 Authorization: Content-Type: application/json Request Body { "current_time": 1648119483, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Top Active Applications Chart

To retrieve a resource containing data used to create the top Active Applications chart, use the REST API call below:

• Method: POST /api/analytics/widgets/top_applications
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) - containing date/time period selection and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains a list of data-points for plotting the Top Active Applications chart. Otherwise, a JSON body containing an error is returned.

Parameters

• num_applications: (integer - in: query)

  The maximum number of applications for which data is returned. Default: 10.

Request

The following is an example request:

POST /api/analytics/widgets/top_applications?num_applications=10 Authorization: Content-Type: application/json Request Body { "current_time": 1648119483, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Top Active User Locations Chart

To retrieve a resource containing data used to create the Top Active User Locations chart, use the REST API call below:

• Method: POST /api/analytics/widgets/top_user_access_locations
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) - containing date/time period selection and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains a list of data-points for plotting the Top Active User Locations chart. Otherwise, a JSON body containing an error is returned.

Parameters

• granularity: (string - in: query)

  The level of granularity for location identification. Available values : city (default), country, continent.

• num_locations: (integer - in: query)

  The maximum number of locations for which data is returned. Default: 10.

Request

The following is an example request:

POST /api/analytics/widgets/top_user_access_locations?granularity=city&num_locations=10 Authorization: Content-Type: application/json Request Body { "current_time": 1648119483, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Active Anomalies Chart

To retrieve a resource containing data used to create the Active Anomalies chart, use the REST API call below:

• Method: POST /api/analytics/widgets/anomalies
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) containing date/time period selection and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains a list of data-points for plotting the Active Anomalies chart. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/analytics/widgets/anomalies Authorization: Content-Type: application/json Request Body { "current_time": 1648119483, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Connected Clients Version Chart

To retrieve a resource containing data used to create the Connected Clients Version chart, use the REST API call below:

• Method: POST /api/analytics/devices/connected_clients
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) - containing date/time period selection and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains a list of data-points for plotting the Connected Clients Version chart. Otherwise, a JSON body containing an error is returned.

Parameters

• count: (integer - in: query)

  Default: 5.

Request

The following is an example request:

POST /api/analytics/devices/connected_clients?count=5 Authorization: Content-Type: application/json Request Body { "current_time": 1648119483, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "users": "active", "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Non-compliances Chart

To retrieve a resource containing data used to create the Non-compliances chart, use the REST API call below:

• Method: POST /api/analytics/users/top_non_compliance
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) - containing date/time period selection and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains a list of data-points for plotting the Non-compliances chart. Otherwise, a JSON body containing an error is returned.

Parameters

• count: (integer - in: query)

  The number of Top Compliance policies for which data is needed based on the number of failures of the corresponding policy. A value of "-1" returns data for all Compliance policies. Default: 8.

• page_level: (string - in: query)

  The Insights UI page level/depth for which non-compliance data is to be provided. Available values : L1, L2, L3, L4.

Request

The following is an example request:

POST /api/analytics/users/top_non_compliance?count=8&page_level=L1 Authorization: Content-Type: application/json Request Body { "current_time": 1648119483, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "page_level": "L1" "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Gateways Info-panel

To retrieve a resource containing data used to populate the Gateways Info-panel, use the REST API call below:

• Method: POST /api/analytics/widgets/top_gateways/panel
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) - containing date/time period selection and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains data used to populate the Gateways Info-panel. Otherwise, a JSON body containing an error is returned.

Parameters

• max_panel_items: (integer - in: query)

  The maximum number of items to be returned in the panel output. Default: 500.

• sort_order: (string - in: query)

  The sort order to apply. Available values: asc, desc (default).

• sort_field: (string - in: query)

  The field to sort by. Available values: active_users_count (default), active_applications_count, non_compliance_count, active_devices_count, active_sessions_count, number_of_issues, gateway_name, city_name.

• city_name: (string - in: query)

  The selected city name.

• search_string: (string - in: query)

  The search string to apply.

• status: (string - in: query)

  Return all Gateways or only those Gateways with this specified status. Available values : all (default), active, offline, online, unregistered.

Request

The following is an example request:

POST /api/analytics/widgets/top_gateways/panel?max_panel_items=500&sort_order=desc&sort_field=active_users_count&city_name=bangalore&search_string=gateway1&status=all Authorization: Content-Type: application/json Request Body { "current_time": 1648532792, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Users Info-panel

To retrieve a resource containing data used to populate the Users Info-panel, use the REST API call below:

• Method: POST /api/analytics/widgets/top_risky_users/panel
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) - containing date/time period selection and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains data used to populate the Users Info-panel. Otherwise, a JSON body containing an error is returned.

Parameters

• offset: (integer - in: query)

  The offset from which to fetch panel items. Default: 0.

• limit: (integer - in: query)

  The maximum number of panel items to return. Default: 20.

• sort_order: (string - in: query)

  The sort order to apply. Available values: asc, desc (default).

• sort_field: (string - in: query)

  The field to sort by. Available values: user_risk_score (default), user_name.

• city_name: (string - in: query)

  The selected city name.

• search_string: (string - in: query)

The search string to apply.

Request

The following is an example request:

POST /api/analytics/widgets/top_risky_users/panel?offset=0&limit=20&sort_order=desc&sort_field=user_risk_score&city_name=bangalore&search_string=user1&status=all Authorization: Content-Type: application/json Request Body { "current_time": 1648532792, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Devices Info-panel

To retrieve a resource containing data used to populate the Devices Info-panel, use the REST API call below:

• Method: POST /api/analytics/widgets/top_device_types/panel
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) - containing date/time period selection and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains data used to populate the Devices Info-panel. Otherwise, a JSON body containing an error is returned.

Parameters

• max_panel_items: (integer - in: query)

  The maximum number of items to be returned in the panel output. Default: 500.

• sort_order: (string - in: query)

  The sort order to apply. Available values: asc, desc (default).

• sort_field: (string - in: query)

  The field to sort by. Available values: active_users_count (default), active_applications_count, non_compliance_count, deviations_count, devices_count.

• search_string: (string - in: query)

  The search string to apply.

Request

The following is an example request:

POST /api/analytics/widgets/top_device_types/panel?max_panel_items=500&sort_order=desc&sort_field=active_users_count&search_string=Windows Authorization: Content-Type: application/json Request Body { "current_time": 1648532792, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Applications Info-panel

To retrieve a resource containing data used to populate the Applications Info-panel, use the REST API call below:

• Method: POST /api/analytics/widgets/top_applications/panel
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) - containing date/time period selection and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains data used to populate the Applications Info-panel. Otherwise, a JSON body containing an error is returned.

Parameters

• max_panel_items: (integer - in: query)

  The maximum number of items to be returned in the panel output. Default: 500.

• sort_order: (string - in: query)

  The sort order to apply. Available values: asc, desc (default).

• sort_field: (string - in: query)

  The field to sort by. Available values: active_users_count (default), active_applications_count, non_compliance_count, deviations_count, devices_count.

• search_string: (string - in: query)

  The search string to apply.

Request

The following is an example request:

POST /api/analytics/widgets/top_applications/panel?max_panel_items=500&sort_order=desc&sort_field=active_users_count&search_string= Authorization: Content-Type: application/json Request Body { "current_time": 1648532792, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Non-compliances Info-panel

To retrieve a resource containing data used to populate the Non-compliances Info-panel, use the REST API call below:

• Method: POST /api/analytics/widgets/non_compliance/panel
• Resource: Path
• JSON Data: JSON data structure based on the FilterObject schema (see Schema) - containing date/time period selection and optional filter for gateway selection.

If processed correctly, a JSON body is returned that contains data used to populate the Non-compliances Info-panel. Otherwise, a JSON body containing an error is returned.

Parameters

• offset: (integer - in: query)

  The offset from which to fetch panel items. Default: 0.

• limit: (integer - in: query)

  The maximum number of panel items to return. Default: 20.

• sort_order: (string - in: query)

  The sort order to apply. Available values: asc, desc (default).

• sort_field: (string - in: query)

  The field to sort by. Available values: timestamp (default), user_name.

• search_string: (string - in: query)

  The search string to apply.

Request

The following is an example request:

POST /api/analytics/widgets/non_compliance/panel?offset=0&limit=20&sort_order=desc&sort_field=timestamp&search_string= Authorization: Content-Type: application/json Request Body { "current_time": 1648532792, "start_time": 1580515200, "time_duration_type": "active", "timezone_offset": 330, "gateway_type": "zta", "global_filter": { "gateway_ids": [ "74h4h3-u43943-4u3o4", "84h4h3-u43943-4u3o5" ] } }

Response

The following is an example response:

Retrieving Analytics Data for the Anomalies Info-panel

To retrieve a resource containing data used to populate the Anomalies Info-panel, use the REST API call below:

• Method: POST /api/analytics/widgets/anomalies/panel
• Resource: Path
• JSON Data: JSON data structure representing the AnomaliesPanelFilterObject schema (see Schema) - containing date/time period selection, and optional filter for gateway selection.

Schema

The AnomaliesPanelFilterObject schema entity contains the following fields:

acknowledged_status string default: All example: Acknowledged Acknowledged status of anomalies to be filtered Enum: [ All, Acknowledged, Open ]

Parameters

• offset: (integer - in: query)

  The offset from which to fetch panel items. Default: 0.

• limit: (integer - in: query)

  The maximum number of panel items to return. Default: 20.

• sort_order: (string - in: query)

  The sort order to apply. Available values: asc, desc (default).

• sort_field: (string - in: query)

  The field to sort by. Available values: timestamp (default), user_name, acknowledged.

• search_string: (string - in: query)

  The search string to apply.

Request

The following is an example request:

POST /api/analytics/widgets/anomalies/panel?offset=0&limit=20&sort_order=desc&sort_field=timestamp&search_string=user1 Authorization: Content-Type: application/json Request Body { "acknowledged_status": "Acknowledged" }

Response

The following is an example response:

Retrieving Log Data

To retrieve a resource containing log data, use the REST API call below:

• Method: POST /api/analytics/logs/search
• Resource: Path
• JSON Data: JSON data structure representing the LogRequestEntity schema (see Schema), containing log selection criteria.

Schema

The LogRequestEntity schema entity contains the following fields:

name	string example: Filter1   Name to be used
start_time_es	integer example: 1576533928   Start time for logs in seconds since epoch. By default start of current day.
end_time_es	integer example: 1576533928   End time for logs in seconds since epoch. By default current time i.e now.
current_time	integer example: 1576533928   Current time for logs in seconds since epoch. By default current time i.e now.
timezone_offset	integer example: 330 Offset of the timezone to be used.
offset	integer example: 0 Start offsets for logs, default is 0.
limit	integer example: 100 Number of logs lines to be returned by the query
search_string	string example: ZTA Search string to be used
search_string_columns	Array [ string ] Selects search string columns to be used in query. Enum: [ application_configured_name, application_discovered, application_group_names, application_host, application_id, application_ip, application_location_city, application_name, application_names, application_protocol, application_protocol_display_name, application_request_id, application_status, application_type, application_url, auth_server_name, pulse_client_version, device_location_city, device_id, device_model, device_os_type, device_os_version, device_type, gateway_location_city, gateway_id, gateway_name, gateway_type, message_id, message_type, non_compliance_policy_id, non_compliance_policy_name, non_compliance_policy_types_list, raw_message, realm_name, role_names, session_id, severity, sub_message_type, source_ip, user_group, user_groups_list, user_id, user_name, user_risk_score_category ]
sort_by	string nullable: true default: timestamp Field used for sorting logs. Enum: [ timestamp, source_ip, message_id, severity, gateway_id, gateway_name, session_id, user_name, device_id, raw_message, user_group, application_name, non_compliance_policy_name, non_compliance_policy_types_list, device_location_city, device_location_country, sub_message_type, user_risk_score, user_risk_score_category, user_anomalies_count, user_alerts_count, user_activity_deviations_count, acknowledged, device_type, realm_name, role_names, pulse_client_version, device_os_type, gateway_location_city, application_type, application_protocol, application_protocol_display_name, application_discovered, application_group_names, application_status, application_bookmark_type, application_connection_broker, application_desktop_protocol, application_host, application_ip, application_location_city, application_url, message, browser, browser_id, controller, message_type, bandwidth_consumed_str, connected_time, host_checker_policy_name, host_checker_failed_reason, session_duration, null ]
sort_group_by	{ description: Field used for sorting of grouping logs. anyOf -> SortGroupByFieldType string example: application_name default: application_name Group by field type for sorting Enum: [ application_name, application_group, device_id, gateway_id, gateway_name, message_id, session_id,severity, source_ip, user_name, user_group, unique_application_group_names_count, unique_application_ips_count, unique_application_location_cities_count, unique_application_names_count, unique_application_protocols_count, unique_application_protocol_display_names_count, unique_application_urls_count, unique_device_ids_count, unique_device_location_cities_count, unique_gateway_ids_count, unique_gateway_names_count, unique_non_compliance_policy_types_count, unique_session_ids_count, unique_source_ips_count, unique_user_names_count, unique_user_groups_count ] }
group_by	{ description: Field used for grouping logs. anyOf -> GroupFieldType string example: application_name default: application_name Group by field type Enum: [ application_discovered, application_group_names, application_ip, application_location_city, application_name, application_protocol, application_protocol_display_name, application_status, application_type, pulse_client_version, device_id, device_location_city, device_os_type, device_type, gateway_id, gateway_location_city, gateway_name, message_type, non_compliance_policy_name, non_compliance_policy_types_list, source_ip, session_id, severity, sub_message_type, user_name, user_group, user_risk_score_category ] }
order	string default: desc Order of sorting specified by sortby field. Enum: [ asc, desc ]
log_type	string default: access example: access Type of the logs to be exported Enum: [ access, admin, event ]
gateway_type	string default: zta example: pcs Gateway Type of the logs to be exported Enum: [ pcs, zta ]
columns	Array [ LogColumns ] default: List [ "timestamp", "message_id", "severity", "session_id", "raw_message" ] Selects columns to be returned by query response. LogColumns string Enum: [ acknowledged, adaptive_auth_reason, application_bookmark_type, application_connection_broker, application_desktop_protocol, application_discovered, application_group_names, application_host, application_ip, application_location_city, application_name, application_protocol, application_protocol_display_name, application_status, application_type, application_url, avg_cpu, avg_disk, avg_memory, avg_throughput, bandwidth_consumed_in_bytes, bandwidth_consumed_str, browser, browser_id, concurrent_users_sessions, connected_time, controller, cpu, device_id, device_location_city, device_location_country, device_os_type, device_type, disk_used_percentage, esap_version, esap_version, gateway_id, gateway_location_city, gateway_location_country, gateway_name, gateway_status, gateway_version, gateway_version, host_checker_failed_reason, host_checker_policy_name, is_session_active, max_concurrent_user_licenses_consumed, message, message_id, message_type, non_compliance_policy_name, non_compliance_policy_types_list, physical_memory, primary_auth_failed_reason, primary_auth_server_name, primary_auth_server_type, pulse_client_version, raw_message, realm_name, role_names, secondary_auth_failed_reason, secondary_auth_server_type, secondary_auth_server_name, secondary_auth_server_user_name, session_created_timestamp, session_duration, session_id, session_type, severity, source_ip, sub_message_type, swap_memory, throughput_value, timestamp, user_activity_deviations_count, user_alerts_count, user_anomalies_count, user_group, user_name, user_risk_score, user_risk_score_category, ALL, null ]
group_by_columns	Array [ string ] default: List [ "unique_gateway_names_count", "unique_user_names_count", "unique_application_names_count", "summary_device_types", "summary_message_types", "unique_device_ids_count", "unique_session_ids_count" ] Selects group by columns to be returned by query response. Enum: [ summary_acknowledged, summary_application_discovered, summary_application_names, summary_application_types, summary_application_status, summary_pulse_client_versions, summary_device_types, summary_device_os_types, summary_non_compliance_policy_names, summary_non_compliance_policy_types, summary_message_ids, summary_message_types, summary_severities, summary_sub_message_types, summary_application_bookmark_types, summary_application_desktop_protocols, summary_browsers, summary_esap_versions, summary_gateway_status, summary_gateway_versions, summary_is_session_actives, summary_user_risk_score_categories, unique_application_group_names_count, unique_application_ips_count, unique_application_location_cities_count, unique_application_names_count, unique_application_protocols_count, unique_application_protocol_display_names_count, unique_application_urls_count, unique_device_ids_count, unique_device_location_cities_count, unique_gateway_ids_count, unique_gateway_names_count, unique_session_ids_count, unique_source_ips_count, unique_user_names_count, unique_user_groups_count, unique_application_connection_brokers_count, unique_application_hosts_count, unqiue_device_ids_count, unique_device_location_countries_count, unique_gateway_location_cities_count, unique_host_checker_policy_names_count, unique_message_ids_count, unique_raw_messages_count, unique_role_names_count, unique_realm_names_count, max_user_activity_deviations_count, max_user_alerts_count, max_user_anomalies_count, max_user_risk_score, avg_user_activity_deviations_count, avg_user_alerts_count, avg_user_anomalies_count, avg_user_risk_score, avg_cpu, avg_disk_used_percentage, avg_swap_memory, avg_throughput_value, max_cpu, max_disk_used_percentage, max_swap_memory, max_throughput_value, recent_user_activity_deviations_count, recent_user_alerts_count, recent_user_anomalies_count, recent_user_risk_score, recent_user_risk_score_category, ALL ]
filters	Array [ LogFilterEntity ] Represents a collection of filters to be applied. LogFilterEntity { description: Filter to be used filter_by* string example: message_ids Filter by field to be used Enum: [ gateway_ids, gateway_location_cities, gateway_names, user_names, user_groups, user_risk_score_categories, pulse_client_versions, device_ids, device_types, device_os_types, device_location_cities, device_location_countries, application_bookmark_types, application_connection_brokers, application_desktop_protocols, application_location_cities, application_names, application_group_names, application_hosts, application_ips, application_protocols, application_protocol_display_names, application_types, application_urls, message_ids, session_ids, source_ips, realm_names, role_names, severities, non_compliance_policy_names, non_compliance_policy_types, message_types, sub_message_types, ignore_sub_message_types, application_discovered, acknowledged, application_status_list, host_checker_policy_names, browsers, browser_ids, is_session_active, controller, raw_messages, gateway_statuses, gateway_versions, esap_versions, cpus, disk_used_percentages, physical_memories, swap_memories, throughput_values, avg_cpus, avg_disks, avg_memories, avg_throughputs, max_concurrent_user_licenses_consumed ] operator* string default: IS example: IS operator to be used Enum: [ IS, CONTAINS ] value* string example: ZTAGateway value to be checked for selected filter field }

Request

The following is an example request:

POST /api/analytics/logs/search Authorization: Content-Type: application/json Request Body { "name": "Filter1", "start_time_es": 1576533928, "end_time_es": 1576533928, "current_time": 1576533928, "timezone_offset": 330, "offset": 0, "limit": 100, "search_string": "ZTA", "search_string_columns": [ "application_configured_name" ], "sort_by": "timestamp", "sort_group_by": "application_name", "group_by": "application_name", "order": "desc", "log_type": "access", "gateway_type": "zta", "columns": [ "timestamp", "message_id", "severity", "session_id", "raw_message" ], "group_by_columns": [ "unique_gateway_names_count", "unique_user_names_count", "unique_application_names_count", "summary_device_types", "summary_message_types", "unique_device_ids_count", "unique_session_ids_count" ], "filters": [ { "filter_by": "message_ids", "operator": "IS", "value": "ZTAGateway" } ] }

Response

The following is an example response:

Retrieving Aggregated Gateway Statistics

To retrieve aggregated usage statistics for a list of Gateways, use the REST API call below:

• Method: GET /api/analytics/apm/appstats
• Resource: Path
• JSON Data: None

If processed correctly, a JSON body containing a MetricsResponseEntity resource is returned. Otherwise, a JSON body containing an error is returned.

Parameters

• metric: ( array[ string ] - in: query)

  A list of the required metrics. Available values: cpu, file_hits, web_hits, swap_memory, physical_memory, ssl_connections, in_in_throughput_bps, in_out_throughput_bps, ext_in_throughput_bps, ext_out_throughput_bps, mul_in_throughput_bps, mul_out_throughput_bps, concurrent_users_sessions, concurrent_users_vpn_sessions, disk_used_percentage, ALL.

• start_time_es: (integer - in: query)

  Start time of aggregation since epoch in seconds.

• end_time_es: (integer - in: query)

  End time of aggregation since epoch in seconds.

• bucket_size: (string - in: query)

  Aggregation based on bucketing. Available values: 5minutes, hours, days.

• gateway_ids: (array[ string ] - in: query)

  A list of the Gateway ID(s) for which data is required. To request data for all Gateways, use the value 'ALL'.

• agg_type: (string - in: query)

  The type of aggregation. Available values: SUM, AVG, MAX.

• location: (string - in: query)

  The Gateway location to use.

Request

The following is an example request:

GET /api/analytics/apm/appstats?metric=cpu&start_time_es=1574973734&end_time_es=1574973777&bucket_size=5minutes&gateway_ids=74h4h3-u43943-4u3o4&agg_type=SUM&location=Bangalore Authorization: Content-Type: application/json

Response

The following is an example response:

Applications (resources)

An application is a type of resources entity that represents a nZTA application. Applications support the following activities:

• Retrieving all applications, see Retrieving an Application.
• Editing an application, see Editing an Application.

Retrieving an Application

To retrieve all application (resources) entities, use the REST API call below:

• Method: GET /api/v1/policies/resources
• Resource: Path
• JSON Data: JSON dictionary representing a resources type of "application".

If processed correctly, a JSON body containing a list of all application resources is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/resources Authorization: Content-Type: application/json Request Body { "type": "application" }

Response

The following is an example response:

Editing an Application

To edit an application resources entity, use the REST API call below:

• Method: PUT /api/v1/policies/resources/{resource_id}
• Resource: Path
• JSON Data: JSON dictionary representing changed properties for an application resources entity.

If processed correctly, a JSON body containing the updated application resources entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/v1/policies/resources/{resource_id} Authorization: Content-Type: application/json Request Body { "type": "application", "name": "app1", "description": "app1", "app_config": { "access_type": "saml", "name": "app1", "resource": "https://www.example.com", "resource_type": "url", "bookmark_config": { "name": "app1", "type": "web", "description": "app1", "launch_window": True, "url": "https://www.intuit.com", "icon": "/admin/static/media/filename.svg" }, "saml_config": { "sp_metadata": "string" } } }

Response

The following is an example response:

Authentication Server (auth-servers)

The auth-servers entity represents a nZTA authentication server. Authentication servers support the following activities:

Retrieving All Authentication Servers

To retrieve all auth-servers entities, use the REST API call below:

• Method: GET /api/v1/policies/auth-servers
• Resource: Path
• JSON Data: No JSON is required for this request.

If processed correctly, a JSON body containing a list of all auth-servers is returned. Otherwise, a JSON body containing an error is returned.

Request

This REST API command always retrieves all auth-servers entities.

The following is an example request:

GET /api/v1/policies/auth-servers Authorization:

Response

The following is an example response:

Creating a Local Authentication Server

To create a local authentication server:

• Method: POST /api/v1/policies/auth-servers
• Resource: Path
• JSON Data: JSON dictionary representing a new local auth-servers entity.

If processed correctly, a JSON body containing the new local auth-servers entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/auth-servers Authorization: Request Body { "type": "Local", "name": "string", "cert_config": { "user_name_template": "string" }, "local_config": { "users": [ { "name": "string", "full_name": "string", "password": "string", "password_change_required": true } ] }, "samlsp_config": { "metadata_config_type": "url", "metadata_config_url": "string", "idp_type": "Azure AD", "idp_metadata_xml": "string" } }

Response

The following is an example response:

Creating a SAML Authentication Server

To create a remote SAML authentication server:

• Method: POST /api/v1/policies/auth-servers
• Resource: Path
• JSON Data: JSON dictionary representing a new SAML auth-servers entity.

If processed correctly, a JSON body containing the new SAML auth-servers entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/auth-servers Authorization: Request Body { "type": "SAML (Azure AD)", "name": "auth_server_1", "samlsp_config": { "idp_metadata_xml": "string" "idp_type": "Azure AD", "metadata_config_type": "file", "metadata_config_url": "string", } }

Response

The following is an example response:

Device Policies (device-policy/groups)

The device-policy/groups entity represents a nZTA device policy configuration.

Device policies support the following activities:

Retrieving all Device Policies

To retrieve all device-policy/groups entities, use the REST API call below:

• Method: GET /api/v1/policies/device-policies/device-policy/groups
• Resource: Path

If processed correctly, a JSON body containing a list of all device-policy/groups entities is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/device-policies/device-policy/groups Authorization: Content-Type: application/json

Response

The following is an example response:

Retrieving a Specific Device Policy

To retrieve a single device-policy/groups entity, use the REST API call below:

• Method: GET /api/v1/policies/device-policies/device-policy/groups/{id}
• Resource: Path

If processed correctly, a JSON body containing the device-policy/groups entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/device-policies/device-policy/groups/{id} Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a Device Policy

To create a device-policy/groups entity, use the REST API call below:

• Method: POST /api/v1/policies/device-policies/device-policy/groups
• Resource: Path
• JSON Data: JSON dictionary representing a new device-policy/groups entity.

If processed correctly, a JSON body containing the new device-policy/groups entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/device-policies/device-policy/groups Authorization: Content-Type: application/json Request Body { "name": "string", "description": "string", "is_default": true, "rules": [ { "additionalProp1": {} } ], "rule_requirements": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "device_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "all_of_the_above": "string", "any_of_the_above": "string", "custom_expression_enabled": true, "custom_expression": "string", "platform": "windows" } ], "remediation": { "additionalProp1": {} }, "enable_custom_instructions": true, "custom_instructions": "string" }

Response

The following is an example response:

Editing a Device Policy

To edit a device-policy/groups entity, use the REST API call below:

• Method: PUT /api/v1/policies/device-policies/device-policy/groups/{id}
• Resource: Path
• JSON Data: JSON dictionary representing changed properties for a device-policy/groups entity.

If processed correctly, a JSON body containing the updated device-policy/groups entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/v1/policies/device-policies/device-policy/groups/{id} Authorization: Content-Type: application/json Request Body { "name": "string", "description": "string" }

Response

The following is an example response:

Deleting a Device Policy

To delete a device-policy/groups entity, use the REST API call below:

• Method: DELETE /api/v1/policies/device-policies/device-policy/groups/{id}
• Resource: Path

If processed correctly, a confirmation is returned. Otherwise, an error is returned.

Request

The following is an example request:

DELETE /api/v1/policies/device-policies/device-policy/groups/{id} Authorization: Content-Type: application/json

Response

The following is an example response:

Device Policy Rules (device-policy/rules)

The device-policy/rules entity represents a nZTA policy rule configuration. Device policy rules support the following activities:

• Retrieving all device policy rules, see Retrieving all device policy rules.
• Retrieving a specific device policy rule, see Retrieving a specific device policy rule.
• Creating a device policy rule, see Creating a device policy rule.
• Editing a device policy rule, see Editing a device policy rule.
• Deleting a device policy rule, see Deleting a device policy rule.
• Adding a device policy rule to a device policy, see Adding a device policy rule to a device policy.
• Removing a device policy rule from a device policy, see Removing a device policy rule from a device policy.

Retrieving all Device Policy Rules

To retrieve all device-policy/rules entities, use the REST API call below:

• Method: GET /api/v1/policies/device-policies/device-policy/rules
• Resource: Path

If processed correctly, a JSON body containing a list of all device-policy/rules entities is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/device-policies/device-policy/rules Authorization: Content-Type: application/json

Response

The following is an example response:

Retrieving a Specific Device Policy Rule

To retrieve a single device-policy/rules entity, use the REST API call below:

• Method: GET /api/v1/policies/device-policies/device-policy/rules/{id}
• Resource: Path

If processed correctly, a JSON body containing the device-policy/rules entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/device-policies/device-policy/rules/{id} Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a Device Policy Rule

You can create rules for the following rule types:

• antispyware
• cve_check
• firewall
• hdd_encryption
• mac_address
• netbios
• patch_management
• process
• network
• registry
• file
• antivirus
• os
• jail_break_root

To create a device-policy/rules entity, use the REST API call below:

• Method: POST /api/v1/policies/device-policies/device-policy/rules
• Resource: Path
• JSON Data: JSON dictionary representing a new device-policy/rules entity.

If processed correctly, a JSON body containing the new device-policy/rules entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/device-policies/device-policy/rules Authorization: Content-Type: application/json Request Body { "name": "string", "description": "string", "type": "browser", "label": "high", "browser_config": { "user_agent": "string", "mode": "allow" }, "network_config": { "ip_address": "string", "netmask": "string", "mode": "allow" }, "hostchecker_config": { "name": "string", "type": "predefined", "predefined_rule": { "type": "antivirus", "hostchecker_level_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "hostchecker_product_list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "user_settings": { "hdd_encryption_settings": { "encrypt_drives": [ "string" ] } }, "hostchecker_level_name": "string", "hostchecker_product_list": { "products": [ "string" ], "vendors": [ "string" ] }, "platform": "windows" }, "custom_rule": { "platform": "windows", "type": "process", "registry": { "root_key": "HKEY_LOCAL_MACHINE", "sub_key": "string", "type": "string", "key": "string", "value": "string", "is_64_bit": true, "remediate": true, "monitor": true }, "process": { "process_name": "string", "md5_checksum": "string", "sha256_checksum": "string", "monitor": true, "action": "allow" }, "mobile_os_check": { "os_version": "string", "rule_separator": "above" }, "desktop_os_check": [ { "os_version": "string", "service_pack_version": "string" } ], "file": { "file_name": "string", "md5_checksum": "string", "sha256_checksum": "string", "monitor": true, "action": "allow" }, "cve_check": { "check_all": true, "cve_list": [ "string" ] }, "mobile_jail_break_root_check_enabled": true, "netbios": { "allow": true, "names": [ "string" ] }, "mac_address": { "allow": true, "address": [ "string" ] } } } }

Response

The following is an example response:

Editing a Device Policy Rule

To edit a device-policy/rules entity, use the REST API call below:

• Method: PUT /api/v1/policies/device-policies/device-policy/rules/{id}
• Resource: Path
• JSON Data: JSON dictionary representing changed properties for a device-policy/rules entity.

If processed correctly, a JSON body containing the updated device-policy/rules entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/v1/policies/device-policies/device-policy/rules/{id} Authorization: Content-Type: application/json Request Body { "name": "string", "description": "string", "type": "browser", "label": "high", "browser_config": { "user_agent": "string", "mode": "allow" }, "network_config": { "ip_address": "string", "netmask": "string", "mode": "allow" }, "hostchecker_config": { "name": "string", "type": "predefined", "predefined_rule": { "type": "antivirus", "hostchecker_level_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "hostchecker_product_list_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "user_settings": { "hdd_encryption_settings": { "encrypt_drives": [ "string" ] } }, "hostchecker_level_name": "string", "hostchecker_product_list": { "products": [ "string" ], "vendors": [ "string" ] }, "platform": "windows" }, "custom_rule": { "platform": "windows", "type": "process", "registry": { "root_key": "HKEY_LOCAL_MACHINE", "sub_key": "string", "type": "string", "key": "string", "value": "string", "is_64_bit": true, "remediate": true, "monitor": true }, "process": { "process_name": "string", "md5_checksum": "string", "sha256_checksum": "string", "monitor": true, "action": "allow" }, "mobile_os_check": { "os_version": "string", "rule_separator": "above" }, "desktop_os_check": [ { "os_version": "string", "service_pack_version": "string" } ], "file": { "file_name": "string", "md5_checksum": "string", "sha256_checksum": "string", "monitor": true, "action": "allow" }, "cve_check": { "check_all": true, "cve_list": [ "string" ] }, "mobile_jail_break_root_check_enabled": true, "netbios": { "allow": true, "names": [ "string" ] }, "mac_address": { "allow": true, "address": [ "string" ] } } } }

Response

The following is an example response:

Deleting a Device Policy Rule

To delete a device-policy/rules entity, use the REST API call below:

• Method: DELETE /api/v1/policies/device-policies/device-policy/rules/{id}
• Resource: Path

If processed correctly, a confirmation is returned. Otherwise, an error is returned.

Request

The following is an example request:

DELETE /api/v1/policies/device-policies/device-policy/rules/{id} Authorization: Content-Type: application/json

Response

The following is an example response:

Adding a Device Policy Rule to a Device Policy

To add a device-policy/rule entity to a device-policy/rule entity, use the REST API call below:

• Method: PUT /api/v1/policies/device-policies/groups/{id}/rules/{rule_id}
• Resource: Path

If processed correctly, a confirmation is returned. Otherwise, an error is returned.

Request

The following is an example request:

PUT /api/v1/policies/device-policies/groups/{id}/rules/{rule_id} Authorization: Content-Type: application/json

Response

The following is an example response:

Removing a Device Policy Rule from a Device Policy

To remove a device-policy/rule entity from a device-policy/rule entity, use the REST API call below:

• Method: DELETE /api/v1/policies/device-policies/groups/{id}/rules/{rule_id}
• Resource: Path

If processed correctly, a confirmation is returned. Otherwise, an error is returned.

Request

The following is an example request:

DELETE /api/v1/policies/device-policies/groups/{id}/rules/{rule_id} Authorization:- Content-Type: application/json

Response

The following is an example response:

Gateway (gateways)

The gateways entity represents a ZTA Gateway. Gateways support the following activities:

Retrieving all Gateways

To retrieve all gateways entities, use the REST API call below:

• Method: GET /api/gateways
• Resource: Path

If processed correctly, a JSON body containing a list of all gateways entities is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/gateways Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a Gateway

To create a gateways entity, use the REST API call below:

• Method: POST /api/gateways
• Resource: Path
• JSON Data: JSON dictionary representing a new gateways entity.

If processed correctly, a JSON body containing the new gateways entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/gateways Authorization: Content-Type: application/json Request Body { "name": "test_gateway", "orchestration_type": "vsphere" }

Response

The following is an example response:

Editing a Gateway

To edit a gateways entity, use the REST API call below:

• Method: PUT /api/gateways/{gateway_id}
• Resource: Path
• JSON Data: JSON dictionary representing changed properties for a gateways entity.

If processed correctly, a JSON body containing the updated gateways entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/gateways/{gateway_id} Authorization: Content-Type: application/json Request Body { "group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }

Response

The following is an example response:

Deleting a Gateway

To delete a gateways entity, use the REST API call below:

• Method: DELETE /api/gateways/{gateway_id}
• Resource: Path

If processed correctly, a confirmation is returned. Otherwise, an error is returned.

Request

The following is an example request:

DELETE /api/gateways/{gateway_id} Authorization: Content-Type: application/json Request Body { "id": "e274bf3ebe3841a88ade1630515624c6", }

Response

The following is an example response:

Renewing a Client Certificate

To renew a certificate for a client, use the REST API call below:

• Method: POST /api/gateways/self/certificates/client
• Resource: Path
• JSON Data: JSON dictionary representing a certificate signing request (CSR).

If processed correctly, a JSON body containing the new client certificate is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/gateways/self/certificates/client Authorization: Content-Type: application/json Request Body { "csr": "string" }

Response

The following is an example response:

Gateway Settings

Gateway settings are additional properties for a ZTA Gateway. Gateway settings support the following activities:

Retrieving the Settings for a Gateway

To retrieve the settings for a gateways entity, use the REST API call below:

• Method: GET /api/gateways/{gateway_id}/settings/current
• Resource: Path

If processed correctly, a JSON body containing the properties for the gateways entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/gateways/{gateway_id}/settings/current Authorization: Content-Type: application/json

Response

The following is an example response:

Editing Settings for a Gateway

To edit the settings for a gateways entity, use the REST API call below:

• Method: PUT /api/gateways/self/settings/current
• Resource: Path
• JSON Data: JSON dictionary representing updated settings

If processed correctly, a JSON body containing the updated properties for the gateways entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/gateways/self/settings/current Authorization: Content-Type: application/json Request Body { "version": "string", "primary_dns": "string", "secondary_dns": "string", "dns_search_domain": "string", "internal_ip_address": "string", "internal_subnet": "string", "internal_gateway": "string", "external_ip_address": "string", "external_subnet": "string", "external_gateway": "string", "management_ip_address": "string", "management_subnet": "string", "management_gateway": "string", "connect_via_mgmt_interface": true, "model": "string", "rollback_version": "string" }

Response

The following is an example response:

Gateway Group (groups)

The groups entity represents a ZTA Gateway group. Gateway groups support the following activities:

Retrieving a Gateway Group

To retrieve all gateway groups, use the REST API call below:

• Method: GET /api/gateways/groups
• Resource: Path

If processed correctly, a JSON body containing a list of all gateway groups is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/gateways/groups Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a Gateway Group

To create a gateway group, use the REST API call below:

• Method: POST /api/gateways/groups
• Resource: Path
• JSON Data: JSON dictionary representing a new gateway group.

If processed correctly, a JSON body containing the new gateway group is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/gateways/groups Authorization: Content-Type: application/json Request Body { "name": "asia-pacific-grp", "description": "Gateway group assigned to Asia Pacific region", "load_balancer_ips": [ "10.1.2.3" ], "dns_cname": "string", "members": [ "e274bf3ebe3841a88ade1630515624c6" ] }

Response

The following is an example response:

Editing a Gateway Group

To edit a gateway group, use the REST API call below:

• Method: PUT /api/gateways/groups/{id}
• Resource: Path
• JSON Data: JSON dictionary representing changed properties for a gateway group.

If processed correctly, a JSON body containing the updated gateway group is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/gateways/groups/{id} Authorization: Content-Type: application/json Request Body { "name": "asia-pacific-grp", "description": "Gateway group assigned to Asia Pacific region", "load_balancer_ips": [ "10.1.2.3" ], "dns_cname": "string" }

Response

The following is an example response:

Hostchecker Levels (hostchecker/levels)

The hostchecker/levels entity represents a nZTA hostchecker configuration.

Hostchecker levels must be created and configured before device policies can be created successfully.

Hostchecker levels support the following activities:

Retrieving all Hostchecker Levels

To retrieve all hostchecker/levels entities, use the REST API call below:

• Method: GET /api/v1/policies/device-policies/hostchecker/levels
• Resource: Path

If processed correctly, a JSON body containing a list of all hostchecker/levels entities is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/device-policies/hostchecker/levels Authorization: Content-Type: application/json

Response

The following is an example response:

Retrieving a Specific Hostchecker Level

To retrieve a single hostchecker/levels entity, use the REST API call below:

• Method: GET /api/v1/policies/device-policies/hostchecker/levels/{id}
• Resource: Path

If processed correctly, a JSON body containing the hostchecker/levels entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/device-policies/hostchecker/levels/{id} Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a Hostchecker Level

To create a hostchecker/levels entity, use the REST API call below:

• Method: POST /api/v1/policies/device-policies/hostchecker/levels
• Resource: Path
• JSON Data: JSON dictionary representing a new hostchecker/levels entity.

If processed correctly, a JSON body containing the new hostchecker/levels entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/device-policies/hostchecker/levels Authorization: Content-Type: application/json Request Body { "name": "string", "antivirus": { "check_last_scan": true, "last_scan_period": 0, "check_definition": true, "definition_check_type": "days", "remediate_last_scan": true, "remediate_download_signatures": true, "monitor": true }, "firewall": { "remediate": true, "monitor": true }, "hdd_encryption": { "encrypt_all_drives": true, "pass_no_drive_detected": true }, "antispyware": { "monitor": true }, "patch_management": { "severity": { "critical": true, "important": true, "moderate": true, "low": true, "unspecified": true }, "category": { "security": true, "rollup": true, "critical": true, "regular": true, "driver": true, "service_pack": true, "unknown": true } } }

Response

The following is an example response:

Editing a Hostchecker Level

To edit a hostchecker/levels entity, use the REST API call below:

• Method: PUT /api/v1/policies/device-policies/hostchecker/levels/{id}
• Resource: Path
• JSON Data: JSON dictionary representing changed properties for a hostchecker/levels entity.

If processed correctly, a JSON body containing the updated hostchecker/levels entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/v1/policies/device-policies/hostchecker/levels/{id} Authorization: Content-Type: application/json Request Body { "name": "string", "antivirus": { "check_last_scan": true, "last_scan_period": 0, "check_definition": true, "definition_check_type": "days", "remediate_last_scan": true, "remediate_download_signatures": true, "monitor": true }, "firewall": { "remediate": true, "monitor": true }, "hdd_encryption": { "encrypt_all_drives": true, "pass_no_drive_detected": true }, "antispyware": { "monitor": true }, "patch_management": { "severity": { "critical": true, "important": true, "moderate": true, "low": true, "unspecified": true }, "category": { "security": true, "rollup": true, "critical": true, "regular": true, "driver": true, "service_pack": true, "unknown": true } } }

Response

The following is an example response:

Deleting a Hostchecker Level

To delete a hostchecker/levels entity, use the REST API call below:

• Method: DELETE /api/v1/policies/device-policies/hostchecker/levels/{id}
• Resource: Path

If processed correctly, a confirmation is returned. Otherwise, an error is returned.

Request

The following is an example request:

DELETE /api/v1/policies/device-policies/hostchecker/levels/{id} Authorization: Content-Type: application/json

Response

The following is an example response:

Hostchecker Products (hostchecker/products)

The hostchecker/products entity represents a nZTA hostchecker configuration. Hostchecker products support the following activities:

Retrieving all Hostchecker Products

To retrieve all hostchecker/products entities, use the REST API call below:

• Method: GET /api/v1/policies/device-policies/hostchecker/products
• Resource: Path

If processed correctly, a JSON body containing a list of all hostchecker/products entities is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/device-policies/hostchecker/products Authorization: Content-Type: application/json

Response

The following is an example response:

Retrieving a Specific Hostchecker Product

To retrieve a single hostchecker/products entity, use the REST API call below:

• Method: GET /api/v1/policies/device-policies/hostchecker/products/{id}
• Resource: Path

If processed correctly, a JSON body containing the hostchecker/products entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/device-policies/hostchecker/products/{id} Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a Hostchecker Product

To create a hostchecker/products entity, use the REST API call below:

• Method: POST /api/v1/policies/device-policies/hostchecker/products
• Resource: Path
• JSON Data: JSON dictionary representing a new hostchecker/products entity.

If processed correctly, a JSON body containing the new hostchecker/products entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/device-policies/hostchecker/products Authorization: Content-Type: application/json Request Body { "name": "string", "windows": { "antivirus": { "vendors": [ "string" ], "products": [ "string" ] }, "firewall": { "vendors": [ "string" ], "products": [ "string" ] }, "antispyware": { "vendors": [ "string" ], "products": [ "string" ] }, "hdd_encryption": { "vendors": [ "string" ], "products": [ "string" ] }, "patch_management": { "vendors": [ "string" ], "products": [ "string" ] } }, "mac": { "antivirus": { "vendors": [ "string" ], "products": [ "string" ] }, "firewall": { "vendors": [ "string" ], "products": [ "string" ] }, "antispyware": { "vendors": [ "string" ], "products": [ "string" ] }, "hdd_encryption": { "vendors": [ "string" ], "products": [ "string" ] }, "patch_management": { "vendors": [ "string" ], "products": [ "string" ] } } }

Response

The following is an example response:

Editing a Hostchecker Product

To edit a hostchecker/products entity, use the REST API call below:

• Method: PUT /api/v1/policies/device-policies/hostchecker/products/{id}
• Resource: Path
• JSON Data: JSON dictionary representing changed properties for a hostchecker/products entity.

If processed correctly, a JSON body containing the updated hostchecker/products entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/v1/policies/device-policies/hostchecker/products/{id} Authorization: Content-Type: application/json Request Body { "name": "string", "windows": { "antivirus": { "vendors": [ "string" ], "products": [ "string" ] }, "firewall": { "vendors": [ "string" ], "products": [ "string" ] }, "antispyware": { "vendors": [ "string" ], "products": [ "string" ] }, "hdd_encryption": { "vendors": [ "string" ], "products": [ "string" ] }, "patch_management": { "vendors": [ "string" ], "products": [ "string" ] } }, "mac": { "antivirus": { "vendors": [ "string" ], "products": [ "string" ] }, "firewall": { "vendors": [ "string" ], "products": [ "string" ] }, "antispyware": { "vendors": [ "string" ], "products": [ "string" ] }, "hdd_encryption": { "vendors": [ "string" ], "products": [ "string" ] }, "patch_management": { "vendors": [ "string" ], "products": [ "string" ] } } }

Response

The following is an example response:

Deleting a Hostchecker Product

To delete a hostchecker/products entity, use the REST API call below:

• Method: DELETE /api/v1/policies/device-policies/hostchecker/products/{id}
• Resource: Path

If processed correctly, a confirmation is returned. Otherwise, an error is returned.

Request

The following is an example request:

DELETE /api/v1/policies/device-policies/hostchecker/products/{id} Authorization: Content-Type: application/json

Response

The following is an example response:

Resource Group (resource-groups)

The resource-groups entity represents a nZTA group of resources (both sign-in resources and applications). Resource groups support the following activities:

Retrieving All Resource Groups

To retrieve a resource_groups entity, use the REST API call below:

• Method: GET /api/v1/policies/resource-groups
• Resource: Path

If processed correctly, a JSON body containing a list of all resource-groups entities is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/resource-groups Authorization:

Response

The following is an example response:

Creating a Resource Group

To create a resource_group entity, use the REST API call below:

• Method: POST /api/v1/policies/resource-groups
• Resource: Path
• JSON Data: JSON dictionary representing a new resource-groups entity.

If processed correctly, a JSON body containing the new resource-groups is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/resource-groups Authorization: Content-Type: application/json Request Body { "name": "string", "type": "string", "resources": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "sign_in", "description": "string", "sign_in_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "policy_type": "admin", "url_pattern": "string", "realm": "string", "primary_auth_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "secondary_auth_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "primary_authorization_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "app_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "access_type": "application", "resource_type": "fqdn", "resource": "string", "bookmark_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "web", "description": "string", "launch_window": true, "url": "string", "icon": "string" }, "saml_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sp_metadata": "string" } } } ] }

Response

The following is an example response:

Editing a Resource Group

To edit a resource-group entity, use the REST API call below:

• Method: PUT /api/v1/policies/resource-groups/<id>
• Resource: Path
• JSON Data: JSON dictionary representing changed properties for a resource-groups entity.

If processed correctly, a JSON body containing the updated resources-group entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/v1/policies/resource-groups/{id} Authorization: Content-Type: application/json Request Body { "name": "string", "type": "string", "resources": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "sign_in", "description": "string", "sign_in_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "policy_type": "admin", "url_pattern": "string", "realm": "string", "primary_auth_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "secondary_auth_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "primary_authorization_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "app_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "access_type": "application", "resource_type": "fqdn", "resource": "string", "bookmark_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "web", "description": "string", "launch_window": true, "url": "string", "icon": "string" }, "saml_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sp_metadata": "string" } } } ] }

Response

The following is an example response:

Role Mapping Rules (role-mapping-rules)

The role-mapping-rules entity represents a nZTA role mapping rule. Role mapping rules support the following activities:

Retrieving All Role Mapping Rules

To retrieve a list of all role-mapping-rules entities, use the REST API call below:

• Method: GET /api/v1/policies/role-mapping-rules
• Resource: Path

If processed correctly, a JSON body containing a list of all role-mapping-rules entities is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/role-mapping-rules Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a Role Mapping Rule

To create a role-mapping-rules entity, use the REST API call below:

• Method: POST /api/v1/policies/role-mapping-rules
• Resource: Path
• JSON Data: JSON dictionary representing a new role-mapping-rules entity.

If processed correctly, a JSON body containing the new role-mapping-rules entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/role-mapping-rules Authorization: Content-Type: application/json Request Body { "type": "username", "name": "string", "attribute": "string", "value": "string" }

Response

The following is an example response:

Secure Access Policy (secure-access-policies)

The secure-access-policies entity represents a nZTA secure access policy. Secure access policies support the following activities:

Retrieving All Secure Access Policies

To retrieve all secure-access-policies entities, use the REST API call below:

• Method: GET /api/v1/policies/secure-access-policies
• Resource: Path

If processed correctly, a JSON body containing a list of all secure-access-policies entities is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/secure-access-policies Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a Secure Access Policy

To create a secure-access-policies entity, use the REST API call below:

• Method: POST /api/v1/policies/secure-access-policies
• Resource: Path
• JSON Data: JSON dictionary representing a new secure-access-policies entity.

If processed correctly, a JSON body containing the new secure-access-policies entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/secure-access-policies Authorization: Content-Type: application/json Request Body { "type": "sign_in", "resource_type": "single", "resource_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "resource_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "device_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "gateway_type": "single", "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "gateway_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "user_rule_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }

Response

The following is an example response:

Enterprise Integrations Configurations Service (integrations/syslog)

The integrations/syslog entity holds information about third party Enterprise Integrations Syslog Server configurations. This entity support the following activities:

Retrieving the Enterprise Integrations Syslog Forwarding Configuration

To retrieve an integrations/syslog entity, use the REST API call below:

• Method: GET /api/integrations/syslog
• Resource: Path

If processed correctly, a JSON body is returned that contains a list of syslog servers categorized by log type (access, event, admin). Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/integrations/syslog Authorization: Content-Type: application/json

Response

The following is an example response:

Adding Enterprise Integrations Syslog Forwarding Configuration Details

To add an integrations/syslog entity containing a syslog forwarding configuration, use the REST API call below:

• Method: POST /api/integrations/syslog
• Resource: Path
• JSON Data: JSON dictionary representing a new integrations/syslog entity.

If processed correctly, a JSON body containing the new integrations/syslog entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/integrations/syslog Authorization: Content-Type: application/json Request Body { "name": "string", "server": "string", "log_types": [ "access" ], "facility": "LOCAL0", "protocol": "TLS", "certificate_id": "3fa85f6457174562b3fc2c963f66afa6", "filter_id": "123e4567e89b12d3a456426614174000", "gateway_ids": [ "123e4567e89b12d3a456wr6614175643" ], "proxy_gateway_id": "123e4567e89b12d3a456wr6614175643" }

Response

The following is an example response:

Retrieving a List of Enterprise Integrations Syslog Configurations

To retrieve a list of Enterprise Integrations Syslog Server configurations, use the REST API call below:

• Method: GET /api/integrations/syslog/ui
• Resource: Path

If processed correctly, a JSON body containing a list of all integrations/syslog/ui entities is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/integrations/syslog/ui Authorization: Content-Type: application/json

Response

The following is an example response:

Retrieving a Specific Enterprise Integrations Syslog Configuration

To retrieve a single integrations/syslog entity, use the REST API call below:

• Method: GET /api/integrations/syslog/{syslog_id}
• Resource: Path

If processed correctly, a JSON body containing the integrations/syslog entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/integrations/syslog/{syslog_id} Authorization: Content-Type: application/json

Response

The following is an example response:

Editing an Enterprise Integrations Syslog Configuration

To edit an integrations/syslog entity, use the REST API call below:

• Method: PUT /api/integrations/syslog/{syslog_id}
• Resource: Path
• JSON Data: JSON dictionary representing changed properties for a integrations/syslog entity.

If processed correctly, a JSON body containing the updated integrations/syslog entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/integrations/syslog/{syslog_id} Authorization: Content-Type: application/json Request Body { "name": "string", "server": "string", "log_types": [ "access" ], "facility": "LOCAL0", "protocol": "TLS", "certificate_id": "3fa85f6457174562b3fc2c963f66afa6", "filter_id": "123e4567e89b12d3a456426614174000", "gateway_ids": [ "123e4567e89b12d3a456wr6614175643" ], "proxy_gateway_id": "123e4567e89b12d3a456wr6614175643" }

Response

The following is an example response:

Removing an Enterprise Integrations Syslog Configuration

To remove an integrations/syslog entity, use the REST API call below:

• Method: DELETE /api/integrations/syslog/{syslog_id}
• Resource: Path

If processed correctly, a confirmation is returned. Otherwise, an error is returned.

Request

The following is an example request:

DELETE /api/integrations/syslog/{syslog_id} Authorization: Content-Type: application/json

Response

The following is an example response:

Users (users)

The users entity represents a nZTA user. Users support the following activities:

Retrieving a User

To retrieve the current user, use the REST API call below:

• Method: GET /users/self
• Resource: Path

If processed correctly, a JSON body containing the current user is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /users/self Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a User

To create a user entity, use the REST API call below:

• Method: POST /users/self
• Resource: Path
• JSON Data: JSON dictionary representing a new user entity.

If processed correctly, a JSON body containing the new user entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /users/self Authorization: Content-Type: application/json Request Body { "first_name": "John", "last_name": "Doe", "email": "[email protected]" }

Response

The following is an example response:

Retrieving User Settings

To retrieve the current user settings, use the REST API call below:

• Method: GET /users/self/settings/ui
• Resource: Path

If processed correctly, a JSON body containing the current user settings is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /users/self/settings/ui Authorization: Content-Type: application/json

Response

The following is an example response:

Updating User Settings

To update user settings, use the REST API call below:

• Method: PUT /users/self/settings/ui
• Resource: Path
• JSON Data: JSON dictionary representing new user settings.

If processed correctly, a JSON body containing user settings is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /users/self/settings/ui Authorization: Content-Type: application/json Request Body { "previous_version": "h2kbb486534c49fd8ec732a1aa647b02d8e338ua", "settings": { "on_login": { "show_welcome_wizard": true } } }

Response

The following is an example response:

User Rule Groups (user-rule-groups)

Retrieving All User Rule Groups

To retrieve all user-rule-groups entities, use the REST API call below:

• Method: GET /api/v1/policies/user-rule-groups
• Resource: Path

If processed correctly, a JSON body containing a list of all user-rule-groups entities is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/user-rule-groups Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a User Rule Group

To create a user-rule-groups entity, use the REST API call below:

• Method: POST /api/v1/policies/user-rule-groups
• Resource: Path
• JSON Data: JSON dictionary representing a new user-rule-groups entity.

If processed correctly, a JSON body containing the new user-rule-groups entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/user-rule-groups Authorization: Content-Type: application/json Request Body { "name": "string", "description": "string", "role_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sign_in_policy_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "rules": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "username", "attribute": "string", "value": "string" } ] }

Response

The following is an example response:

User Policies (resources)

A user policy is a type of resources entity that represents a nZTA user policy. User policies support the following activities:

• Retrieving all user policies, see Retrieving All User Policies.
• Editing a user policy, see Editing a User Policy.

Retrieving All User Policies

To retrieve all user policy (resources) entities, use the REST API call below:

• JSON Data: JSON dictionary representing a resources type of sign-in.
• Resource: Path
• Method: GET /api/v1/policies/resources

If processed correctly, a JSON body containing a list of all user policy resources is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/resources Authorization: Content-Type: application/json Request Body { "type": "sign_in" }

Response

The following is an example response:

Editing a User Policy

To edit a user policy resources entity, use the REST API call below:

• JSON Data: JSON dictionary representing changed properties for a user policy resources entity.
• Resource: Path
• Method: PUT /api/v1/policies/resources/{resource_id}

If processed correctly, a JSON body containing the updated user policy resources entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/v1/policies/resources/{resource_id} Authorization: Content-Type: application/json Request Body { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "sign_in", "description": "string", "sign_in_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "policy_type": "admin", "url_pattern": "string", "realm": "string", "use_as_saml_idp": true, "primary_auth_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "primary_auth_server_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "Local", "name": "string" }, "secondary_auth_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "secondary_auth_server_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "Local", "name": "string" }, "primary_authorization_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "app_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "access_type": "application", "resource_type": "fqdn", "resource": "string", "bookmark_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "web", "description": "string", "launch_window": true, "url": "string", "icon": "string" }, "saml_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sp_metadata": "string" } } }

Response

The following is an example response:

HTTP/1.1 200 OK Content-Type: application/json Response Body { "name": "string", "type": "sign_in", "description": "string", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sign_in_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "policy_type": "admin", "url_pattern": "string", "realm": "string", "use_as_saml_idp": true, "primary_auth_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "primary_auth_server_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "Local", "name": "string" }, "secondary_auth_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "secondary_auth_server_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "type": "Local", "name": "string" }, "primary_authorization_server_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }, "app_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "access_type": "application", "resource_type": "fqdn", "resource": "string", "bookmark_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "web", "description": "string", "launch_window": true, "url": "string", "icon": "string" }, "saml_config": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "sp_metadata": "string", "attributes": [ { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "attribute": "string", "value": "string", "resource_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ] } } }

Retrieving Lockdown Exceptions

To retrieve Lockdown exceptions, use the REST API call below:

• Method: GET /api/clients/ui/lockdown/exceptions
• Resource: Path

If processed correctly, a JSON body containing the exceptions entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/clients/ui/lockdown/exceptions Authorization: Content-Type: application/json

Response

The following is an example response:

Creating a MDM Server

To Create a MDM Server entity, use the REST API call below:

• JSON Data: JSON dictionary representing changed properties for a MDM Server entity.
• Resource: Path
• Method: POST /api/v1/policies/mdm-servers

If processed correctly, a JSON body containing the new MDM Server entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

POST /api/v1/policies/mdm-servers Authorization: Content-Type: application/json Request Body { "name": "string", "type": "Ivanti Cloud", "ivanti_cloud_config": { "server_url": "string", "viewer_url": "string", "request_timeout": 0, "admin_user_name": "string", "admin_password": "string", "admin_password_hash": "string", "device_identifier_template": "CN", "device_identifier_type": "UUID" }, "microsoft_intune_config": { "national_clouds": "string", "tenant_id": "string", "client_id": "string", "client_secret": "string", "request_timeout": 0, "device_identifier_template": "CN", "device_identifier_type": "deviceID", "device_identity": "certificate" } }

Response

The following is an example response:

HTTP/1.1 200 OK Content-Type: application/json Response Body { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "Ivanti Cloud", "ivanti_cloud_config": { "server_url": "string", "viewer_url": "string", "request_timeout": 0, "admin_user_name": "string", "admin_password": "string", "admin_password_hash": "string", "device_identifier_template": "CN", "device_identifier_type": "UUID" }, "microsoft_intune_config": { "national_clouds": "string", "tenant_id": "string", "client_id": "string", "client_secret": "string", "request_timeout": 0, "device_identifier_template": "CN", "device_identifier_type": "deviceID", "device_identity": "certificate" } }

Retrieving a MDM Server by ID

To retrieve a MDM Server by ID entity, use the REST API call below:

• JSON Data: JSON dictionary representing changed properties for a MDM Server by ID entity.
• Resource: Path
• Method: GET/api/v1/policies/mdm-servers/{mdm_server_id}

If processed correctly, a JSON body containing the MDM Server by ID entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

GET /api/v1/policies/mdm-servers/{mdm_server_id} Authorization: Content-Type: application/json

Response

The following is an example response:

HTTP/1.1 200 OK Content-Type: application/json Response Body { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "Ivanti Cloud", "ivanti_cloud_config": { "server_url": "string", "viewer_url": "string", "request_timeout": 0, "admin_user_name": "string", "admin_password": "string", "admin_password_hash": "string", "device_identifier_template": "CN", "device_identifier_type": "UUID" }, "microsoft_intune_config": { "national_clouds": "string", "tenant_id": "string", "client_id": "string", "client_secret": "string", "request_timeout": 0, "device_identifier_template": "CN", "device_identifier_type": "deviceID", "device_identity": "certificate" } }

Editing a MDM Server

To edit a MDM Server entity, use the REST API call below:

• JSON Data: JSON dictionary representing changed properties for a MDM Server entity.
• Resource: Path
• Method: PUT /api/v1/policies/mdm-servers/{mdm_server_id}

If processed correctly, a JSON body containing the edited MDM Server entity is returned. Otherwise, a JSON body containing an error is returned.

Request

The following is an example request:

PUT /api/v1/policies/mdm-servers/{mdm_server_id} Authorization: Content-Type: application/json Request Body { "name": "string", "type": "Ivanti Cloud", "ivanti_cloud_config": { "server_url": "string", "viewer_url": "string", "request_timeout": 0, "admin_user_name": "string", "admin_password": "string", "admin_password_hash": "string", "device_identifier_template": "CN", "device_identifier_type": "UUID" }, "microsoft_intune_config": { "national_clouds": "string", "tenant_id": "string", "client_id": "string", "client_secret": "string", "request_timeout": 0, "device_identifier_template": "CN", "device_identifier_type": "deviceID", "device_identity": "certificate" } }

Response

The following is an example response:

HTTP/1.1 200 OK Content-Type: application/json Response Body { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "name": "string", "type": "Ivanti Cloud", "ivanti_cloud_config": { "server_url": "string", "viewer_url": "string", "request_timeout": 0, "admin_user_name": "string", "admin_password": "string", "admin_password_hash": "string", "device_identifier_template": "CN", "device_identifier_type": "UUID" }, "microsoft_intune_config": { "national_clouds": "string", "tenant_id": "string", "client_id": "string", "client_secret": "string", "request_timeout": 0, "device_identifier_template": "CN", "device_identifier_type": "deviceID", "device_identity": "certificate" } }

Deleting a MDM Server

To delete a MDM Server entity, use the REST API call below:

•Method: DELETE /api/v1/policies/mdm-servers/{mdm_server_id}

•Resource: Path

If processed correctly, a confirmation is returned. Otherwise, an error is returned.

Request

The following is an example request:

DELETE /api/v1/policies/mdm-servers/{mdm_server_id} Authorization: Content-Type: application/json

Response

The following is an example response:

HTTP/1.1 204 Deleted MDM Server successfully Content-Type: application/json