--- title: "NDR RESTful API endpoints" slug: "ndr-restful-api-endpoints" tags: ["Reference", "NDRC 4.x", "Customer", "Network Security", "NDR 4.x"] updated: 2026-09-23T12:30:54Z published: 2026-09-23T12:31:11Z canonical: "docs.trellix.com/ndr-restful-api-endpoints" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.trellix.com/llms.txt > Use this file to discover all available pages before exploring further. # NDR RESTful API endpoints > [!NOTE] > Note > > Changes to this release of the API are listed in the *Network Detection and Response Release Notes*. The following endpoints are available within the NDR API: - Authentication - [Authentication](/network-and-platform/docs/authentication) `POST https://<IA_IP_address>:<port_number>/login` - [Session: Request](/network-and-platform/docs/session-request) `POST https://<IA_IP_address>:<port_number>/session` - [Log Out: Request](/network-and-platform/docs/log-out-request) `POST https://<IA_IP_address>:<port_number>/logout` - Layer-7 metadata - [Layer-7 metadata using GET: Request](/network-and-platform/docs/layer-7-metadata-using-get-request) `GET https://<IA_IP_address>/config/v1/l7metadata` - Elasticsearch - [Elasticsearch information: Request](/network-and-platform/docs/elasticsearch-information-request) `GET https://<IA_IP_address>:<port_number>/elasticsearch` - [Elasticsearch query: Request](/network-and-platform/docs/elasticsearch-query-request) `GET https://<IA_IP_address>:<port_number>/elasticsearch/<Elasticsearch_query>` - Flow summary - [Flow summary using GET: Request](/network-and-platform/docs/flow-summary-using-get-request) `GET https://<IA_IP_address>:<port_number>/flowsummary/v2` - [Flow summary using POST: Request](/network-and-platform/docs/flow-summary-using-post-request) `POST https://<IA_IP_address>:<port_number>/flowsummary/v2` - [Flow summary for a cluster using GET: Request](/network-and-platform/docs/flow-summary-for-a-cluster-using-get-request) `GET https://<IA_IP_address>:<port_number>/flowsummary/v2/<cluster_name>` - [Flow summary for a cluster using POST: Request](/network-and-platform/docs/flow-summary-for-a-cluster-using-post-request) `POST https://<IA_IP_address>:<port_number>/flowsummary/v2/<cluster_name>` - Saved query - [Term lists for a user: Request](/network-and-platform/docs/term-lists-for-a-user-request) `GET https://<IA_IP_address>:<port_number>/savedquery/v1/termlist/<user_name>` - [Delete term lists for a user: Request](/network-and-platform/docs/delete-term-lists-for-a-user-request) `DELETE https://<IA_IP_address>:<port_number>/savedquery/v1/termlist/<user_name>` - [Term list by name: Request](/network-and-platform/docs/term-list-by-name-request) `GET https://<IA_IP_address>:<port_number>/savedquery/v1/termlist/<user_name>/<term_list_name>` - [Create a term list: Request](/network-and-platform/docs/create-a-term-list-request) `PUT https://<IA_IP_address>:<port_number>/savedquery/v1/termlist/<user_name>/<term_list_name>` - [Delete a term list by name: Request](/network-and-platform/docs/delete-a-term-list-by-name-request) `DELETE https://<IA_IP_address>:<port_number>/savedquery/v1/termlist/<user_name>/<term_list_name>` - [Queries for a user: Request](/network-and-platform/docs/queries-for-a-user-request) `GET https://<IA_IP_address>:<port_number>/savedquery/v1/querybody/<user_name>` - [Delete queries for a user: Request](/network-and-platform/docs/delete-queries-for-a-user-request) `DELETE https://<IA_IP_address>:<port_number>/savedquery/v1/querybody/<user_name>` - [Query by name: Request](/network-and-platform/docs/query-by-name-request) `GET https://<IA_IP_address>:<port_number>/savedquery/v1/querybody/<user_name>/<query_body_name>` - [Create a query by name: Request](/network-and-platform/docs/create-a-query-by-name-request) `PUT https://<IA_IP_address>:<port_number>/savedquery/v1/querybody/<user_name>/<query_body_name>` - [Delete a query by name: Request](/network-and-platform/docs/delete-a-query-by-name-request) `DELETE https://<IA_IP_address>:<port_number>/savedquery/v1/querybody/<user_name>/<query_body_name>` - [Query results using GET: Request](/network-and-platform/docs/query-results-using-get-request) `GET https://<IA_IP_address>:<port_number>/savedquery/v1/resolution` - [Query results using POST: Request](/network-and-platform/docs/query-results-using-post-request) `POST https://<IA_IP_address>:<port_number>/savedquery/v1/resolution` - Scheduled search - [Create a scheduled search: Request](/network-and-platform/docs/create-a-scheduled-search-request) `POST https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watch/<user_name>` - [Scheduled search by name: Request](/network-and-platform/docs/scheduled-search-by-name-request) `GET https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watch/<user_name>/<scheduled_search_name>` - [Update a scheduled search by name: Request](/network-and-platform/docs/update-a-scheduled-search-by-name-request) `PUT https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watch/<user_name>/<scheduled_search_name>` - [Delete a scheduled search by name: Request](/network-and-platform/docs/delete-a-scheduled-search-by-name-request) `DELETE https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watch/<user_name>/<scheduled_search_name>` - [Scheduled searches by user: Request](/network-and-platform/docs/scheduled-searches-by-user-request) `GET https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watch/<user_name>` - [Delete scheduled searches by user: Request](/network-and-platform/docs/delete-scheduled-searches-by-user-request) `DELETE https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watch/<user_name>` - [All scheduled searches: Request](/network-and-platform/docs/all-scheduled-searches-request) `DELETE https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watch` - [Delete all scheduled searches: Request](/network-and-platform/docs/delete-all-scheduled-searches-request) `DELETE https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watch` - [Search result reports by user: Request](/network-and-platform/docs/search-result-reports-by-user-request) `GET https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watchreport/<user_name>` - [Delete scheduled searches by user: Request](/network-and-platform/docs/delete-scheduled-searches-by-user-request) `DELETE https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watchreport/<user_name>` - [Search result report by scheduled search: Request](/network-and-platform/docs/search-result-report-by-scheduled-search-request) `GET https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watchreport/<user_name>/<scheduled_search_name>` - [Delete search result reports by scheduled search: Request](/network-and-platform/docs/delete-search-result-reports-by-scheduled-search-request) `DELETE https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watchreport/<user_name>/<scheduled_search_name>` - [Search result report by ID: Request](/network-and-platform/docs/search-result-report-by-id-request) `GET https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watchreport/<user_name>/<scheduled_search_name>/<report_ID>` - [Delete a search result report by ID: Request](/network-and-platform/docs/delete-a-search-result-report-by-id-request) `DELETE https://<IA_IP_address>:<port_number>/scheduledsearch/v1/watchreport/<user_name>/<scheduled_search_name>/<report_ID>` - Statistics - [Cluster names: Request](/network-and-platform/docs/cluster-names-request) `GET https://<IA_IP_address>:<port_number>/stats/v1/elastic/clusters` - [Elasticsearch nodes for a cluster: Request](/network-and-platform/docs/elasticsearch-nodes-for-a-cluster-request) `GET https://<IA_IP_address>:<port_number>/stats/v1/elastic/<cluster_name>/nodes` - [IA hosts for a cluster: Request](/network-and-platform/docs/ndr-hosts-for-a-cluster-request) `GET https://<IA_IP_address>:<port_number>/stats/v1/elastic/<cluster_name>/hosts` - [Status for a cluster: Request](/network-and-platform/docs/status-for-a-cluster-request) `GET https://<IA_IP_address>:<port_number>/stats/v1/elastic/<cluster_name>/clusterstatus` - [Open indices for a cluster: Request](/network-and-platform/docs/open-indices-for-a-cluster-request) `GET https://<IA_IP_address>:<port_number>/stats/v1/elastic/<cluster_name>/openindices` - [System statistics for a host: Request](/network-and-platform/docs/system-statistics-for-a-host-request) `POST https://<IA_IP_address>:<port_number>/stats/v1/systemstats/<cluster_name>/<host_name>` - [Pipeline statistics for a cluster: Request](/network-and-platform/docs/pipeline-statistics-for-a-cluster-request) `POST https://<IA_IP_address>:<port_number>/stats/v1/pipelinestats/<cluster_name>` - [PX hosts for a cluster: Request](/network-and-platform/docs/px-hosts-for-a-cluster-request) `GET https://<IA_IP_address>:<port_number>/stats/v1/pxstats/<cluster_name>/hosts` - [PX host statistics: Request](/network-and-platform/docs/px-host-statistics-request) `POST https://<IA_IP_address>:<port_number>/stats/v1/pxstats/<cluster_name>/host/<PX_node>/<measurement>` - Users - [List users: Request](/network-and-platform/docs/list-users-request) `GET https://<Network Detection and Response_IP_address>/config/v1/users` - [New user: Request](/network-and-platform/docs/new-user-request) `POST https://<Network Detection and Response_IP_address>/config/v1/users` - [User details: Request](/network-and-platform/docs/user-details-request) `GET https://<Network Detection and Response_IP_address>/config/v1/users/<user>` - [Update a user: Request](/network-and-platform/docs/update-a-user-request) `PUT https://<Network Detection and Response_IP_address>/config/v1/users/<user>` - [Remove a user: Request](/network-and-platform/docs/remove-a-user-request) `DELETE https://<Network Detection and Response_IP_address>/config/v1/users/<user>` - Users — cluster setup - [List users: Request](/network-and-platform/docs/list-users-request) ```plaintext GET https:///config/v1/users/forward/ ``` - New user: Request ```plaintext POST https:///config/v1/users ``` - [User details: Request](/network-and-platform/docs/user-details-request) ```plaintext GET https:///config/v1/users// ``` - [Update a user: Request](/network-and-platform/docs/update-a-data-node-user-request) ```plaintext PUT https:///config/v1/users/ ``` - [Remove a user: Request](/network-and-platform/docs/remove-a-data-node-user-request) `DELETE https://<Network Detection and Response_director_node_IP_address>/config/v1/users/<data_node_IP_address>/<user>` - Update - [Upload update file: Request](/network-and-platform/docs/upload-update-file-request) `POST https://<IA_IP_address>/updates/v1` - [Apply update: Request](/network-and-platform/docs/apply-update-request) `POST https://<IA_IP_address>/updates/v1/IA-1.3.2.xxxxx/apply` - VLAN/Q-in-Q based access control - [Enable VBAC: Request](/network-and-platform/docs/enable-vbac-request) `PUT https://<IA_IP_address>:<port_number>/config/v1/rbac/activation?status=<status>` - [VBAC state: Request](/network-and-platform/docs/vbac-state-request) `GET https://<IA_IP_address>:<port_number>/config/v1/rbac/activation` - [VLAN/Q-in-Q mappings: Request](/network-and-platform/docs/vlan-q-in-q-mappings-request) `GET https://<IA_IP_address>:<port_number>/config/v1/rbac/vlan/mappings` - [Delete VLAN mappings: Request](/network-and-platform/docs/delete-vlan-mappings-request) `DELETE https://<IA_IP_address>:<port_number>/config/v1/rbac/vlan/mappings` - [Bulk upsert VLAN/Q-in-Q mappings: Request](/network-and-platform/docs/bulk-upsert-vlan-q-in-q-mappings-request) `PUT https://<IA_IP_address>:<port_number>/config/v1/rbac/vlan/mappings/_bulk` - [VLAN/Q-in-Q mapping for a group: Request](/network-and-platform/docs/vlan-q-in-q-mapping-for-a-group-request) `GET https://<IA_IP_address>:<port_number>/config/v1/rbac/vlan/mappings/<groupAlias>` - [Delete VLAN/Q-in-Q mapping for a group: Request](/network-and-platform/docs/delete-vlan-q-in-q-mapping-for-a-group-request) `DELETE https://<IA_IP_address>:<port_number>/config/v1/rbac/vlan/mappings/<groupAlias>` - [Create VLAN/Q-in-Q mapping for a group: Request](/network-and-platform/docs/create-vlan-q-in-q-mapping-for-a-group-request) `POST https://<IA_IP_address>:<port_number>/config/v1/rbac/vlan/mappings` - [Update VLAN/Q-in-Q mapping for a group: Request](/network-and-platform/docs/update-vlan-q-in-q-mapping-for-a-group-request) `PUT https://<IA_IP_address>:<port_number>/config/v1/rbac/vlan/mappings/<group_alias>` - Licenses - [Configure activation code: Request](/network-and-platform/docs/configure-activation-code-request) `PUT https://<IA_IP_address>:<port_number>/config/v1/dtigw/activation` - [License details: Request](/network-and-platform/docs/license-details-request) `GET https://<IA_IP_address>:<port_number>/config/v1/licenses` - [Add or update licenses: Request](/network-and-platform/docs/add-or-update-licenses-request) `POST https://<IA_IP_address>:<port_number>/config/v1/licenses` - [Delete license: Request](/network-and-platform/docs/delete-license-request) `DELETE https://<IA_IP_address>:<port_number>/config/v1/licenses/<key>` - [License status: Request](/network-and-platform/docs/license-status-request) `GET https://<IA_IP_address>:<port_number>/config/v1/licenses/_status/<feature>` - [License summary details: Request](/network-and-platform/docs/license-summary-details-request) `GET https://<IA_IP_address>:<port_number>/config/v1/licenses/_summary` - [License summary details for a feature: Request](/network-and-platform/docs/license-summary-details-for-a-feature-request) `GET https://<IA_IP_address>:<port_number>/config/v1/licenses/_summary/<feature>` - Endpoint Security (HX) gateway integration - [Configure Endpoint Security integration: Request](/network-and-platform/docs/configure-endpoint-security-hx-integration-request) `POST https://<IA_IP_address>:<port_number>/config/v1/device` - [Endpoint Security integration configuration: Request](/network-and-platform/docs/endpoint-security-hx-integration-configuration-request) `GET https://<IA_IP_address>:<port_number>/config/v1/device` - [Endpoint Security integration configuration for a device: Request](/network-and-platform/docs/endpoint-security-hx-integration-configuration-for-a-device-request) `GET https://<IA_IP_address>:<port_number>/config/v1/device/<device_IP>` - [Update Endpoint Security configuration: Request](/network-and-platform/docs/update-endpoint-security-hx-configuration-request) `PUT https://<IA_IP_address>:<port_number>/config/v1/device` - [Delete Endpoint Security configuration: Request](/network-and-platform/docs/delete-endpoint-security-hx-configuration-request) `DELETE https://<IA_IP_address>:<port_number>/config/v1/device/<device_IP>` - [Set poll interval: Request](/network-and-platform/docs/set-poll-interval-request) `PUT https://<IA_IP_address>:<port_number>/config/v1/device/<device_IP>/hostpoll/interval/<poll_interval>` - [Set alert poll interval: Request](/network-and-platform/docs/set-alert-poll-interval-request) `PUT https://<IA_IP_address>:<port_number>/config/v1/device/<device_IP>/alertpoll/interval/<poll_interval>` - [Enable SSL verification: Request](/network-and-platform/docs/enable-ssl-verification-request) `PUT https://<IA_IP_address>:<port_number>/config/v1/device/<device_IP>/sslverify/enabled/{true|false}` - [Enable host polling: Request](/network-and-platform/docs/enable-host-polling-request) `PUT https://<IA_IP_address>:<port_number>/config/v1/device/<device_IP>/hostpoll/enabled/{true|false}` - [Enable alert polling: Request](/network-and-platform/docs/enable-alert-polling-request) `PUT https://<IA_IP_address>:<port_number>/config/v1/device/<device_IP>/alertpoll/enabled/{true|false}` - Threat intel - [External feed names: Request](/network-and-platform/docs/external-feed-names-request) `GET https://<IA_IP_address>:<port_number>/threatintelservice/v1/feedname` - [Create a feed name: Request](/network-and-platform/docs/create-a-feed-name-request) `POST https://<IA_IP_address>:<port_number>/threatintelservice/v1/feedname/<feed_name>` - [Enable a feed: Request](/network-and-platform/docs/enable-a-feed-request) `POST https://<IA_IP_address>:<port_number>/threatintelservice/v1/feedname/<feed_name>/<active>` - [Delete a feed name: Request](/network-and-platform/docs/delete-a-feed-name-request) `DELETE https://<IA_IP_address>:<port_number>/threatintelservice/v1/feedname/<feed_name>` - [Upload file: Request](/network-and-platform/docs/upload-file-request) `POST https://<IA_IP_address>:<port_number>/threatintelservice/v1/uploadfile`