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 docid\ al8gmecutfpz6qlw5cwfp applications, see applications (resources) docid\ al8gmecutfpz6qlw5cwfp authentication servers, see authentication server (auth servers) docid\ al8gmecutfpz6qlw5cwfp device policies, see device policies (device policy/groups) docid\ al8gmecutfpz6qlw5cwfp device policy rules, see device policy rules (device policy/rules) docid\ al8gmecutfpz6qlw5cwfp gateways, see gateway (gateways) docid\ al8gmecutfpz6qlw5cwfp gateway settings, see gateway settings docid\ al8gmecutfpz6qlw5cwfp gateway groups, see gateway group (groups) docid\ al8gmecutfpz6qlw5cwfp hostchecker levels, see hostchecker levels (hostchecker/levels) docid\ al8gmecutfpz6qlw5cwfp hostchecker products, see hostchecker products (hostchecker/products) docid\ al8gmecutfpz6qlw5cwfp resources, see " applications docid\ al8gmecutfpz6qlw5cwfp " and " user policies docid\ al8gmecutfpz6qlw5cwfp " resource groups, see resource group (resource groups) docid\ al8gmecutfpz6qlw5cwfp role mapping rules, see role mapping rules (role mapping rules) docid\ al8gmecutfpz6qlw5cwfp secure access policies, see secure access policy (secure access policies) docid\ al8gmecutfpz6qlw5cwfp enterprise integrations syslog server configuration, see enterprise integrations configurations service (integrations/syslog) docid\ al8gmecutfpz6qlw5cwfp users, see users (users) docid\ al8gmecutfpz6qlw5cwfp user rule groups, see user rule groups (user rule groups) docid\ al8gmecutfpz6qlw5cwfp user policies, see user policies (resources) docid\ al8gmecutfpz6qlw5cwfp lockdown exceptions, see lockdown exceptions docid\ al8gmecutfpz6qlw5cwfp mdm server, see mdm server docid\ al8gmecutfpz6qlw5cwfp user risk score, see user risk score docid\ al8gmecutfpz6qlw5cwfp storage consumption see storage consumption docid\ al8gmecutfpz6qlw5cwfp 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> for a worked example of nzta entity use, see ivanti neurons for zero trust access use case docid\ l57zcvyzgivv8r cqnig5 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 docid\ al8gmecutfpz6qlw5cwfp retrieving data for the world map gateway locations view, see retrieving analytics data for the world map gateway location view docid\ al8gmecutfpz6qlw5cwfp retrieving data for the world map users view, see retrieving analytics data for the world map users view docid\ al8gmecutfpz6qlw5cwfp retrieving data for the sankey chart view, see retrieving analytics data for the sankey chart view docid\ al8gmecutfpz6qlw5cwfp retrieving data for the top active gateways chart, see retrieving analytics data for the top active gateways chart docid\ al8gmecutfpz6qlw5cwfp retrieving data for the top active applications chart, see retrieving analytics data for the top active applications chart docid\ al8gmecutfpz6qlw5cwfp retrieving data for the top active user locations chart, see retrieving analytics data for the top active user locations chart docid\ al8gmecutfpz6qlw5cwfp retrieving data for the active anomalies chart, see retrieving analytics data for the active anomalies chart docid\ al8gmecutfpz6qlw5cwfp retrieving data for the connected clients version chart, see retrieving analytics data for the connected clients version chart docid\ al8gmecutfpz6qlw5cwfp retrieving data for the non compliances chart, see retrieving analytics data for the non compliances chart docid\ al8gmecutfpz6qlw5cwfp retrieving data for the gateways info panel, see retrieving analytics data for the gateways info panel docid\ al8gmecutfpz6qlw5cwfp retrieving data for the users info panel, see retrieving analytics data for the users info panel docid\ al8gmecutfpz6qlw5cwfp retrieving data for the devices info panel, see retrieving analytics data for the devices info panel docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications info panel, see retrieving analytics data for the applications info panel docid\ al8gmecutfpz6qlw5cwfp retrieving data for the non compliances info panel, see retrieving analytics data for the non compliances info panel docid\ al8gmecutfpz6qlw5cwfp retrieving data for the anomalies info panel, see retrieving analytics data for the anomalies info panel docid\ al8gmecutfpz6qlw5cwfp the analytics resource also provides the following logs activity retrieving log data, see retrieving log data docid\ al8gmecutfpz6qlw5cwfp the analytics resource also provides the following gateways activity retrieving gateway metrics, see retrieving aggregated gateway statistics docid\ al8gmecutfpz6qlw5cwfp retrieving data for the admin notifications, see retrieving admin notifications docid\ al8gmecutfpz6qlw5cwfp retrieving data for the alerts, see retrieving alerts docid\ al8gmecutfpz6qlw5cwfp retrieving data for the ddr, see retrieving ddr data docid\ al8gmecutfpz6qlw5cwfp retrieving data for the filter, see retrieving filter docid\ al8gmecutfpz6qlw5cwfp retrieving data for the application access summary, see retrieving application access summary docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications by type, see retrieving applications by type docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications by protocol, see retrieving applications by protocol docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications by policy name, see retrieving applications by policy name docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications access trend, see retrieving applications access trend docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications by app group, see retrieving applications by app group docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications by location, see retrieving applications by location docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications by device type, see retrieving applications by device type docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications by not reachable, see retrieving applications by not reachable docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications health details, see retrieving applications health details docid\ al8gmecutfpz6qlw5cwfp retrieving data for the application access by device type, see retrieving application access by device type docid\ al8gmecutfpz6qlw5cwfp retrieving data for the application access by user group, see retrieving application access by user group docid\ al8gmecutfpz6qlw5cwfp retrieving data for the application access by user location, see retrieving application access by user location docid\ al8gmecutfpz6qlw5cwfp retrieving data for the application access trend, see retrieving application access trend docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications list, see retrieving applications list docid\ al8gmecutfpz6qlw5cwfp retrieving data for the applications details, see retrieving applications details docid\ al8gmecutfpz6qlw5cwfp 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 docid\ al8gmecutfpz6qlw5cwfp ) containing date/time period selection, and optional filter for gateway selection if processed correctly, a json body containing the analytics/summary entity is returned otherwise, a json body containing an error is returned 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 1580515200start 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 activedetails 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 ztatype of the gateway enum \[ zta, pcs, pps, vtm ] overlay filter type string example non compliance usersdashboard overlay text filter typeenum \[ 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 usedgateway 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 http/1 1 200 ok content type application/json response body { \[ { "actual value" 3, "description" "active users", "line graph color" "green", "line graph data" \[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 3 ], "name" "users", "status" 0, "total value" 1000, "trend delta" 3, "trend direction" "up" }, { "actual value" 3, "description" "active devices", "line graph color" "green", "line graph data" \[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 3 ], "name" "devices", "status" 100, "total value" 13, "trend delta" 3, "trend direction" "up" }, { "actual value" 2, "description" "active gateways", "line graph color" "green", "line graph data" \[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 2 ], "name" "gateways", "status" 0, "total value" 6, "trend delta" 2, "trend direction" "up" }, { "actual value" 7, "description" "active applications", "line graph color" "green", "line graph data" \[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3, 4 ], "name" "applications", "status" 0, "total value" 43, "trend delta" 7, "trend direction" "up" }, { "actual value" 3, "description" "non compliances", "line graph color" "red", "line graph data" \[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 3 ], "name" "non compliance", "status" 100, "total value" 3, "trend delta" 3, "trend direction" "up" }, { "actual value" 13, "description" "anomalies count", "line graph color" "red", "line graph data" \[ 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 5, 0, 0, 0, 0, 4, 2, 0, 0, 0, 0, 0, 1, 0 ], "name" "anomalies", "status" 100, "total value" 13, "trend delta" 0, "trend direction" "flat" } ] } 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 http/1 1 200 ok content type application/json response body { "response type" "string", "bubble items" \[ { "status" 73, "granularity" "city", "city" "austin", "country" "usa", "continent" "north america", "latitude" 48 5, "longitude" 71 923, "num gws good" 1, "num gws warning" 1, "num gws critical" 1, "num gws offline" 1, "active users" {}, "active devices" {}, "active gateways" {}, "active applications" {}, "num deviations" {}, "non compliance count" {}, "critical errors" {}, "id" "austin", "user location bubble items" \[ { "id" "bengaluru", "city" "bengaluru", "latitude" 48 5, "longitude" 71 923, "num active users" 10 "num non compliance users" 0 } ] } ] } 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 http/1 1 200 ok content type application/json response body { "count" 10, "bubble items" \[ { "granularity" "city", "city" "austin", "country" "usa", "continent" "north america", "bubble color" "green", "latitude" 48 5, "longitude" 71 923, "avg risk score" { "count" 9, "color" "green" }, "num active users" 176, "num high risk users" 21, "num moderate risk users" 9, "num low risk users" 3, "num no risk users" 0 } ] } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "applications list" \[], "device types to gateway names" \[ { "source" "windows", "target" "blackthorn bng 2", "value" 12 }, { "source" "windows", "target" "az bkthrn eastus", "value" 4 } ], "gateway names to application names" \[ { "source" "blackthorn bng 2", "target" "amazon", "value" 4 }, { "source" "blackthorn bng 2", "target" "atlassian", "value" 3 }, { "source" "blackthorn bng 2", "target" "bngvc bnglab psecure net", "value" 3 }, { "source" "az bkthrn eastus", "target" "juniper net", "value" 3 }, { "source" "blackthorn bng 2", "target" "rdp", "value" 1 }, { "source" "blackthorn bng 2", "target" "telnetresource ip", "value" 1 }, { "source" "az bkthrn eastus", "target" "community juniper net", "value" 1 } ], "user groups to device types" \[ { "source" "bng group", "target" "windows", "value" 12 }, { "source" "sj group", "target" "windows", "value" 4 } ] } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 gateways chart otherwise, a json body containing an error is returned 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 1580515200the 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 stringnullable trueexample pcsdefault 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 stringexample 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 usersdashboard 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 http/1 1 200 ok content type application/json response body { "gateways" \[ { "name" "blackthorn bng 2", "value" 2 }, { "name" "az bkthrn eastus", "value" 1 } ], "title" "top gateways" } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "applications" \[ { "name" "amazon", "value" 1 }, { "name" "atlassian", "value" 1 }, { "name" "bngvc bnglab psecure net", "value" 1 }, { "name" "juniper net", "value" 1 }, { "name" "community juniper net", "value" 1 }, { "name" "rdp", "value" 1 }, { "name" "telnetresource ip", "value" 1 } ], "title" "top applications" } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "title" "top user access locations", "user access locations" \[ { "name" "bengaluru", "value" 2 }, { "name" "united states", "value" 1 } ] } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "buckets" \[ { "name" "business hours", "value" 8 }, { "name" "geolocation", "value" 5 } ], "chart timestamp" 1648119483, "title" "anomalies" } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "chart timestamp" 1648119483, "connected devices" \[ { "type" "windows", "values" \[ { "count" 2, "name" "9 1 14 14887" }, { "count" 1, "name" "9 1 12 8219" } ] } ], "title" "pulse client versions" } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "chart timestamp" 1648119483, "non compliance policies" \[ { "name" "antivirus", "value" 1 }, { "name" "commonpolicy", "value" 1 }, { "name" "symantecavlow", "value" 1 } ], "title" "non compliance" } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "info panel items" \[ { "id" "feicie cneineoic nfeie 32he", "gateway name" "eng mkn gw 1", "city name" "bangalore", "overall color" "green", "gateway status" "active", "number of issues" 10, "cpu line graph data" "string", "memory line graph data" "string", "disk used line graph data" "string", "active users count" 10, "active devices count" 10, "active sessions count" 10, "active applications count" 10, "non compliance count" 10, "issues highest severity" "critical", "issues details" \[ { "message id" "ntp12456", "raw message" "ntp server is not reachable", "issue timestamp" 3848462926, "number of issues" 23 } ], "system uptime" 10748, "last config update timestamp" 1063264, "ssl sessions count" 10, "auth only sessions count" 10, "active sync device count" 10, "is node part of cluster" true, "cluster properties" { "cluster id" "9ccf22b9fe9ccf22b9fe", "cluster name" "coagroup", "cluster type" "active/active", "cluster node type" "active", "cluster member type" "leader", "is vip owner" false, "is node reachable" true, "is node enabled" false } } ], "count" 10, "all gateway count" 10, "active gateway count" 5, "offline gateway count" 5, "online gateway count" 5, "unregistered gateway count" 5 } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "info panel items" \[ { "user name" "user1", "timestamp" 1580515200, "user risk score" 256, "non compliance count" 25, "anomalies count" 50, "activity deviation count" 25, "user icon color" "red", "device location city" "austin" } ], "count" 10, "total" 20 } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "info panel items" \[ { "nvt items" \[ { "name" "active users count", "trend" "flat", "value" 2 }, { "name" "active applications count", "trend" "flat", "value" 7 }, { "name" "devices count", "trend" "flat", "value" 2 }, { "name" "non compliance count", "trend" "flat", "value" 3 }, { "name" "deviations count", "trend" "flat", "value" 0 } ], "status" 100, "sub title" "", "title" "windows" } ] } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "info panel items" \[ { "nvt items" \[ { "name" "active users count", "trend" "flat", "value" 1 }, { "name" "active applications count", "trend" "flat", "value" 1 }, { "name" "devices count", "trend" "flat", "value" 1 }, { "name" "application type", "trend" "flat", "value" 0 }, { "name" "application port", "trend" "flat", "value" 443 }, { "name" "non compliance count", "trend" "flat", "value" 0 }, { "name" "deviations count", "trend" "flat", "value" 0 } ], "status" 0, "sub title" "", "title" "pulsesecure net" }, { "nvt items" \[ { "name" "active users count", "trend" "flat", "value" 1 }, { "name" "active applications count", "trend" "flat", "value" 1 }, { "name" "devices count", "trend" "flat", "value" 1 }, { "name" "application type", "trend" "flat", "value" 0 }, { "name" "application port", "trend" "flat", "value" 443 }, { "name" "non compliance count", "trend" "flat", "value" 0 }, { "name" "deviations count", "trend" "flat", "value" 0 } ], "status" 0, "sub title" "", "title" "community juniper net" }, ] } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response body { "count" 3, "info panel items" \[ { "application name" "zendesk", "device id" "b71af79efc6c43b2b7e9da58071a23da", "device type" "windows", "non compliance policy name" "networkpolicy", "non compliance policy types list" \[ "network" ], "timestamp" 1648532547, "user name" "cambridgetest1" }, { "application name" "salesforce", "device id" "a1ee1dc5ee5e4263abaf91599f9dc595", "device type" "windows", "non compliance policy name" "symantecavhigh", "non compliance policy types list" \[ "hc" ], "timestamp" 1648532503, "user name" "sjtest1" }, { "application name" "box", "device id" "a1ee1dc5ee5e4263abaf91599f9dc595", "device type" "windows", "non compliance policy name" "commonpolicy", "non compliance policy types list" \[ "network", "hc" ], "timestamp" 1648532497, "user name" "sjtest1" } ], "total" 3 } 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 docid\ al8gmecutfpz6qlw5cwfp ) 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 anomalies info panel otherwise, a json body containing an error is returned 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 http/1 1 200 ok content type application/json response body { "info panel items" \[ { "anomaly type" "geonewlocation", "user name" "john smith", "timestamp" 1587972453, "device id" "27178d97948d46c09c205d30e9cf2afe", "session id" "9ccf22b9fe", "device type" "windows", "anomaly reason" "non familiar user location ", "anomaly id" "e4abbb38ce8d4619891e561cedb7c807", "acknowledged" true, "active session" true, "browser" "google chrome", "locations history" \[ { "location name" "bangalore", "timestamp" 1580515200 } ], "current location" "bangalore" }, {}, { "anomaly type" "geonewlocation", "user name" "john smith", "timestamp" 1587972453, "device id" "27178d97948d46c09c205d30e9cf2afe", "session id" "9ccf22b9fe", "device type" "windows", "anomaly reason" "non familiar user location ", "anomaly id" "e4abbb38ce8d4619891e561cedb7c807", "acknowledged" true, "active session" true, "browser" "google chrome", "application names" \[ "microsoft", "facebook" ], "details" "normal access hours range of user is between 9 a m to 5 p m " } ], "count" 20, "total" 20 } 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 docid\ al8gmecutfpz6qlw5cwfp ), containing log selection criteria if processed correctly, a json body is returned that contains log data otherwise, a json body containing an error is returned schema the logrequestentity schema entity contains the following fields name string example filter1name to be used start time es integer example 1576533928start time for logs in seconds since epoch by default start of current day end time es integer example 1576533928end time for logs in seconds since epoch by default current time i e now current time integerexample 1576533928current 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 http/1 1 200 ok content type application/json response body { "total" 1000, "count" 10, "offset" 0, "log lines" \[ { "timestamp" 1576533928, "message id" "adm24682", "gateway id" "123e4567 e89b 12d3 a456 426655440000", "gateway name" "azure gateway 1", "severity" "info", "source ip" "127 0 0 1", "raw message" "primary authentication successful for admindb/sdp admin auth from\n172 21 8 171\n", "user name" "testuser1", "user group" "testgroup1", "session id" "fa0726e89c", "device id" "965c34ba98c94f4eae6f2d8564e6ceac", "application name" "jira abc com", "application group names" \[ \[ "group 1", "group 2" ] ], "application protocol" "https", "application protocol display name" "web", "application discovered" false, "application type" "url", "application status" "green", "application connection broker" "auto pcs com", "application desktop protocol" "ssh", "application host" "auto pcs com", "application ip" "1 2 3 4", "application url" "www gmail com", "application location city" "bengaluru", "application bookmark type" "admin defined", "non compliance policy name" "jira access policy", "non compliance policy types list" \[ \[ "location", "hc" ] ], "message type" "anomaly", "sub message type" "anomaly", "pulse client version" "2021 12 1", "device type" "windows", "device os type" "windows 10 pro", "device location city" "mumbai", "user risk score" 10 23, "user risk score category" "high", "user alerts count" 13, "user anomalies count" 10, "user activity deviations count" 5, "acknowledged" true, "session type" "local", "adaptive auth reason" "new location", "controller" true, "is session active" true, "session duration" "2 20 00", "bandwidth consumed" 1024, "bandwidth consumed str" "1 00 kb", "connected time" "2 10 30", "role names" \[ \[ "role 1", "role 2" ] ], "session created timestamp" 1576533928, "browser" "google chrome", "gateway status" "online", "gateway version" "21 x build 1", "esap version" "21 x build 1", "cpu" 26 75, "physical memory" 18 25, "swap memory" 20 9, "disk used percentage" 34 5, "throughput value" 67, "avg cpu" 26 75, "avg memory" 18 25, "avg disk" 34 5, "avg throughput" 67, "max concurrent user licenses consumed" 200 } ] } 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 http/1 1 200 ok content type application/json response body { "status" { "data points" 0, "offset" 0, "agg type" "sum", "gateway ids" \[ "string" ] }, "chart data" \[ { "cpu" 23, "file hits" 32, "web hits" 13, "swap memory" 33, "physical memory" 56, "ssl connections" 3423, "in in throughput bps" 1334, "in out throughput bps" 423423, "ext in throughput bps" 423423, "ext out throughput bps" 423423, "mul in throughput bps" 423423, "mul out throughput bps" 423423, "concurrent users sessions" 4213, "concurrent users vpn sessions" 4213, "disk used percentage" 56, "timestamp es" 0 } ] } retrieving admin notifications to retrieve admin notifications, use the rest api call below method get api/v1/analytics/admin notifications resource path json data none if processed correctly, a json body containing a admin notifications resource is returned otherwise, a json body containing an error is returned parameters current time (integer in query) current time of aggregation since epoch in seconds gateway type (string in query) type of the gateway request the following is an example request curl x 'get' \\ 'api/v1/analytics/admin notifications/list?current time=1576535635\&gateway type=zta' \\ h 'accept application/json' response the following is an example response { "admin name" "john", "last login time" 1576533928, "all notifications" \[ { "day timestamp" 1576533928, "day notifications" \[ { "config element type" "user role", "config element name" "engineering role", "config element operation" "modified", "number of gateways" 3 } ] } ] } retrieving alerts to retrieve alerts, use the rest api call below method get /api/v1/analytics/alerts resource path json data none if processed correctly, a json body containing a alerts resource is returned otherwise, a json body containing an error is returned parameters 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 current time (integer in query) current time of aggregation since epoch in seconds time duration type (string in query) details of what unit of time duration need to be considered for the data available values last 1 day, last 7 days, last 15 days, last 30 days offset (integer in query) start offsets for alerts, default is 0 limit (integer in query) number of alerts to be returned by the query source type (string in query) field used for filtering by source type sort by (string in query) field used for sorting logs by default time stamp order (string in query) oder of sorting specified by sortby field severities (string in query) severity filter for selecting alerts based on severity types (array\[ string ] in query) types filter for selecting alerts based on type(s) columns (array\[ string ] in query) selects columns to be returned by query response request the following is an example request curl x 'get' \\ 'api/v1/analytics/alerts/list?start time es=1576533928\&end time es=1576535635\&current time=1576535635\&time duration type=last 1 day\&offset=0\&limit=100\&source type=pzt gateway\&sort by=timestamp\&order=desc\&severities=information\&types=gateway%20upgrade\&columns=severity\&columns=timestamp\&columns=type\&columns=target\&columns=message type\&columns=source name' \\ h 'accept application/json' response the following is an example response { "total" 0, "items" \[ { "severity" "string", "timestamp" 1576533928, "type" "gateway upgrade", "target" "pztgateway", "source name" "my pcs gateway", "message type" "the gateway upgrade completed" } ] } retrieving ddr data to retrieve ddr data, use the rest api call below method get api/v1/analytics/ddr resource path json data none if processed correctly, a json body containing a ddr resource is returned otherwise, a json body containing an error is returned parameters offset (integer in query) start offsets for devices, default is 0 limit (integer in query) number of devices to be returned by the query, default is 100 sort by (string in query) field used for sorting device details by default last seen order (string in query) oder of sorting specified by sort by field request the following is an example request curl x 'get' \\ 'api/v1/analytics/ddr/table?offset=0\&limit=100\&sort by=last seen\&order=desc' \\ h 'accept application/json' response the following is an example response { "total" 1000, "count" 10, "offset" 0, "device details" 0 } retrieving filter to retrieve list of values of the requested type satisfying the requested search, use the rest api call below method get /api/v1/analytics/filter suggestions resource path json data none if processed correctly, a json body containing a filter suggestions resource is returned otherwise, a json body containing an error is returned parameters search (string in query) search to filter the list of filter values filter type (string in query) type of values desired request the following is an example request curl x 'get' \\ 'api/v1/analytics/filter suggestions/list?search=al\&filter type=user group' \\ h 'accept application/json' response the following is an example response \[ \[ "alice", "bob" ] ] retrieving application access summary to retrieve table summary details of applications accessed, use the rest api call below method get api/v1/analytics/applications/summary table resource path json data none if processed correctly, a json body containing a summary table resource is returned otherwise, a json body containing an error is returned parameters 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 current time (integer in query) current time of aggregation since epoch in seconds time duration type (string in query) details of what unit of time duration need to be considered for the data offset (integer in query) start offsets for alerts, default is 0 limit (integer in query) number of alerts to be returned by the query sort by (string in query) field used for sorting logs by default time stamp order (string in query) oder of sorting specified by sortby field application names (array\[ string ] in query) application name filter, for selecting logs based on application name(s) gateway names (array\[ string ] in query) gateway name filter, for selecting logs based on gateway name(s) user names (array\[ string ] in query) user name filter, for selecting logs based on user name(s) user locations (array\[ string ] in query) user location based filter, for selecting logs based on user location(s) device ids (array\[ string ] in query) device id based filter, for selecting logs based on device id(s) device types (array\[ string ] in query) device type based filter, for selecting logs based on device type(s) non compliance policy names (array\[ string ] in query) name of the policy which marked the access as non compliance user groups (array\[ string ] in query) user group filter, for selecting logs based on user group(s) columns (array\[ string ] in query) selects columns to be returned by query response request the following is an example request curl x 'get' \\ 'api/v1/analytics/applications/summary table?start time es=1576533928\&end time es=1576535635\&current time=1576535635\&offset=0\&limit=100\&sort by=application name\&order=asc\&application names=salesforce\&gateway names=pztgateway\&user names=system\&user locations=bangalore\&device ids=965c34ba98c94f4eae6f2d8564e6ceac\&device types=windows\&non compliance policy names=symantec%20av%20policy\&user groups=engineering\&columns=application id\&columns=application name\&columns=application port\&columns=application type\&columns=application protocol\&columns=application protocol display name\&columns=gateway name\&columns=users count\&columns=devices count\&columns=locations count\&columns=access count\&columns=non compliance count' \\ h 'accept application/json' response the following is an example response { "total" 0, "items" \[ { "application id" "1e089202204743639b68864584d5af8a", "application name" "salesforce", "application port" 80, "application type" "fqdn", "application protocol" "https", "application protocol display name" "web", "gateway name" "pztgateway", "users count" 5, "devices count" 10, "locations count" 8, "access count" 20, "non compliance count" 4, "application discovered" false } ] } retrieving applications by type to retrieve count for application type chart using filters object as input, use the rest api call below method post api/v1/analytics/applications/applications by type resource path json data none if processed correctly, a json body containing a applications by type resource is returned otherwise, a json body containing an error is returned parameters apps details (string in query) flag capturing whether to return all apps or discovered apps details request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/applications by type?apps details=all' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response list of datapoints to be shown in application type chart retrieving applications by protocol to retrieve count for application protocol chart using filters object as input, use the rest api call below method post https //editor swagger io/api/v1/analytics/applications/applications by protocol resource path json data none if processed correctly, a json body containing a applications by protocol resource is returned otherwise, a json body containing an error is returned parameters count (integer in query) number of top application protocol access counts for which data is needed passing ' 1' will return data for all application protocol access details apps details (string in query) flag capturing whether to return all apps or discovered apps details request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/applications by protocol?count=8\&apps details=all' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response list of datapoints to be shown in application protocol chart retrieving applications by policy name to retrieve count for application policy name chart using filters object as input, use the rest api call below method post api/v1/analytics/applications/applications by policy name resource path json data none if processed correctly, a json body containing a applications by policy name resource is returned otherwise, a json body containing an error is returned parameters count (integer in query) number of top application policy names counts for which data is needed passing ' 1' will return data for all application policy names details apps details (string in query) flag capturing whether to return all apps or discovered apps details request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/applications by policy name?count=8\&apps details=all' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response list of datapoints to be shown in application policy name chart retrieving applications access trend to retrieve top n number of applications access trend using filters object as input, use the rest api call below method post api/v1/analytics/applications/applications access trend resource path json data none if processed correctly, a json body containing a applications access trend resource is returned otherwise, a json body containing an error is returned parameters count (integer in query) number of applications to be considered for returning access trend passing ' 1' will return data for all applications access trend bar graph (query) type of bar graph to be shown in access trend chart apps details (string in query) flag capturing whether to return all apps or discovered apps details request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/applications access trend?count=10\&apps details=all' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response data points to be shown in access trend chart retrieving applications by app group to retrieve counts for applications by app group chart using filters object as input, use the rest api call below method post api/v1/analytics/applications/applications access trend resource path json data none if processed correctly, a json body containing a applications access trend resource is returned otherwise, a json body containing an error is returned parameters count (integer in query) number of top application accessed by app group for which data is needed passing ' 1' will return data for all applications accessed by app group details apps details (string in query) flag capturing whether to return all apps or discovered apps details request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/applications by app group?count=8\&apps details=all' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response list of datapoints to be shown in applications by app group chart retrieving applications by location to retrieve counts for applications by location chart using filters object as input, use the rest api call below method post api/v1/analytics/applications/applications by location resource path json data none if processed correctly, a json body containing a applications by location resource is returned otherwise, a json body containing an error is returned parameters count (integer in query) number of top application accessed by location for which data is needed passing ' 1' will return data for all applications accessed by location details apps details (string in query) flag capturing whether to return all apps or discovered apps details request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/applications by location?count=8\&apps details=all' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response list of datapoints to be shown in applications by location chart retrieving applications by device type to retrieve counts for applications by device type chart using filters object as input, use the rest api call below method postapi/v1/analytics/applications/applications by device type resource path json data none if processed correctly, a json body containing a applications by device type resource is returned otherwise, a json body containing an error is returned parameters count (integer in query) number of top application accessed by device type for which data is needed passing ' 1' will return data for all applications accessed by device type details apps details (string in query) flag capturing whether to return all apps or discovered apps details request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/applications by device type?count=8\&apps details=all' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response list of datapoints to be shown in applications by device type chart retrieving applications by not reachable to retrieve counts for applications by not reachable chart using filters object as input, use the rest api call below method postapi/v1/analytics/applications/applications by not reachable resource path json data none if processed correctly, a json body containing a applications by not reachable resource is returned otherwise, a json body containing an error is returned parameters count (integer in query) number of top not reachable applications for which data is needed passing ' 1' will return data for all not reachable applications apps details (string in query) flag capturing whether to return all apps or discovered apps details request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/applications by not reachable?count=8\&apps details=all' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response list of datapoints to be shown in not reachable applications chart retrieving applications health details to retrieve health details of the applications, use the rest api call below method get api/v1/analytics/applications/health details resource path json data none if processed correctly, a json body containing a health details resource is returned otherwise, a json body containing an error is returned parameters application ids (string in query) app ids request the following is an example request curl x 'get' \\ 'api/v1/analytics/applications/health details' \\ h 'accept application/json' response the following is an example response { "count" 1, "details" \[ { "application id" "1e089202204743639b68864584d5af8a", "application name" "ztaapplication", "health status" "grey", "messages" \[ "application is reachable", "application is not reachable" ] } ] } retrieving application access by device type to retrieve counts for application access by device type chart on application l3 page using filters object as input (including application name), use the rest api call below method post api/v1/analytics/applications/application access by device type resource path json data none if processed correctly, a json body containing a application access by device type resource is returned otherwise, a json body containing an error is returned parameters count (integer in query) number of top application accessed by device type for which data is needed passing ' 1' will return data for all applications accessed by device type details request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/application access by device type?count=10' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response list of datapoints to be shown in applications accesses by device type chart retrieving application access by user group to retrieve counts for application access by user group chart using filters object as input (including application name), use the rest api call below method post api/v1/analytics/applications/application access by user resource path json data none if processed correctly, a json body containing a application access by user resource is returned otherwise, a json body containing an error is returned request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/application access by user' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response list of datapoints to be shown in applications accesses by user group chart retrieving application access by user location to retrieve counts for application access by user location chart using filters object as input (including application name), use the rest api call below method post api/v1/analytics/applications/application access by user location resource path json data none if processed correctly, a json body containing a application access by user location resource is returned otherwise, a json body containing an error is returned request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/application access by user location' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response list of datapoints to be shown in applications accesses by user location chart retrieving application access trend to retrieve application access trend using filters object as input (including application name), use the rest api call below method post api/v1/analytics/applications/application access trend resource path json data none if processed correctly, a json body containing a application access trend resource is returned otherwise, a json body containing an error is returned request the following is an example request curl x 'post' \\ 'api/v1/analytics/applications/application access trend' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '"string"' response the following is an example response { "chart timestamp" 1580515200, "title" "application access trend", "access chart data" \[ "string" ] } retrieving applications list to retrieve list of applications, whose name starts with the given prefix, use the rest api call below method get api/v1/analytics/applications/applications list resource path json data none if processed correctly, a json body containing a applications list resource is returned otherwise, a json body containing an error is returned parameters prefix (string in query) prefix of the application name request the following is an example request curl x 'get' \\ 'api/v1/analytics/applications/applications list?prefix=mkn' \\ h 'accept application/json' response the following is an example response { "applications list" \[ \[ "app1", "app2", "app3" ] ] } retrieving applications details to retrieve details of user for given application name, use the rest api call below method get api/v1/analytics/applications/application details resource path json data none if processed correctly, a json body containing a application details resource is returned otherwise, a json body containing an error is returned parameters name (string in query) name of the application request the following is an example request curl x 'get' \\ 'api/v1/analytics/applications/application details?name=salesforce' \\ h 'accept application/json' response the following is an example response { "name" "zta application " } 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 docid\ al8gmecutfpz6qlw5cwfp editing an application, see editing an application docid\ al8gmecutfpz6qlw5cwfp the resources entity is also used to represent a nzta user policy this is enabled by a type of "sign in", see user policies (resources docid\ al8gmecutfpz6qlw5cwfp ) 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 http/1 1 200 ok content type application/json response 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 example com", "icon" "/admin/static/media/filename svg" }, "saml config" { "sp metadata" "string" } } } editing an application to edit an application resources entity, use the rest api call below method put /api/v1/policies/resources/ 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 http/1 1 200 ok content type application/json response 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 example com", "icon" "/admin/static/media/filename svg" }, "saml config" { "sp metadata" "string" } } } authentication server (auth servers) the auth servers entity represents a nzta authentication server authentication servers support the following activities retrieving all authentication servers, see retrieving all authentication servers docid\ al8gmecutfpz6qlw5cwfp creating a local authentication server, see creating a local authentication server docid\ al8gmecutfpz6qlw5cwfp creating a saml authentication server, see creating a saml authentication server docid\ al8gmecutfpz6qlw5cwfp 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 content type application/json response the following is an example response http/1 1 200 ok content type application/json response body { "total" 0, "auth servers" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "type" "local", "name" "string" }, { "id" "2c963f64 5717 4562 b3fc 2c963f66afa6", "type" "local", "name" "string" }, { "id" "66afa664 5717 4562 b3fc 2c963f66afa6", "type" "local", "name" "string" }, { "id" "63f66a64 5717 4562 b3fc 2c963f66afa6", "type" "local", "name" "string" } ] } 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "type" "local", "name" "string", "cert config" { "user name template" "string" }, "samlsp config" { "metadata config type" "url", "metadata config url" "string", "idp type" "azure ad", "idp metadata xml" "string" } } 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 http/1 1 200 ok content type application/json response body { "id" "ab45c43278b42312f00fab4321af54c0543b", "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", } } device policies (device policy/groups) the device policy/groups entity represents a nzta device policy configuration hostchecker levels must be created and configured before device policies can be created successfully, see hostchecker levels (hostchecker/levels) docid\ al8gmecutfpz6qlw5cwfp device policies support the following activities retrieving all device policies, see retrieving all device policies docid\ al8gmecutfpz6qlw5cwfp retrieving a specific device policy, see retrieving a specific device policy docid\ al8gmecutfpz6qlw5cwfp creating a device policy, see creating a device policy docid\ al8gmecutfpz6qlw5cwfp editing a device policy, see editing a device policy docid\ al8gmecutfpz6qlw5cwfp deleting a device policy, see deleting a device policy docid\ al8gmecutfpz6qlw5cwfp 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 http/1 1 200 ok content type application/json response body { "items" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "description" "string", "is default" true, "rules" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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", "hostchecker level name" "string", "hostchecker product list" { "windows" { "products" \[ "string" ], "vendors" \[ "string" ] }, "mac" { "products" \[ "string" ], "vendors" \[ "string" ] } }, "user settings" { "hdd encryption settings" { "encrypt drives" \[ "string" ] } } }, "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" ] } } }, "allow delete" true, "is default" true } ] } ] } 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/ 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "description" "string", "is default" true, "rules" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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", "hostchecker level name" "string", "hostchecker product list" { "windows" { "products" \[ "string" ], "vendors" \[ "string" ] }, "mac" { "products" \[ "string" ], "vendors" \[ "string" ] } }, "user settings" { "hdd encryption settings" { "encrypt drives" \[ "string" ] } } }, "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" ] } } }, "allow delete" true, "is default" true } ] } 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "description" "string", "is default" true, "rule names" \[ "string" ], "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" } 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/ 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "description" "string", "is default" true, "rules" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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", "hostchecker level name" "string", "hostchecker product list" { "windows" { "products" \[ "string" ], "vendors" \[ "string" ] }, "mac" { "products" \[ "string" ], "vendors" \[ "string" ] } }, "user settings" { "hdd encryption settings" { "encrypt drives" \[ "string" ] } } }, "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" ] } } }, "allow delete" true, "is default" true } ] } 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/ 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 http/1 1 204 device policy/groups deleted successfully content type application/json 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 docid\ al8gmecutfpz6qlw5cwfp retrieving a specific device policy rule, see retrieving a specific device policy rule docid\ al8gmecutfpz6qlw5cwfp creating a device policy rule, see creating a device policy rule docid\ al8gmecutfpz6qlw5cwfp editing a device policy rule, see editing a device policy rule docid\ al8gmecutfpz6qlw5cwfp deleting a device policy rule, see deleting a device policy rule docid\ al8gmecutfpz6qlw5cwfp adding a device policy rule to a device policy, see adding a device policy rule to a device policy docid\ al8gmecutfpz6qlw5cwfp removing a device policy rule from a device policy, see removing a device policy rule from a device policy docid\ al8gmecutfpz6qlw5cwfp device rules added or edited through the api are considered custom and do not use the "security level" field this field applies only to built in default device rules 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 http/1 1 200 ok content type application/json response body { "items" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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", "hostchecker level name" "string", "hostchecker product list" { "windows" { "products" \[ "string" ], "vendors" \[ "string" ] }, "mac" { "products" \[ "string" ], "vendors" \[ "string" ] } }, "user settings" { "hdd encryption settings" { "encrypt drives" \[ "string" ] } } }, "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" ] } } }, "allow delete" true, "is default" true } ] } 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/ 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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", "hostchecker level name" "string", "hostchecker product list" { "windows" { "products" \[ "string" ], "vendors" \[ "string" ] }, "mac" { "products" \[ "string" ], "vendors" \[ "string" ] } }, "user settings" { "hdd encryption settings" { "encrypt drives" \[ "string" ] } } }, "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" ] } } }, "allow delete" true, "is default" true } 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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", "hostchecker level name" "string", "hostchecker product list" { "windows" { "products" \[ "string" ], "vendors" \[ "string" ] }, "mac" { "products" \[ "string" ], "vendors" \[ "string" ] } }, "user settings" { "hdd encryption settings" { "encrypt drives" \[ "string" ] } } }, "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" ] } } }, "allow delete" true, "is default" true } 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/ 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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", "hostchecker level name" "string", "hostchecker product list" { "windows" { "products" \[ "string" ], "vendors" \[ "string" ] }, "mac" { "products" \[ "string" ], "vendors" \[ "string" ] } }, "user settings" { "hdd encryption settings" { "encrypt drives" \[ "string" ] } } }, "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" ] } } }, "allow delete" true, "is default" true } 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/ 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 http/1 1 204 device policy/rules deleted successfully content type application/json 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/ /rules/ 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 http/1 1 204 rule added to device policy successfully content type application/json 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/ /rules/ 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 http/1 1 204 rule in device policy group deleted successfully content type application/json gateway (gateways) the gateways entity represents a zta gateway gateways support the following activities retrieving all gateways, see retrieving all gateways docid\ al8gmecutfpz6qlw5cwfp creating a gateway, see creating a gateway docid\ al8gmecutfpz6qlw5cwfp editing a gateway, see editing a gateway docid\ al8gmecutfpz6qlw5cwfp deleting a gateway, see deleting a gateway docid\ al8gmecutfpz6qlw5cwfp renewing a client certificate, see renewing a client certificate docid\ al8gmecutfpz6qlw5cwfp 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 http/1 1 200 ok content type application/json response body \[ { "id" "e274bf3ebe3841a88ade1630515624c6", "name" "string", "gateway type" "pzt gateway", "state" "unregistered", "created" "string", "updated" "string", "type" "string", "model" "string", "serial number" "string", "appliance version" "string", "sdp mode" "pzt gateway", "location" { "name" "string", "city id" 0 }, "notification channel status" "online", "orchestration" { "type" "vsphere", "mode" "auto", "state" "waiting to create" }, "external ip" "string", "external fqdn" "string", "public ip" "string", "public ips" \[ "xx xx xx xx" ], "dns cname" "string", "salient task" { "id" "e274bf3ebe3841a88ade1630515624c6", "status" "pending", "type" "system operations appliance task", "group id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "created" "string", "completed" "string" }, "group id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "is ready" true, "actions" \[ "upgrade" ], "auto upgrade" true, "capabilities" \[ "readiness" ] } ] 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 http/1 1 200 ok content type application/json response body { "id" "e274bf3ebe3841a88ade1630515624c6", "name" "test gateway", "state" "unregistered", "sdp mode" "gateway", "notification channel status" "offline", "orchestration" { "type" "vsphere", "mode" "manual" } } editing a gateway to edit a gateways entity, use the rest api call below method put /api/gateways/ 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 http/1 1 200 ok content type application/json response body { "id" "e274bf3ebe3841a88ade1630515624c6", "name" "string", "state" "unregistered", "created" "string", "updated" "string", "type" "string", "model" "string", "serial number" "string", "appliance version" "string", "sdp mode" "pzt gateway", "location" { "name" "string", "city id" 0 }, "notification channel status" "online", "orchestration" { "type" "vsphere", "mode" "auto", "state" "waiting to create" }, "external ip" "string", "external fqdn" "string", "public ip" "string", "salient task" { "id" "e274bf3ebe3841a88ade1630515624c6", "status" "pending", "type" "system operations appliance task", "group id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "created" "string", "completed" "string" }, "group id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "is ready" true, "actions" \[ "upgrade" ], "auto upgrade" true, "capabilities" \[ "readiness" ] } deleting a gateway to delete a gateways entity, use the rest api call below method delete /api/gateways/ 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 http/1 1 204 gateway deleted successfully content type application/json 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 http/1 1 200 ok content type application/json response body { "certificate" "string", "format" "pem" } gateway settings gateway settings are additional properties for a zta gateway gateway settings support the following activities retrieving the settings for a gateway, see retrieving the settings for a gateway docid\ al8gmecutfpz6qlw5cwfp editing the settings for a gateway, see editing settings for a gateway docid\ al8gmecutfpz6qlw5cwfp retrieving the settings for a gateway to retrieve the settings for a gateways entity, use the rest api call below method get /api/gateways/ /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 http/1 1 200 ok content type application/json response 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", "use dhcp" true, "previous version" "string", "updated" "string", "public ip address" "string", "public ip addresses" \[ "10 1 2 3" ], "dns cname" "string" } 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 http/1 1 204 gateway settings updated successfully content type application/json gateway groups (groups) the groups entity represents a zta gateway group gateway groups support the following activities retrieving a gateway groups, see retrieving a gateway groups docid\ al8gmecutfpz6qlw5cwfp creating a gateway group, see creating a gateway group docid\ al8gmecutfpz6qlw5cwfp editing a gateway group, see editing a gateway group docid\ al8gmecutfpz6qlw5cwfp 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 http/1 1 200 ok content type application/json response body { "items" \[ { "name" "asia pacific grp", "description" "gateway group assigned to asia pacific region", "load balancer ips" \[ "10 1 2 3" ], "dns cname" "string", "id" "e274bf3ebe3841a88ade1630515624c6", "external fqdn" "string", "created" "string", "updated" "string", "members" \[ "e274bf3ebe3841a88ade1630515624c6" ], "connected members" \[ "e274bf3ebe3841a88ade1630515624c6" ], "ready members" \[ "e274bf3ebe3841a88ade1630515624c6" ] } ], "total" 10 } 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 http/1 1 200 ok content type application/json response body { "name" "asia pacific grp", "description" "gateway group assigned to asia pacific region", "load balancer ips" \[ "10 1 2 3" ], "dns cname" "string", "id" "e274bf3ebe3841a88ade1630515624c6", "external fqdn" "string", "created" "string", "updated" "string", "members" \[ "e274bf3ebe3841a88ade1630515624c6" ], "connected members" \[ "e274bf3ebe3841a88ade1630515624c6" ], "ready members" \[ "e274bf3ebe3841a88ade1630515624c6" ] } editing a gateway group to edit a gateway group, use the rest api call below method put /api/gateways/groups/ 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 http/1 1 200 ok content type application/json response body { "name" "asia pacific grp", "description" "gateway group assigned to asia pacific region", "load balancer ips" \[ "10 1 2 3" ], "dns cname" "string", "id" "e274bf3ebe3841a88ade1630515624c6", "external fqdn" "string", "created" "string", "updated" "string", "members" \[ "e274bf3ebe3841a88ade1630515624c6" ], "connected members" \[ "e274bf3ebe3841a88ade1630515624c6" ], "ready members" \[ "e274bf3ebe3841a88ade1630515624c6" ] } 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, see retrieving all hostchecker levels docid\ al8gmecutfpz6qlw5cwfp retrieving a specific hostchecker level, see retrieving a specific hostchecker leve docid\ al8gmecutfpz6qlw5cwfp l creating a hostchecker level, see creating a hostchecker level docid\ al8gmecutfpz6qlw5cwfp editing a hostchecker level, see editing a hostchecker level docid\ al8gmecutfpz6qlw5cwfp deleting a hostchecker level, see deleting a hostchecker level docid\ al8gmecutfpz6qlw5cwfp 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 http/1 1 200 ok content type application/json response body { "items" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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 } } } ], "total" 0 } 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/ 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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 } } } 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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 } } } 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/ 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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 } } } 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/ 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 http/1 1 204 hostchecker/levels deleted successfully content type application/json hostchecker products (hostchecker/products) the hostchecker/products entity represents a nzta hostchecker configuration hostchecker products support the following activities retrieving all hostchecker products, see retrieving all hostchecker products docid\ al8gmecutfpz6qlw5cwfp retrieving a specific hostchecker product, see retrieving a specific hostchecker product docid\ al8gmecutfpz6qlw5cwfp creating a hostchecker product, see creating a hostchecker product docid\ al8gmecutfpz6qlw5cwfp editing a hostchecker product, see editing a hostchecker product docid\ al8gmecutfpz6qlw5cwfp deleting a hostchecker product, see deleting a hostchecker product docid\ al8gmecutfpz6qlw5cwfp 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 http/1 1 200 ok content type application/json response body { "items" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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" ] } } } ], "total" 0 } 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/ 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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" ] } } } 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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" ] } } } 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/ 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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" ] } } } 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/ 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 http/1 1 204 hostchecker/products deleted successfully content type application/json 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, see retrieving all resource groups docid\ al8gmecutfpz6qlw5cwfp creating a resource group, see creating a resource group docid\ al8gmecutfpz6qlw5cwfp editing a resource group, see editing a resource group docid\ al8gmecutfpz6qlw5cwfp 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\ content type application/json response the following is an example response { "items" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "type" "sign in", "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" } } ] } ] } 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "type" "sign in", "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" } } } ] } 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "type" "sign in", "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" } } } ] } 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 role map rules, see retrieving all role mapping rules docid\ al8gmecutfpz6qlw5cwfp creating a role mapping rule, see creating a role mapping rule docid\ al8gmecutfpz6qlw5cwfp 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 http/1 1 200 ok content type application/json response body { "items" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "type" "username", "name" "string", "attribute" "string", "value" "string" } ] } 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "type" "username", "name" "string", "attribute" "string", "value" "string" } 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, see retrieving all secure access policies docid\ al8gmecutfpz6qlw5cwfp creating a secure access policy, see creating a secure access policy docid\ al8gmecutfpz6qlw5cwfp 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 http/1 1 200 ok content type application/json response body { "items" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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", "resource config" { "name" "string" }, "resource group config" { "name" "string" }, "device policy config" { "name" "string" }, "user rule group config" { "name" "string", "role config" { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "type" "admin", "name" "string", "redirect url" "string" } } } ] } 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "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", "resource config" { "name" "string" }, "resource group config" { "name" "string" }, "device policy config" { "name" "string" }, "user rule group config" { "name" "string", "role config" { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "type" "admin", "name" "string", "redirect url" "string" } } } 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 details, grouped by log type, see retrieving the enterprise integrations syslog forwarding configuration docid\ al8gmecutfpz6qlw5cwfp creating an enterprise integrations syslog forwarding configuration, see adding enterprise integrations syslog forwarding configuration details docid\ al8gmecutfpz6qlw5cwfp retrieving a list of enterprise integrations syslog forwarding configurations, see retrieving a list of enterprise integrations syslog configurations docid\ al8gmecutfpz6qlw5cwfp retrieving a specific enterprise integrations syslog forwarding configuration, see retrieving a specific enterprise integrations syslog configuration docid\ al8gmecutfpz6qlw5cwfp editing an enterprise integrations syslog forwarding configuration, see editing an enterprise integrations syslog configuration docid\ al8gmecutfpz6qlw5cwfp removing an enterprise integrations syslog forwarding configuration, see removing an enterprise integrations syslog configuration docid\ al8gmecutfpz6qlw5cwfp 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 http/1 1 200 ok content type application/json response body { "access" \[ { "name" "string", "server" "string", "log types" \[ "access" ], "facility" "local0", "protocol" "tls", "certificate id" "3fa85f6457174562b3fc2c963f66afa6", "filter id" "123e4567e89b12d3a456426614174000", "gateway ids" \[ "123e4567e89b12d3a456wr6614175643" ], "proxy gateway id" "123e4567e89b12d3a456wr6614175643", "id" "824411c22bf94e719ea757f8f3fd818e", "filter name" "string", "created" "2021 01 27t00 00 00+00 00", "updated" "2021 01 27t00 00 00+00 00" } ], "admin" \[ { "name" "string", "server" "string", "log types" \[ "access" ], "facility" "local0", "protocol" "tls", "certificate id" "3fa85f6457174562b3fc2c963f66afa6", "filter id" "123e4567e89b12d3a456426614174000", "gateway ids" \[ "123e4567e89b12d3a456wr6614175643" ], "proxy gateway id" "123e4567e89b12d3a456wr6614175643", "id" "824411c22bf94e719ea757f8f3fd818e", "filter name" "string", "created" "2021 01 27t00 00 00+00 00", "updated" "2021 01 27t00 00 00+00 00" } ], "events" \[ { "name" "string", "server" "string", "log types" \[ "access" ], "facility" "local0", "protocol" "tls", "certificate id" "3fa85f6457174562b3fc2c963f66afa6", "filter id" "123e4567e89b12d3a456426614174000", "gateway ids" \[ "123e4567e89b12d3a456wr6614175643" ], "proxy gateway id" "123e4567e89b12d3a456wr6614175643", "id" "824411c22bf94e719ea757f8f3fd818e", "filter name" "string", "created" "2021 01 27t00 00 00+00 00", "updated" "2021 01 27t00 00 00+00 00" } ] } 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 http/1 1 200 ok content type application/json response 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", "id" "824411c22bf94e719ea757f8f3fd818e", "filter name" "string", "created" "2021 01 27t00 00 00+00 00", "updated" "2021 01 27t00 00 00+00 00" } 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 http/1 1 200 ok content type application/json response body { "total" 0, "items" \[ { "name" "string", "server" "string", "log types" \[ "access" ], "facility" "local0", "protocol" "tls", "certificate id" "3fa85f6457174562b3fc2c963f66afa6", "filter id" "123e4567e89b12d3a456426614174000", "gateway ids" \[ "123e4567e89b12d3a456wr6614175643" ], "proxy gateway id" "123e4567e89b12d3a456wr6614175643", "id" "824411c22bf94e719ea757f8f3fd818e", "filter name" "string", "created" "2021 01 27t00 00 00+00 00", "updated" "2021 01 27t00 00 00+00 00" } ] } 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/ 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 http/1 1 200 ok content type application/json response 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", "id" "824411c22bf94e719ea757f8f3fd818e", "filter name" "string", "created" "2021 01 27t00 00 00+00 00", "updated" "2021 01 27t00 00 00+00 00" } editing an enterprise integrations syslog configuration to edit an integrations/syslog entity, use the rest api call below method put /api/integrations/syslog/ 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 http/1 1 200 ok content type application/json response 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", "id" "824411c22bf94e719ea757f8f3fd818e", "filter name" "string", "created" "2021 01 27t00 00 00+00 00", "updated" "2021 01 27t00 00 00+00 00" } removing an enterprise integrations syslog configuration to remove an integrations/syslog entity, use the rest api call below method delete /api/integrations/syslog/ 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 http/1 1 204 no content content type application/json users (users) the users entity represents a nzta user users support the following activities retrieving a user, see retrieving a user docid\ al8gmecutfpz6qlw5cwfp creating a user, see creating a user docid\ al8gmecutfpz6qlw5cwfp retrieving user settings, see retrieving user settings docid\ al8gmecutfpz6qlw5cwfp updating user settings, see updating user settings docid\ al8gmecutfpz6qlw5cwfp 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 http/1 1 200 ok content type application/json response body { "first name" "john", "last name" "doe", "email" "john doe\@example com", "id" "0cd145e28d483a6d57e9d73b6d78b7fe58377950", "username" "john doe", "created" "2020 09 21t00 00 00+00 00", "updated" "2020 09 22t00 00 00+00 00" } 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" "john doe\@example com" } response the following is an example response http/1 1 200 ok content type application/json response body { "first name" "john", "last name" "doe", "email" "john doe\@example com", "id" "0cd145e28d483a6d57e9d73b6d78b7fe58377950", "username" "john doe", "created" "2020 09 21t00 00 00+00 00", "updated" "2020 09 22t00 00 00+00 00" } 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 http/1 1 200 ok content type application/json response body { "version" "785bb486534129fd8ec732a1aa647b02d8e33491", "settings" { "on login" { "show welcome wizard" false } } } 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 http/1 1 200 ok content type application/json response body { "version" "785bb486534129fd8ec732a1aa647b02d8e33491", "settings" { "on login" { "show welcome wizard" false } } } user rule groups (user rule groups) the user rule groups entity represents a nzta user rule group user rule groups support the following activities 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 http/1 1 200 ok content type application/json response body { "items" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "description" "string", "sign in policy 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" }, "role id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "role config" { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "type" "admin", "name" "string", "redirect url" "string" }, "rules" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "type" "username", "attribute" "string", "value" "string" } ] } ] } 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 http/1 1 200 ok content type application/json response body { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "description" "string", "sign in policy 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" }, "role id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "role config" { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "type" "admin", "name" "string", "redirect url" "string" }, "rules" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "type" "username", "attribute" "string", "value" "string" } ] } 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 docid\ al8gmecutfpz6qlw5cwfp editing a user policy, see editing a user policy docid\ al8gmecutfpz6qlw5cwfp the resources entity is also used to represent a nzta application this is enabled by a type of "application", see applications (resources) docid\ al8gmecutfpz6qlw5cwfp 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 http/1 1 200 ok content type application/json response body { "items" \[ { "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" } } } ] } 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/ 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 http/1 1 200 ok content type application/json response body { "total" 0, "count" 0, "items" \[ { "id" "3fa85f64 5717 4562 b3fc 2c963f66afa6", "name" "string", "description" "string", "platform" "windows", "type" "program", "rule action" "allow", "created" "string", "updated" "string", "is default" true, "direction" "inbound", "exception order" 0, "port" { "protocol" "string", "remote port" "string", "local port" "string" }, "program" { "program path" "string", "sha256" "string" }, "custom" { "program path" "string", "sha256" "string", "protocol" "string", "local port" "string", "remote port" "string", "local resource" "string", "remote resource" "string" }, "program path" "string", "protocol" "tcp", "local port" "string", "remote port" "string", "local resource" "string", "remote resource" "string" } ] } mdm server a mdm is a type of server entity that represents a nzta server mdm supports the following activities retrieving all mdm servers, see retrieving all mdm server docid\ al8gmecutfpz6qlw5cwfp create mdm server, see creating a mdm serve docid\ al8gmecutfpz6qlw5cwfp r retrieving mdm servers by id, see retrieving a mdm server by id docid\ al8gmecutfpz6qlw5cwfp editing a mdm server, see editing a mdm server docid\ al8gmecutfpz6qlw5cwfp deleting a mdm server, see deleting a mdm server docid\ al8gmecutfpz6qlw5cwfp retrieving all mdm servers to retrieve mdm servers, use the rest api call below method get /api/v1/policies/mdm servers resource path if processed correctly, a json body containing the mdm server 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 authorization content type application/json response the following is an example response http/1 1 200 ok content type application/json response body { "total" 0, "mdm servers" \[ { "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" }, } ] 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" }, } 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" }, } 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/ 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" }, } 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/ 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" }, } 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" }, } deleting a mdm server to delete a mdm server entity, use the rest api call below method delete /api/v1/policies/mdm servers/ 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 user risk score user risk score apis manages actionable insights configurations user risk score supports the following activities retrieving all user risk score, see retrieving all user risk score docid\ al8gmecutfpz6qlw5cwfp create user risk score, see creating a user risk score docid\ al8gmecutfpz6qlw5cwfp r retrieving user risk score by id, see retrieving a user risk score by id docid\ al8gmecutfpz6qlw5cwfp edit a user risk score, see editing a user risk score docid\ al8gmecutfpz6qlw5cwfp delete a user risk scorer, see deleting a user risk score docid\ al8gmecutfpz6qlw5cwfp retrieving all user risk score to retrieve user risk score, use the rest api call below method get /api/v1/analytics/action configs/user risk score resource path if processed correctly, a json body containing the user risk score entity is returned otherwise, a json body containing an error is returned request the following is an example request curl x 'get' \\ '/api/v1/analytics/action configs/user risk score?gateway type=zta' \\ h 'accept application/json' response the following is an example response { "action rules" \[ { "action type" "allow next login with warning", "action params" { "terminate active sessions" true }, "action threshold" 20, "action id" "8c45a230 857e 4504 879c 3ae8c283993c", "created" 743745, "updated" 743745 } ] creating a user risk score to create a new action rule for metric user risk score, use the rest api call below json data json dictionary representing changed properties for a user risk score entity resource path method post /api/v1/analytics/action configs/user risk score if processed correctly, a json body containing the new user risk score entity is returned otherwise, a json body containing an error is returned request the following is an example request { "action type" "allow next login with warning", "action params" { "terminate active sessions" true }, "action threshold" 20 } response the following is an example response { "action type" "allow next login with warning", "action params" { "terminate active sessions" true }, "action threshold" 20, "action id" "8c45a230 857e 4504 879c 3ae8c283993c", "created" 743745, "updated" 743745 } retrieving a user risk score by id to retrieve a user risk score by id entity, use the rest api call below json data json dictionary representing changed properties for a user risk score by id entity resource path method get/api/v1/analytics/action configs/user risk score/ if processed correctly, a json body containing the user risk score by id entity is returned otherwise, a json body containing an error is returned request the following is an example request curl x 'get' \\ '/api/v1/analytics/action configs/user risk score/e274bf3ebe3841a88ade1630515624c6?gateway type=zta' \\ h 'accept application/json' response the following is an example response { "action type" "allow next login with warning", "action params" { "terminate active sessions" true }, "action threshold" 20, "action id" "8c45a230 857e 4504 879c 3ae8c283993c", "created" 743745, "updated" 743745 } editing a user risk score to edit a user risk score entity, use the rest api call below json data json dictionary representing changed properties for a user risk score entity resource path method put /api/v1/analytics/action configs/user risk score/ if processed correctly, a json body containing the edited user risk score entity is returned otherwise, a json body containing an error is returned request the following is an example request curl x 'put' \\ '/api/v1/analytics/action configs/user risk score/e274bf3ebe3841a88ade1630515624c6?gateway type=zta' \\ h 'accept application/json' \\ h 'content type application/json' \\ d '{ "action type" "allow next login with warning", "action params" { "terminate active sessions" true }, "action threshold" 20, "action id" "8c45a230 857e 4504 879c 3ae8c283993c" }' response the following is an example response { "action type" "allow next login with warning", "action params" { "terminate active sessions" true }, "action threshold" 20, "action id" "8c45a230 857e 4504 879c 3ae8c283993c", "created" 743745, "updated" 743745 } deleting a user risk score to delete a user risk score entity, use the rest api call below method delete /api/v1/analytics/action configs/user risk score/ resource path if processed correctly, a confirmation is returned otherwise, an error is returned request the following is an example request curl x 'delete' \\ '/api/v1/analytics/action configs/user risk score/e274bf3ebe3841a88ade1630515624c6?gateway type=zta' \\ h 'accept / ' response the following is an example response 204 deleted mdm server successfully storage consumption total storage consumption for a tenant request the following is an example request get /api/licenses/subscriptions/storage consumption response the following is an example response { "total bytes" 15, "computed at" "2025 07 29t09 14 24z" } per backend breakdown for a tenant in a cluster request the following is an example request get /api/licenses/tenants/{tenant id}/storage consumption response the following is an example response { "tenant id" 42045, "postgres bytes" 10000, "elasticsearch bytes" 10000, "blobstore bytes" 10000, "total bytes" 30000, "computed at" "2025 07 29t09 14 24z" }