The NetBeez API allows dashboard administrators the ability to integrate NetBeez with other solutions such as tools, reporting & analytics solutions, and more. This documentation outlines available APIs that can be used along with available options and examples.
\nContact support for any questions you may have.
\nAll requests to the NetBeez API must be authenticated using an API key. This key is passed via HTTP headers on every request.
\nNetBeez Administrators can create an API key from the NetBeez Dashboard:
\nEvery authenticated request must include the following headers:
\nAuthorization: Bearer abc123def456\nContent-Type: application/json\nCache-Control: no-store\nMake sure to replace abc123def456 with your actual API key. If the Authorization header is missing or contains an invalid key, the API will return a 401 Unauthorized response.
We want to make exploring and utilizing our API easier for our customers. This is why we now provide our customers with a Postman project that can be downloaded onto your computer. This allows you to test out available APIs and can help you integrate NetBeez into your IT infrastructure.
\nDownload the project by clicking the \"Run in Postman\" button at the top of the page. Our Postman project uses variables to set the FQDN and API Key to your NetBeez Dashboard across all API calls in the project. To make it easier to use Postman for your NetBeez installation you can set up an environment for NetBeez. To learn how to do this watch this video from Postman. Add the following variables to your environment:
\nHOSTNAME: Set this to the FQDN of your NetBeez Dashboard.API_KEY: Set this to a generated API Key. See the above Authentication section for more information.We are implementing changes, starting in version 13.0, which will affect future versions of the API. These changes will go into effect for all new API changes we release and will be backward compatible with existing APIs for 2 versions after deprecation notices have been announced.
\nPOST and PUT will be standardized into the same request format (JSONAPI) that we use for GET requests. This is to help streamline API consumption and also provide a very important update to how we manage relationships of data resources.
Some endpoints include supplemental relationship data by default and that will no longer be the case going forward. This is to help reduce payload sizes in situations where included relationship data isn't needed by consumers of the API.
\nnetwork_interface information, and once updated with this change the API calls will need to specifically request network_interface information using include=network_interface query parameter.See the changelog for changes for the latest version of NetBeez.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Using Postman","slug":"using-postman"},{"content":"Future API Changes (Version 13.0+)","slug":"future-api-changes-version-130"},{"content":"Latest Version: 14.1","slug":"latest-version-141"}],"owner":"4425180","collectionId":"2497eaca-6106-40b1-acac-7366b290def4","publishedId":"SWTEbvow","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"444444","highlight":"000000"},"publishDate":"2020-02-18T19:49:30.000Z"},"item":[{"name":"Agent APIs","item":[{"name":"Agents","item":[{"name":"/agents","id":"f3d48709-5344-45b7-af9b-7b92feddd4ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Cache-Control","type":"text","value":"no-store"},{"key":"Content-Type","type":"text","value":"application/json"}],"url":"https://[HOSTNAME]/agents?page[offset]=1&page[limit]=25&order[attributes]=name&order[direction]=desc&type=beta","description":"This endpoint gives the ability to retrieve agent information for agents registered with the NetBeez server. See below for available filter options for this endpoint.
See the Agent data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"The stubbed parameter provides a slimmed down version of agent attributes, see list of attributes above. stubbed will be one of the following values:
truefalseFilter agents based on name. This filter is a string search, any string matches for name will be provided.
Filter agents by name based on a provided regex pattern. This filter will return any agents that match name to the provided regex.
Filter agents based on category. category can be one of the following values:
network_agentremote_worker_agentFilter agents based on agent_classes. agent_classes include following categories:
containerfastewirelesscumulusexternalgigesoftwarevirtualmacwindowsigelYou can filter on a single agent_class or multiple agent_classes by providing the agent classes as a comma separated list.
Filter agents based on active status. active will filter agents by if the agent is reachable or not.
Filter agents based on active_ts. This filter allows you to provide a single operator and value(s) to filter active_ts and agents that fall within the parameters.\nFor the <=>(between) operator use the filter[active_ts][value1] and filter[active_ts][value2] providing an epoch timestamp for each.\nFor the <=,<,>,>= operators use the filter[active_ts][value] providing an epoch timestamp.
Use if filter[active_ts][operator] is provided and is one of the following: <=,<,>,>=. An epoch timestamp should be entered.
Use if filter[active_ts][operator] is provided and is <=>. An epoch timestamp should be entered.
Use if filter[active_ts][operator] is provided and is <=>. An epoch timestamp should be entered.
Filter agents based on agent_groups. You can filter on a single agent_group or multiple agent_groups by providing the agent_groups as a comma separated list of ids.
Filter agents based on critical_alerts minimum by providing a number. This filter can be used independently or in conjunction with filter[critical_alerts][max].
Filter agents based on critical_alerts maximum by providing a number. This filter can be used independently or in conjunction with filters[critical_alerts][min].
Filter agents based on warning_alerts minimum by providing a number. This filter can be used independently or in conjunction with filter[warning_alerts][max].
Filter agents based on warning_alerts maximum by providing a number. This filter can be used independently or in conjunction with filters[warning_alerts][min].
Depreciated: This filter has been renamed to filter[in_incident]. filter[in_incident] will no longer work in 16.0.x.
\nFilter agents based on whether or not they have an open incident at the time of the request.
Filter agents based on whether or not they have an open incident at the time of the request.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
idnameagent_classsoftware_versionactive (status)open_incidentUse if order[attributes] is provided and provide either asc or desc direction.
This endpoint gives the ability to retrieve a specific agent information registered with the NetBeez server.
See the Agent data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents",":id"],"host":["[HOSTNAME]"],"query":[{"key":"type","value":"beta"}],"variable":[{"description":{"content":"Provide the id of the agent you wish to retrieve.
This endpoint gives the ability to delete a specific agent. This will removed agent from the NetBeez dashboard and queued to be permanently deleted. All agent associated data (eg. results, statistics, metrics, etc.) will also be permanently deleted.
Note: Please ensure the agent has been disconnected from the network before deleting the agent, otherwise the agent may re-register with the NetBeez server.
Provide the id of the agent you wish to delete.
This endpoint gives the ability to update specific agent information for an agent registred with the NetBeez server.
See the Agent data structure reference for additional information.
\nNote: This endpoint does not support our new JSONAPI based create/update payloads but will in the near future. This endpoint will be backwards compatible with the current format for two versions once JSONAPI based payloads have been release for this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents",":id"],"host":["[HOSTNAME]"],"query":[{"key":"type","value":"beta"}],"variable":[{"description":{"content":"Provide the id of the agent you wish to update.
This endpoint gives the ability to update specific agent information for an agent registred with the NetBeez server.
See the Agent data structure reference for additional information. See POST/PUT using JSONAPI reference topic for information on sending JSONAPI payloads.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents",":id"],"host":["[HOSTNAME]"],"query":[{"key":"type","value":"beta"}],"variable":[{"description":{"content":"Provide the id of the agent you wish to update.
This endpoint gives the ability to update a specific agents information that is registered with the NetBeez server.
See the Agent data structure reference for additional information.
\nNote: This endpoint does not support our new JSONAPI based create/update payloads but will in the near future. This endpoint will be backwards compatible with the current format for two versions once JSONAPI based payloads have been release for this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents"],"host":["[HOSTNAME]"],"query":[{"key":"type","value":"beta"}],"variable":[]}},"response":[{"id":"86450b58-bb4c-448c-96d8-88e809979ca1","name":"/agents","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"agents\": [\n {\n \"id\": 142,\n \"name\": \"Shadyside\"\n },\n {\n \"id\": 143,\n \"name\": \"Sarasota\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://[HOSTNAME]/agents?type=beta","protocol":"https","host":["[HOSTNAME]"],"path":["agents"],"query":[{"key":"type","value":"beta"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": null,\n \"type\": \"agent_update\",\n \"attributes\": {\n \"resource\": \"agent\",\n \"update_count\": 2,\n \"record_count\": 2,\n \"failures\": []\n }\n }\n}"}],"_postman_id":"544fd071-4664-4489-8fe7-a12c76a76dcb"},{"name":"agents/:agent_id/reboot","id":"ad084eea-2a06-4107-840b-6577773b6876","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"https://[HOSTNAME]/agents/:agent_id/reboot.json?type=beta","description":"Use this API endpoint to send a reboot signal to a specific agent.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents",":agent_id","reboot.json"],"host":["[HOSTNAME]"],"query":[{"key":"type","value":"beta"}],"variable":[{"type":"any","value":"1","key":"agent_id"}]}},"response":[],"_postman_id":"ad084eea-2a06-4107-840b-6577773b6876"}],"id":"4e9cf83e-805a-49e7-bc4e-56e31c064a6d","event":[{"listen":"prerequest","script":{"id":"df7e2c6e-b4cb-49c6-a9c5-c74c240419b9","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c832577f-7d96-4d36-916d-a13ceed50e01","type":"text/javascript","exec":[""]}}],"_postman_id":"4e9cf83e-805a-49e7-bc4e-56e31c064a6d","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}}},{"name":"Agent Groups","item":[{"name":"/agent_groups","id":"2441a2e7-268b-4746-be96-c3094014cbef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://[HOSTNAME]/agent_groups?page[offset]=1&page[limit]=25","description":"This endpoint gives the ability to retrieve agent_group information. See below for available filter options for this endpoint.
See the Agent Group data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agent_groups"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter agent_groups based on name. This filter is a string search, any string matches for name will be provided.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
This endpoint gives the ability to retrieve a specific agent_group information.
See the Agent Group data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agent_groups",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide theid of the agent_group you wish to retrieve.
This endpoint gives the ability to create a specific agent_group information.
See the Agent Group data structure reference for additional information.
\nNote: This endpoint does not support our new JSONAPI based create/update payloads but will in the near future. This endpoint will be backwards compatible with the current format for two versions once JSONAPI based payloads have been release for this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agent_groups"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[{"id":"6472bcd9-ac73-4ca1-a542-bc4b279810d2","name":"Create new agent group","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"agent_group\",\n \"attributes\": {\n \"name\": \"agent group name\",\n \"auto_assign\": false,\n \"force\": false\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"type\": \"agent\",\n \"id\": \"13\"\n },\n {\n \"type\": \"agent\",\n \"id\": \"9\"\n }\n ]\n },\n \"targets\": {\n \"data\": []\n },\n \"scheduled_test_templates\": {\n \"data\": []\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/agent_groups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"type\": \"agent_group\",\n \"attributes\": {\n \"name\": \"agent group name\",\n \"auto_assign\": false,\n \"agents_count\": 2,\n \"targets_count\": 1\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"297\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"345\",\n \"type\": \"agent\"\n }\n ]\n },\n \"nb_targets\": {\n \"data\": [\n {\n \"id\": \"437\",\n \"type\": \"target\"\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"ee5460b3-b05c-4db9-824b-8ec103cfe306"},{"name":"/agent_groups/:id","id":"14168ed9-ed1d-42c3-8c17-0f78682b6269","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"agent_group\",\n \"attributes\": {\n \"name\": \"[Office] Pittsburgh\"\n }\n }\n}"},"url":"https://[HOSTNAME]/agent_groups/:id","description":"This endpoint gives the ability to update a specific agent_group information.
See the Agent Group data structure reference for additional information.
\nNote: This endpoint does not support our new JSONAPI based create/update payloads but will in the near future. This endpoint will be backwards compatible with the current format for two versions once JSONAPI based payloads have been release for this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agent_groups",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide the id of the agent_group you wish to update.
This endpoint gives the ability to retreive agent_log information for a specified agent. See below for available filter options for this endpoint.
See the Agent Log data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents",":agent_id","logs"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter agent_log based on source. You can filter on a single source or multiple sources by providing the sources as a comma separated list. Available sources are:
alertswpa_supplicantdhcpFilter agent_log based on severity. severity follows syslog severity categories:
emergencyalertcriticalerrorwarningnoticeinfodebugYou can filter on a single severity or multiple severities by providing the severities as a comma separated list. Number (6,7) or string (info,debug) representations for severity can be provided.
Filter agent_log based on network_interface. You can filter on a single network_interface or multiple network_interfaces as a comma separated list. Available network_interfaces are:
eth0wlan0Filter agent_log based on event_code. This filter is a string search, any string matches for event_code will be provided. Examples:
Filter agent_log based on message. This filter is a string search, any string matches for message will be provided. Examples:
Filter agent_log based on occurred_at. This filter allows you to provide a single operator and value(s) to filter occurred_at and agent_logs that fall within the parameters.
For the <=>(between) operator use the filter[occurred_at][value1] and filter[occurred_at][value2] providing a unix timestamp for each.
For the <=,<,>,>= operators use the filter[occurred_at][value] providing a unix timestamp.
Use if filter[occurred_at][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[occurred_at][operator] is provided and is <=>.
Use if filter[occurred_at][operator] is provided and is <=>.
This parameter will allow for the inclusion of any alerts generated for the specified agent. By default alerts are not included. Available values are:
truefalseOrder payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
idseveritymessagesourceevent_codeoccurred_atnetwork_interface_keyUse if order[attributes] is provided and provide either asc or desc direction.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Provide the id of the agent you wish to retrieve agent_logs for.
This endpoint gives the ability to retreive a specific agent_log for a specified agent.
See the Agent Log data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents",":agent_id","logs",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide the id of the agent you wish to retrieve agent_logs for.
Provide theid of the agent_log you wish to retrieve.
This endpoint gives the ability to retreive access_point_connection information for a specified agent. See below for available filter options for this endpoint.
See the Access Point Connection data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents",":agent_id","access_point_connections"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter access_point_connections based on ts_start. This filter allows you to provide a single operator and value(s) to filter ts_start and access_point_connections that fall within the parameters.
For the <=>(between) operator use the filter[ts_start][value1] and filter[ts_start][value2] providing an epoch timestamp for each.
For the <=,<,>,>= operators use the filter[ts_start][value] providing an epoch timestamp.
Use if filter[ts_start][operator] is provided and is one of the following: <=,<,>,>=. An epoch timestamp should be entered.
Use if filter[ts_start][operator] is provided and is <=>. An epoch timestamp should be entered.
Use if filter[ts_start][operator] is provided and is <=>. An epoch timestamp should be entered.
Filter access_point_connections based on wifi_profiles. You can filter on a single wifi_profile or multiple wifi_profiles by providing the wifi_profiles ids as a comma separated list.
Use filter[error_states] to filter only the access_point_connections which have any of the specified error_states. One or more of association, authentication and dhcp.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
ts_attachedts_detacheddhcp_acquisition_durationnetwork_connectivity_validationstatets_startwpa_association_durationwpa_authentication_durationUse if order[attributes] is provided and provide either asc or desc direction.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Provide the id of the agent you wish to retrieve access_point_connections for.
This endpoint gives the ability to retreive a specific access_point_connection information for a specified agent.
See the Access Point Connection data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents",":agent_id","access_point_connections",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide the id of the agent you wish to retrieve access_point_connections for.
Provide theid of the access_point_connection you wish to retrieve.
This endpoint gives the ability to retreive agent_performance_metric information for a specified agent. See below for available filter options for this endpoint.
See the Agent Performance Metric data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents",":agent_id","performance_metrics"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter agent_performance_metrics based on ts. This filter allows you to provide a single operator and value(s) to filter ts and agent_performance_metrics that fall within the parameters.
For the <=>(between) operator use the filter[ts_start][value1] and filter[ts_start][value2] providing an epoch timestamp for each.
For the <=,<,>,>= operators use the filter[ts_start][value] providing an epoch timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,>,>=. An epoch timestamp should be entered.
Use if filter[ts][operator] is provided and is <=>. An epoch timestamp should be entered.
Use if filter[ts][operator] is provided and is <=>. An epoch timestamp should be entered.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
tscpu_utilizationmemory_utilizationdisk_utilizationUse if order[attributes] is provided and provide either asc or desc direction.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Provide the id of the agent you wish to retrieve access_point_connections for.
This endpoint gives the ability to retreive grouped_alert_count. See below for available filter options for this endpoint.
See the Grouped Alert Count data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["agents","grouped_alert_counts"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter which alerts to use to calculate the aggregates based on ts. This filter allows you to provide a single operator and value(s) to filter ts and alerts that fall within the parameters.\nFor the <=>(between) operator use the filter[ts][value1] and filter[ts][value2] providing an epoch timestamp for each.\nFor the <=,<,>,>= operators use the filter[ts][value] providing an epoch timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,>,>=. An epoch timestamp should be entered.
Use if filter[ts][operator] is provided and is <=>. An epoch timestamp should be entered.
Use if filter[ts][operator] is provided and is <=>. An epoch timestamp should be entered.
Define how to group the alert aggregates. There are two possible values:
\nseverity: to group alert counts per agent per severity number. Severity 1 is a critical alert, and severity 4 is a warning alert.alert_detector_id: to group alerts counts per agent, per alert detector id. The alert detector id represents the id of the alert profile assigned to this test through the Targets user interface. More information on Alert Configurations can be found here.If you wish to restrict the agents returning aggregate alert counts, you can select them as an array of agent_ids using this parameter.
This endpoint gives the ability to retrieve alert information. See below for available filter options for this endpoint.
See the Alert data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["alerts"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter alerts based on agents. You can filter on a single agent or multiple agents by providing the agents as a comma separated list of ids.
Filter alerts based on the category which the source agents belong to. Valid values are one of network_agent or remote_worker_agent.
Filter alerts based on the class which the source agents belong to. You can filter on multiple classes by providing a comma separated list of classes. Possible classes include: faste,gige,wireless,container,virtual,external,software,windows_server,mac,windows.
Filter alerts based on agent_groups. You can filter on a single agent_group or multiple agent_groups by providing the agent_groups as a comma separated list of ids.
Filter alerts based on alerts. You can filter on a single alert or multiple alerts by providing the alerts as a comma separated list of ids.
Filter alerts based on targets. You can filter on a single target or multiple targets by providing the targets as a comma separated list of ids.
Filter alerts based on tests. You can filter on a single test or multiple tests by providing the tests as a comma separated list of ids.
Filter alerts based on test_templates. You can filter on a single test_template or multiple test_templates by providing the test_templates as a comma separated list of ids.
Filter alerts based on alert_detectors. You can filter on a single alert_detector or multiple alert_detectors by providing the alert_detetectors as a comma separated list of ids.
Filter alerts based on severity. This filter allows you to provide a single operator and value(s) to filter severity and alerts that fall within the parameters.
For the <=>(between) operator use the filter[severity][value1] and filter[severity][value2] providing a number for each.
For the <=,<,>,>= operators use the filter[severity][value] providing a number.
Use if filter[severity][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[severity][operator] is provided and is <=>.
Use if filter[severity][operator] is provided and is <=>.
Filter alerts based on ts. This filter allows you to provide a single operator and value(s) to filter ts and alerts that fall within the parameters.
For the <=>(between) operator use the filter[severity][value1] and filter[ts][value2] providing a unix timestamp for each.
For the <=,<,>,>= operators use the filter[ts][value] providing a unix timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[ts][operator] is provided and is <=>.
Use if filter[ts][operator] is provided and is <=>.
Filter alerts based on closed_ts. This filter allows you to provide a single operator and value(s) to filter clsoed_ts and alerts that fall within the parameters.
For the <=>(between) operator use the filter[closed_ts][value1] and filter[closed_ts][value2] providing a unix timestamp for each.
For the <=,<,>,>= operators use the filter[closed_ts][value] providing a unix timestamp.
Use if filter[closed_ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[closed_ts][operator] is provided and is <=>.
Use if filter[closed_ts][operator] is provided and is <=>.
Filter alerts based on message. This filter is a string search, any string matches for message will be provided. Examples:
Filter alerts based on status. You can filter on a single status or multiple statuses by providing the status as a comma separated list. Available statuses are:
openclosedUse page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
idmessage\n-severity\n-alert_ts\n-closed_tsUse if order[attributes] is provided and provide either asc or desc direction.
This endpoint gives the ability to retrieve alert information. See below for available filter options for this endpoint.
See the Alert data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["alerts","ai_summary"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter alerts based on agents. You can filter on a single agent or multiple agents by providing the agents as a comma separated list of ids.
Filter alerts based on the category which the source agents belong to. Valid values are one of network_agent or remote_worker_agent.
Filter alerts based on the class which the source agents belong to. You can filter on multiple classes by providing a comma separated list of classes. Possible classes include: faste,gige,wireless,container,virtual,external,software,windows_server,mac,windows.
Filter alerts based on agent_groups. You can filter on a single agent_group or multiple agent_groups by providing the agent_groups as a comma separated list of ids.
Filter alerts based on alerts. You can filter on a single alert or multiple alerts by providing the alerts as a comma separated list of ids.
Filter alerts based on targets. You can filter on a single target or multiple targets by providing the targets as a comma separated list of ids.
Filter alerts based on tests. You can filter on a single test or multiple tests by providing the tests as a comma separated list of ids.
Filter alerts based on test_templates. You can filter on a single test_template or multiple test_templates by providing the test_templates as a comma separated list of ids.
Filter alerts based on alert_detectors. You can filter on a single alert_detector or multiple alert_detectors by providing the alert_detetectors as a comma separated list of ids.
Filter alerts based on severity. This filter allows you to provide a single operator and value(s) to filter severity and alerts that fall within the parameters.
For the <=>(between) operator use the filter[severity][value1] and filter[severity][value2] providing a number for each.
For the <=,<,>,>= operators use the filter[severity][value] providing a number.
Use if filter[severity][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[severity][operator] is provided and is <=>.
Use if filter[severity][operator] is provided and is <=>.
Filter alerts based on ts. This filter allows you to provide a single operator and value(s) to filter ts and alerts that fall within the parameters.
For the <=>(between) operator use the filter[severity][value1] and filter[ts][value2] providing a unix timestamp for each.
For the <=,<,>,>= operators use the filter[ts][value] providing a unix timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[ts][operator] is provided and is <=>.
Use if filter[ts][operator] is provided and is <=>.
Filter alerts based on closed_ts. This filter allows you to provide a single operator and value(s) to filter clsoed_ts and alerts that fall within the parameters.
For the <=>(between) operator use the filter[closed_ts][value1] and filter[closed_ts][value2] providing a unix timestamp for each.
For the <=,<,>,>= operators use the filter[closed_ts][value] providing a unix timestamp.
Use if filter[closed_ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[closed_ts][operator] is provided and is <=>.
Use if filter[closed_ts][operator] is provided and is <=>.
Filter alerts based on message. This filter is a string search, any string matches for message will be provided. Examples:
Filter alerts based on status. You can filter on a single status or multiple statuses by providing the status as a comma separated list. Available statuses are:
openclosedThis endpoint gives the ability to retrieve alert_detector information. See below for available filter options for this endpoint.
See the Alert Detector data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["alert_detectors"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter alert_detectors based on if they are set to attach to targets by default.
Filter alert_detectors by alert_detector_types, it can be one of the following values:
AgentUpDownBaselineBaselineWatermarkUpDownWatermarkalert_detector_type or multiple alert_detector_types by providing the alert_detector_types as a comma separated list.\n","type":"text/plain"},"key":"filter[alert_detector_types]","value":"watermark"},{"disabled":true,"description":{"content":"Filter alert_detectors by alerting_entity_types, it can be one of the following values:
AgentNbTestalerting_entity_type or multiple alerting_entity_types by providing the alerting_entity_types as a comma separated list.\n","type":"text/plain"},"key":"filter[alerting_entity_types]","value":"agent"},{"disabled":true,"description":{"content":"Filter alert_detectors by test_type, it can be one of the following values:
PingHTTPDNSTraceroutetest_type or multiple test_types by providing the test_types as a comma separated list.\n","type":"text/plain"},"key":"filter[test_types]","value":"http"},{"disabled":true,"description":{"content":"Filter alert_detectors based on tests. You can filter on a single test or multiple tests by providing the tests as a comma separated list of ids.
Filter alert_detectors based on agents. You can filter on a single agent or multiple agents by providing the agents as a comma separated list of ids.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
idnameUse if order[attributes] is provided and provide either asc or desc direction.
The NetBeez Alert APIs allow for retrieving, and in some cases modifying, of Alert and AlertDetector related data and configuration.
This endpoint gives the ability to retrieve incident information. See below for available filter options for this endpoint.
See the Incident data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["incidents"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter incidents
Filter incidents based on agents. You can filter on a single agent or multiple agents by providing the agent ids as a comma separated list.
Filter incidents based on the category which the source agents belong to. Valid values are one of network_agent or remote_worker_agent.
Filter incidents based on the class which the source agents belong to. You can filter on multiple classes by providing a comma separated list of classes. Possible classes include: faste,gige,wireless,container,virtual,external,software,windows_server,mac,windows.
Filter incidents based on targets. You can filter on a single target or multiple targets by providing the target ids as a comma separated list.
Filter incidents based on wifi_profiles. You can filter on a single wifi_profile or multiple wifi_profiles by providing the wifi_profile ids as a comma separated list.
Filter incidents based on ack_ts (acknoledgement timestamp). This filter allows you to provide a single operator and value(s) to filter ack_ts and incidents that fall within the parameters.
For the <=>(between) operator use the filter[ack_ts][ack_value1] and filter[ack_ts][value2] providing a unix timestamp for each (in milliseconds).
For the <=,<,>,>= operators use the filter[ack_ts][value] providing a unix timestamp.
Use if filter[ack_ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[ack_ts][operator] is provided and is <=>.
Use if filter[ack_ts][operator] is provided and is <=>.
Filter incidents based on end_ts (timestamp when the incident got resolved). This filter allows you to provide a single operator and value(s) to filter end_ts and incidents that fall within the parameters.
For the <=>(between) operator use the filter[end_ts][end_value1] and filter[end_ts][value2] providing a unix timestamp for each (in milliseconds).
For the <=,<,>,>= operators use the filter[end_ts][value] providing a unix timestamp.
Use if filter[end_ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[end_ts][operator] is provided and is <=>.
Use if filter[end_ts][operator] is provided and is <=>.
Filter incidents based on start_ts (timestamp when the incident got resolved). This filter allows you to provide a single operator and value(s) to filter start_ts and incidents that fall within the parameters.
For the <=>(between) operator use the filter[start_ts][start_value1] and filter[start_ts][value2] providing a unix timestamp for each (in milliseconds).
For the <=,<,>,>= operators use the filter[start_ts][value] providing a unix timestamp.
Use if filter[start_ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[start_ts][operator] is provided and is <=>.
Use if filter[start_ts][operator] is provided and is <=>.
Use page[offset] to specify which page, as a number, of the incidents you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many incidents to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are: start_ts, end_ts, ack_ts
Use if order[attributes] is provided and provide either asc or desc direction.
This endpoint gives the ability to retrieve incident information. See below for available filter options for this endpoint.
See the Incident data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["incidents","ai_summary"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter incidents based on agents. You can filter on a single agent or multiple agents by providing the agent ids as a comma separated list.
Filter incidents based on the category which the source agents belong to. Valid values are one of network_agent or remote_worker_agent.
Filter incidents based on the class which the source agents belong to. You can filter on multiple classes by providing a comma separated list of classes. Possible classes include: faste,gige,wireless,container,virtual,external,software,windows_server,mac,windows.
Filter incidents based on targets. You can filter on a single target or multiple targets by providing the target ids as a comma separated list.
Filter incidents based on wifi_profiles. You can filter on a single wifi_profile or multiple wifi_profiles by providing the wifi_profile ids as a comma separated list.
Filter incidents based on ack_ts (acknoledgement timestamp). This filter allows you to provide a single operator and value(s) to filter ack_ts and incidents that fall within the parameters.
For the <=>(between) operator use the filter[ack_ts][ack_value1] and filter[ack_ts][value2] providing a unix timestamp for each (in milliseconds).
For the <=,<,>,>= operators use the filter[ack_ts][value] providing a unix timestamp.
Use if filter[ack_ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[ack_ts][operator] is provided and is <=>.
Use if filter[ack_ts][operator] is provided and is <=>.
Filter incidents based on end_ts (timestamp when the incident got resolved). This filter allows you to provide a single operator and value(s) to filter end_ts and incidents that fall within the parameters.
For the <=>(between) operator use the filter[end_ts][end_value1] and filter[end_ts][value2] providing a unix timestamp for each (in milliseconds).
For the <=,<,>,>= operators use the filter[end_ts][value] providing a unix timestamp.
Use if filter[end_ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[end_ts][operator] is provided and is <=>.
Use if filter[end_ts][operator] is provided and is <=>.
Filter incidents based on start_ts (timestamp when the incident got resolved). This filter allows you to provide a single operator and value(s) to filter start_ts and incidents that fall within the parameters.
For the <=>(between) operator use the filter[start_ts][start_value1] and filter[start_ts][value2] providing a unix timestamp for each (in milliseconds).
For the <=,<,>,>= operators use the filter[start_ts][value] providing a unix timestamp.
Use if filter[start_ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[start_ts][operator] is provided and is <=>.
Use if filter[start_ts][operator] is provided and is <=>.
Use page[offset] to specify which page, as a number, of the incidents you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many incidents to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are: start_ts, end_ts, ack_ts
Use if order[attributes] is provided and provide either asc or desc direction.
This endpoint gives the ability to retrieve generated_report information. See below for available filter options for this endpoint.
See the Generated Report data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["reports","generated_reports"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter generated_reports based on name. This filter is a string search, any string matches for name will be provided.
Filter generated_reports based on report_type. You can filter on a single report_type or multiple report_types as a comma separated list. Available report_types are:
agentnetwork_statusscheduled_reporttargetweekly_statusFilter generated_reports based on if the report was generated from a scheduled_report or geneerated ad hoc.
Filter generated_reports based generated_by or the person who requested the report be generated. This filter is a string search, any string matches for generated_by will be provided.
Filter generated_reports based on if they were generated from a scheduled_reports. You can filter on a single scheduled_report or multiple scheduled_reports by providing the scheduled_reports as a comma separated list of ids.
Filter generated_reports based on state. state include following values:\n- created\n- processing\n- generated\nYou can filter on a single state or multiple states by providing the generated_report states as a comma separated list.
Filter generated_reports based on created_at. This filter allows you to provide a single operator and value(s) to filter created_at and generated_reports that fall within the parameters.\nFor the <=>(between) operator use the filter[created_at][value1] and filter[created_at][value2] providing an epoch timestamp for each.\nFor the <=,<,>,>= operators use the filter[created_at][value] providing an epoch timestamp.
Use if filter[created_at][operator] is provided and is one of the following: <=,<,>,>=. An epoch timestamp should be entered.
Use if filter[created_at][operator] is provided and is <=>`. An epoch timestamp should be entered.
Use if filter[created_at][operator] is provided and is <=>`. An epoch timestamp should be entered.
Filter generated_reports based on users. You can filter on a single user or multiple users by providing the users as a comma separated list of ids.
Request relationship information of each generated_report to be included in the returned payload. Available options are:
scheduled_reportuserUse page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
created_atnamereport_typeUse if order[attributes] is provided and provide either asc or desc direction.
This endpoint gives the ability to retrieve a specific generated_report.
See the Generated Report data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["reports","generated_reports",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide the unique id of the generated_report you wish to retrieve.
Delete a specific generated_report. Once a request is made the generated_report will be removed from the NetBeez dashboard and queued to be permanently deleted.
This endpoint gives the ability to retrieve scheduled_report information. See below for available filter options for this endpoint.
See the Scheduled Report data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["reports","scheduled_reports"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter generated_reports based on name. This filter is a string search, any string matches for name will be provided.
Filter generated_reports based on report_type. You can filter on a single report_type or multiple report_types as a comma separated list. Available report_types are:
network_statusUse page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
created_atnamereport_typeUse if order[attributes] is provided and provide either asc or desc direction.
This endpoint gives the ability to create a scheduled_report, which will produce generated_reports based on provided critiera and schedule.
See the Scheduled Report data structure reference for additional information. See POST/PUT using JSONAPI reference topic for information on sending JSONAPI payloads.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["reports","scheduled_reports"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e3b339a-28d5-4dac-84d9-e03a0b43451f"},{"name":"/reports/scheduled_reports","id":"296d4365-de36-4e52-b5f1-2e100fc100ef","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"id\": \"6732b3a6-839c-4921-a527-6b1ad3dc5080\",\n \"type\": \"scheduled_report\",\n \"attributes\": {\n \"name\": \"Testing\"\n },\n \"relationships\": {\n \"contacts\": {\n \"data\": [\n ]\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/reports/scheduled_reports/:id","description":"This endpoint gives the ability to update a specified scheduled_report, which will produce generated_reports based on the updated critiera and schedule.
See the Scheduled Report data structure reference for additional information. See POST/PUT using JSONAPI reference topic for information on sending JSONAPI payloads.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["reports","scheduled_reports",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"id":"2efe885e-277a-44e2-8f7e-a708c34cfbd3","type":"any","value":"6732b3a6-839c-4921-a527-6b1ad3dc5080","key":"id"}]}},"response":[],"_postman_id":"296d4365-de36-4e52-b5f1-2e100fc100ef"},{"name":"/reports/scheduled_reports/:id","id":"4d10075d-e098-4618-beeb-bde6ddf4a9d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"https://[HOSTNAME]/reports/scheduled_reports/:id?generated_reports=delete","description":"This endpoint gives the ability to delete a specific scheduled_report. This will not delete generated_reports that the scheduled_report has created.
Provide the id of the scheduled_report you wish to delete.
This endpoint gives the ability to retrieve target information. See below for available filter options for this endpoint.
See the Target data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["targets"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"key":"filter[name][regex]","value":""},{"disabled":true,"key":"filter[agents]","value":""},{"disabled":true,"description":{"content":"Filter targets based on the category which any of the associated agents belong to. Valid values are one of network_agent or remote_worker_agent.
Filter targets based on the class which any of the associated agents belong to. You can filter on multiple classes by providing a comma separated list of classes. Possible classes include: \n-faste
gigewirelesscontainervirtualexternalsoftwarewindows_servermac\n-windows.Filter targets based on associated agent_groups. You can filter on a single agent_group or multiple agent_groups by providing the agent_groups as a comma separated list of ids.
Filter targets based on critical_alerts minimum by providing a number. This filter can be used independently or in conjunction with filter[critical_alerts][max].
Filter targets based on critical_alerts maximum by providing a number. This filter can be used independently or in conjunction with filters[critical_alerts][min].
Filter targets based on warning_alerts minimum by providing a number. This filter can be used independently or in conjunction with filter[warning_alerts][max].
Filter targets based on warning_alerts maximum by providing a number. This filter can be used independently or in conjunction with filters[warning_alerts][min].
Filter targets based on whether or not they have an open incident at the time of the request.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
namedescriptionopen_incidentUse if order[attributes] is provided and provide either asc or desc direction.
This endpoint gives the ability to easily create targets based on popular SaaS products.
See the SaaS Target data structure reference for additional information. See POST/PUT using JSONAPI reference topic for information on sending JSONAPI payloads.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["targets","saas"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[{"id":"1e17a3d4-3879-442d-9136-1f045ce605e5","name":"Create a new SaaS target","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"targets\",\n \"relationships\": {\n \"saas_apps\": {\n \"data\": [\n {\n \"id\": \"google_docs\",\n \"type\": \"saas_app\"\n }\n ]\n },\n \"agents\": {\n \"data\": [\n {\n \"id\": 3,\n \"type\": \"agent\"\n },\n {\n \"id\": 1,\n \"type\": \"agent\"\n },\n {\n \"id\": 2,\n \"type\": \"agent\"\n }\n ]\n },\n \"agent_groups\": {\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"agent_group\"\n }\n ]\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/targets"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"b26fec24-da89-4000-9922-27c978d71f13","name":"Create a new SaaS target with parameter","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"targets\",\n \"relationships\": {\n \"saas_apps\": {\n \"data\": [\n {\n \"id\": \"salesforce_my_domain\",\n \"type\": \"saas_app\",\n \"attributes\": {\n \"name\": \"test123\"\n }\n }\n ]\n },\n \"agents\": {\n \"data\": [\n {\n \"id\": 127,\n \"type\": \"agent\"\n }\n ]\n },\n \"agent_groups\": {\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"agent_group\"\n }\n ]\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/targets"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": \"13\",\n \"type\": \"target\",\n \"attributes\": {\n \"created_at\": \"2023-11-09T18:44:09.000Z\",\n \"name\": \"Salesforce My Domain\",\n \"description\": null,\n \"smtp_notify\": true,\n \"test_aggregate_counts_by_type\": {\n \"1\": {\n \"success\": 0,\n \"fail\": 0,\n \"warning\": 0,\n \"paused\": 0,\n \"unknown\": 0\n },\n \"2\": {\n \"success\": 0,\n \"fail\": 0,\n \"warning\": 0,\n \"paused\": 0,\n \"unknown\": 0\n },\n \"3\": {\n \"success\": 0,\n \"fail\": 0,\n \"warning\": 0,\n \"paused\": 0,\n \"unknown\": 0\n },\n \"4\": {\n \"success\": 0,\n \"fail\": 0,\n \"warning\": 0,\n \"paused\": 0,\n \"unknown\": 0\n },\n \"9\": {\n \"success\": 0,\n \"fail\": 0,\n \"warning\": 0,\n \"paused\": 0,\n \"unknown\": 0\n }\n },\n \"updated_at\": \"2023-11-09T18:44:09.000Z\",\n \"vpn_target\": false,\n \"wifi_test\": false,\n \"wired_test\": false\n },\n \"relationships\": {\n \"direct_agents\": {\n \"data\": [\n {\n \"id\": \"127\",\n \"type\": \"agent\"\n }\n ]\n },\n \"agent_group_agents\": {\n \"data\": []\n },\n \"agent_groups\": {\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"agent_group\"\n }\n ]\n },\n \"contacts\": {\n \"data\": []\n },\n \"open_incident\": {\n \"data\": null\n },\n \"test_templates\": {\n \"data\": [\n {\n \"id\": \"44\",\n \"type\": \"test_template\"\n },\n {\n \"id\": \"45\",\n \"type\": \"test_template\"\n },\n {\n \"id\": \"46\",\n \"type\": \"test_template\"\n },\n {\n \"id\": \"47\",\n \"type\": \"test_template\"\n },\n {\n \"id\": \"48\",\n \"type\": \"test_template\"\n }\n ]\n }\n }\n }\n ],\n \"included\": [\n {\n \"id\": \"44\",\n \"type\": \"test_template\",\n \"attributes\": {\n \"label\": \"Sharepoint Tenant\",\n \"count\": 0,\n \"interval\": 10,\n \"timeout\": 5,\n \"target\": \"test123.my.salesforce.com\",\n \"test_statuses\": {\n \"success\": 0,\n \"fail\": 0,\n \"warning\": 0,\n \"paused\": 0,\n \"unknown\": 0\n },\n \"data_size\": 56,\n \"dont_fragment\": false,\n \"tos\": null,\n \"port\": null,\n \"ping_type\": 2,\n \"flags\": null,\n \"jitter_mos\": false\n },\n \"relationships\": {\n \"alert_detectors\": {\n \"data\": [\n {\n \"id\": \"1\",\n \"type\": \"alert_detector\"\n },\n {\n \"id\": \"5\",\n \"type\": \"alert_detector\"\n }\n ]\n },\n \"test_type\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"test_type\"\n }\n },\n \"nb_tests\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"45\",\n \"type\": \"test_template\",\n \"attributes\": {\n \"label\": \"Sharepoint Tenant\",\n \"count\": 0,\n \"interval\": 30,\n \"timeout\": 5,\n \"target\": \"test123.my.salesforce.com\",\n \"test_statuses\": {\n \"success\": 0,\n \"fail\": 0,\n \"warning\": 0,\n \"paused\": 0,\n \"unknown\": 0\n },\n \"dns_server\": null,\n \"dns_type\": 1\n },\n \"relationships\": {\n \"alert_detectors\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"alert_detector\"\n },\n {\n \"id\": \"6\",\n \"type\": \"alert_detector\"\n }\n ]\n },\n \"test_type\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"test_type\"\n }\n },\n \"nb_tests\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"46\",\n \"type\": \"test_template\",\n \"attributes\": {\n \"label\": \"Sharepoint Tenant\",\n \"count\": 0,\n \"interval\": 60,\n \"timeout\": 5,\n \"target\": \"https://test123.my.salesforce.com\",\n \"test_statuses\": {\n \"success\": 0,\n \"fail\": 0,\n \"warning\": 0,\n \"paused\": 0,\n \"unknown\": 0\n },\n \"http_method\": \"GET\",\n \"proxy_protocol\": null,\n \"proxy_address\": null,\n \"proxy_port\": null,\n \"proxy_authentication_username\": null,\n \"proxy_authentication_password\": null,\n \"authentication_type\": null,\n \"authentication_username\": null,\n \"authentication_password\": null,\n \"insecure\": false\n },\n \"relationships\": {\n \"alert_detectors\": {\n \"data\": [\n {\n \"id\": \"3\",\n \"type\": \"alert_detector\"\n },\n {\n \"id\": \"7\",\n \"type\": \"alert_detector\"\n }\n ]\n },\n \"test_type\": {\n \"data\": {\n \"id\": \"3\",\n \"type\": \"test_type\"\n }\n },\n \"nb_tests\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"47\",\n \"type\": \"test_template\",\n \"attributes\": {\n \"label\": \"Sharepoint Tenant\",\n \"count\": 0,\n \"interval\": 300,\n \"timeout\": -1,\n \"target\": \"test123.my.salesforce.com\",\n \"test_statuses\": {\n \"success\": 0,\n \"fail\": 0,\n \"warning\": 0,\n \"paused\": 0,\n \"unknown\": 0\n },\n \"num_flows\": 20,\n \"source_port\": 12345,\n \"destination_port\": 33434,\n \"max_ttl\": 30,\n \"min_ttl\": 1,\n \"inter_packet_delay\": 10\n },\n \"relationships\": {\n \"alert_detectors\": {\n \"data\": []\n },\n \"test_type\": {\n \"data\": {\n \"id\": \"9\",\n \"type\": \"test_type\"\n }\n },\n \"nb_tests\": {\n \"data\": []\n }\n }\n },\n {\n \"id\": \"48\",\n \"type\": \"test_template\",\n \"attributes\": {\n \"label\": \"Sharepoint Tenant Alt\",\n \"count\": 0,\n \"interval\": 30,\n \"timeout\": 5,\n \"target\": \"test123.lightning.force.com\",\n \"test_statuses\": {\n \"success\": 0,\n \"fail\": 0,\n \"warning\": 0,\n \"paused\": 0,\n \"unknown\": 0\n },\n \"dns_server\": null,\n \"dns_type\": 1\n },\n \"relationships\": {\n \"alert_detectors\": {\n \"data\": [\n {\n \"id\": \"2\",\n \"type\": \"alert_detector\"\n },\n {\n \"id\": \"6\",\n \"type\": \"alert_detector\"\n }\n ]\n },\n \"test_type\": {\n \"data\": {\n \"id\": \"2\",\n \"type\": \"test_type\"\n }\n },\n \"nb_tests\": {\n \"data\": []\n }\n }\n }\n ]\n}"}],"_postman_id":"233ad4af-6d6a-407a-a59d-affb0af6b4e3"},{"name":"/targets/target_template","id":"fc8b152a-12e4-45b8-8b06-cf7e9f4fba07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/targets/target_template","description":"This endpoint gives the ability to easily create targets based on simplified target_templates.
See the SaaS Target data structure reference for additional information. See POST/PUT using JSONAPI reference topic for information on sending JSONAPI payloads.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["targets","target_template"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[{"id":"bc41c19b-0071-470d-9ecc-354f4a9a4788","name":"Create a new template targets","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"targets\",\n \"relationships\": {\n \"target_templates\": {\n \"data\": [\n {\n \"id\": \"website\",\n \"attributes\": {\n \"url\": \"https://netbeez.net\",\n \"name\": \"NetBeez Site\",\n \"ping_test\": true,\n \"jitter_and_mos_enabled\": true\n },\n \"type\": \"target_template\"\n },\n {\n \"id\": \"dns\",\n \"attributes\": {\n \"fqdn\": \"netbeez.net\",\n \"dns_type\": 1,\n \"nameserver_ips\": [\n \"4.4.8.8\",\n \"8.8.8.8\"\n ]\n },\n \"type\": \"target_template\"\n },\n {\n \"id\": \"vpn\",\n \"attributes\": {\n \"fqdn\": \"172.30.0.10\",\n \"ping_interval\": 5\n },\n \"type\": \"target_template\"\n },\n {\n \"id\": \"gateway\",\n \"attributes\": {\n \"ping_interval\": 5\n },\n \"type\": \"target_template\"\n }\n ]\n },\n \"agents\": {\n \"data\": [\n {\n \"id\": 3,\n \"type\": \"agent\"\n },\n {\n \"id\": 1,\n \"type\": \"agent\"\n },\n {\n \"id\": 2,\n \"type\": \"agent\"\n }\n ]\n },\n \"agent_groups\": {\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"agent_group\"\n }\n ]\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/targets"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"fc8b152a-12e4-45b8-8b06-cf7e9f4fba07"},{"name":"/targets","id":"3e30912f-6691-4bc6-a004-d785dbaa5961","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/targets","description":"This endpoint gives the ability to create custom targets.
See the Target data structure reference for additional information. See POST/PUT using JSONAPI reference topic for information on sending JSONAPI payloads.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["targets"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[{"id":"ef456eeb-b158-4f87-b107-ee3b0bae993b","name":"Create a new custom target","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"target\",\n \"attributes\": {\n \"name\": \"API Target\",\n \"description\": \"\",\n \"wired_test\": false,\n \"wifi_test\": true,\n \"smtp_notify\": true\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": 122,\n \"type\": \"agent\"\n }\n ]\n },\n \"agent_groups\": {\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"agent_group\"\n }\n ]\n },\n \"contacts\": {\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"contact@company.com\"\n },\n \"type\": \"contact\"\n }\n ]\n },\n \"test_templates\": {\n \"data\": [\n {\n \"type\": \"test_template\",\n \"attributes\": {\n \"count\": 0,\n \"interval\": 5,\n \"timeout\": 5,\n \"target\": \"api.netbeez.net\",\n \"data_size\": 56,\n \"dont_fragment\": false,\n \"ping_type\": 2,\n \"port\": null,\n \"jitter_mos\": false,\n \"force_ipv6\": false\n },\n \"relationships\": {\n \"test_type\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"test_type\"\n }\n },\n \"alert_detectors\": {\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"alert_detector\"\n },\n {\n \"id\": 5,\n \"type\": \"alert_detector\"\n }\n ]\n }\n }\n },\n {\n \"type\": \"test_template\",\n \"attributes\": {\n \"count\": 0,\n \"interval\": 30,\n \"timeout\": 5,\n \"target\": \"api.netbeez.net\",\n \"dns_server\": \"\",\n \"dns_type\": 1\n },\n \"relationships\": {\n \"test_type\": {\n \"data\": {\n \"id\": 2,\n \"type\": \"test_type\"\n }\n },\n \"alert_detectors\": {\n \"data\": [\n {\n \"id\": 2,\n \"type\": \"alert_detector\"\n },\n {\n \"id\": 6,\n \"type\": \"alert_detector\"\n }\n ]\n }\n }\n },\n {\n \"type\": \"test_template\",\n \"attributes\": {\n \"count\": 0,\n \"interval\": 60,\n \"timeout\": 5,\n \"target\": \"https://api.netbeez.net\",\n \"http_method\": \"GET\"\n },\n \"relationships\": {\n \"test_type\": {\n \"data\": {\n \"id\": 3,\n \"type\": \"test_type\"\n }\n },\n \"alert_detectors\": {\n \"data\": [\n {\n \"id\": 3,\n \"type\": \"alert_detector\"\n },\n {\n \"id\": 7,\n \"type\": \"alert_detector\"\n }\n ]\n }\n }\n }\n ]\n },\n \"monitoring_condition\": {\n \"data\": {\n \"id\": 2,\n \"type\": \"monitoring_condition\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/targets"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"3e30912f-6691-4bc6-a004-d785dbaa5961"},{"name":"/targets/:id","id":"c5b47abf-c9b0-42b9-a5c8-b57dd91ca681","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"id\": \"26\",\n \"type\": \"target\",\n \"relationships\": {\n \"test_templates\": {\n \"data\": [\n {\n \"id\": \"111\",\n \"type\": \"test_template\",\n \"relationships\": {\n \"test_type\": {\n \"data\": {\n \"type\": \"test_type\",\n \"id\": \"1\"\n }\n }\n }\n }\n ]\n },\n \"monitoring_condition\": {\n \"data\": {\n \"id\": \"1\",\n \"type\": \"monitoring_condition\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/targets/:id","description":"This endpoint gives the ability to update a specified target.
See the Target data structure reference for additional information. See POST/PUT using JSONAPI reference topic for information on sending JSONAPI payloads.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["targets",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"id":"a1ed4807-737c-4e05-bfc1-1aba937c7488","type":"any","value":"26","key":"id"}]}},"response":[{"id":"ee32af30-94dd-435d-a15e-2a9627fef9fd","name":"Update a target","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"id\": 144,\n \"type\": \"target\",\n \"attributes\": {\n \"name\": \"API Target\",\n \"description\": \"\",\n \"wired_test\": false,\n \"wifi_test\": true,\n \"smtp_notify\": true\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": 122,\n \"type\": \"agent\"\n }\n ]\n },\n \"agent_groups\": {\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"agent_group\"\n }\n ]\n },\n \"contacts\": {\n \"data\": [\n {\n \"attributes\": {\n \"email\": \"contact@company.com\"\n },\n \"type\": \"contact\"\n }\n ]\n },\n \"test_templates\": {\n \"data\": [\n {\n \"id\": 20,\n \"type\": \"test_template\",\n \"attributes\": {\n \"count\": 0,\n \"interval\": 5,\n \"timeout\": 5,\n \"target\": \"api.netbeez.net\",\n \"data_size\": 56,\n \"dont_fragment\": false,\n \"ping_type\": 2,\n \"port\": null,\n \"jitter_mos\": false,\n \"force_ipv6\": false\n },\n \"relationships\": {\n \"test_type\": {\n \"data\": {\n \"id\": 1,\n \"type\": \"test_type\"\n }\n },\n \"alert_detectors\": {\n \"data\": [\n {\n \"id\": 1,\n \"type\": \"alert_detector\"\n },\n {\n \"id\": 5,\n \"type\": \"alert_detector\"\n }\n ]\n }\n }\n },\n {\n \"id\": 15,\n \"type\": \"test_template\",\n \"method\": \"remove\"\n \n },\n {\n \"type\": \"test_template\",\n \"attributes\": {\n \"count\": 0,\n \"interval\": 60,\n \"timeout\": 5,\n \"target\": \"https://api.netbeez.net\",\n \"http_method\": \"GET\"\n },\n \"relationships\": {\n \"test_type\": {\n \"data\": {\n \"id\": 3,\n \"type\": \"test_type\"\n }\n },\n \"alert_detectors\": {\n \"data\": [\n {\n \"id\": 3,\n \"type\": \"alert_detector\"\n },\n {\n \"id\": 7,\n \"type\": \"alert_detector\"\n }\n ]\n }\n }\n }\n ]\n },\n \"monitoring_condition\": {\n \"data\": {\n \"id\": 2,\n \"type\": \"monitoring_condition\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://[HOSTNAME]/targets/:id","protocol":"https","host":["[HOSTNAME]"],"path":["targets",":id"],"variable":[{"key":"id","value":"26"}]}},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"c5b47abf-c9b0-42b9-a5c8-b57dd91ca681"}],"id":"e23da8ac-e200-4948-bc4a-dbdaff79892a","_postman_id":"e23da8ac-e200-4948-bc4a-dbdaff79892a","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}}}],"id":"bc41e3f6-3744-46fa-b5d9-6fea726c9685","_postman_id":"bc41e3f6-3744-46fa-b5d9-6fea726c9685","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}}},{"name":"Test APIs","item":[{"name":"DNS Results","item":[{"name":"/nb_tests/dns/results","id":"d4618b29-a738-4831-b94d-57667f479a37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://[HOSTNAME]/nb_tests/dns/results?page[offset]=3&page[limit]=100&order[attributes]=value&order[direction]=asc","description":"This endpoint gives the ability to retrieve dns results. See below for available filter options for this endpoint.
See the DNS Result data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["nb_tests","dns","results"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter results based on agents. You can filter on a single agent or multiple agents by providing the agent ids as a comma separated list.
Filter results based on nb_test_templates. You can filter on a single template or multiple templates by providing the template ids as a comma separated list.
Filter results based on nb_tests. You can filter on a single nb_test or multiple nb_test by providing the nb_test ids as a comma separated list.
Filter results based on network_interface_types. You can filter on a single network_interface_type or multiple network_interface_types as a comma separated list. Available network_interface_types are:
wired10/100gigabitvirtualwirelessvpnFilter results based on ts (timestamp). This filter allows you to provide a single operator and value(s) to filter ts and results that fall within the parameters. \nFor the <=> (between) operator use the filter[ts][value1] and filter[ts][value2] providing a unix timestamp for each (in milliseconds). \nFor the <=,<,=,>,>= operators use the filter[ts][value] providing a unix timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,=,>,>=.
Use if filter[ts][operator] is provided and is <=>.
Use if filter[ts][operator] is provided and is <=>.
Filter results based on value. This filter allows you to provide a single operator and values to filter value and results that fall within the parameters. \nFor the <=> (between) operator use the filter[value][value1] and filter[value][value2] providing a number for each.
For the <=,<,=,>,>= operators use the filter[value][value] providing a number.
Use if filter[value][operator] is provided and is one of the following: <=,<,=,>,>=.
Use if filter[value][operator] is provided and is <=>.
Use if filter[value][operator] is provided and is <=>.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
\nvalueerror_codenetwork_interface_typetsUse if order[attributes] is provided and use either asc or desc direction.
This endpoint gives the ability to retrieve http results. See below for available filter options for this endpoint.
See the HTTP Result data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["nb_tests",":test_type","results"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter results based on agents. You can filter on a single agent or multiple agents by providing the agent ids as a comma separated list.
Filter results based on nb_test_templates. You can filter on a single template or multiple templates by providing the template ids as a comma separated list.
Filter results based on nb_tests. You can filter on a single nb_test or multiple nb_test by providing the nb_test ids as a comma separated list.
Filter results based on network_interface_types. You can filter on a single network_interface_type or multiple network_interface_types as a comma separated list. Available network_interface_types are:
wired10/100gigabitvirtualwirelessvpnFilter results based on ts (timestamp). This filter allows you to provide a single operator and value(s) to filter ts and results that fall within the parameters. \nFor the <=> (between) operator use the filter[ts][value1] and filter[ts][value2] providing a unix timestamp for each (in milliseconds). \nFor the <=,<,=,>,>= operators use the filter[ts][value] providing a unix timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,=,>,>=.
Use if filter[ts][operator] is provided and is <=>.
Use if filter[ts][operator] is provided and is <=>.
Filter results based on value. This filter allows you to provide a single operator and values to filter value and results that fall within the parameters. \nFor the <=> (between) operator use the filter[value][value1] and filter[value][value2] providing a number for each.
For the <=,<,=,>,>= operators use the filter[value][value] providing a number.
Use if filter[value][operator] is provided and is one of the following: <=,<,=,>,>=.
Use if filter[value][operator] is provided and is <=>.
Use if filter[value][operator] is provided and is <=>.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
\nvalueerror_codenetwork_interface_typetsUse if order[attributes] is provided and use either asc or desc direction.
Get results of specified test_type. Available test_types are:
pingdnshttpThis endpoint gives the ability to retrieve monitoring_condition information. See below for available filter options for this endpoint.
See the Monitoring Condition data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["monitoring_conditions"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter monitoring_conditions based on name. This filter is a string search, any string matches for name will be provided.
This endpoint gives the ability to retrieve nb_test informationSee below for available filter options for this endpoint.
See the NbTest data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["nb_tests"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter nb_tests based on agents. You can filter on a single agent or multiple agents by providing the agent ids as a comma separated list.
Filter nb_tests based on the category of the source agent. category can be one of the following values:
network_agentremote_worker_agentFilter nb_tests based on the agent_classes of the source agent. agent_classes include following categories:
containerfastewirelesscumulusexternalgigesoftwarevirtualmacwindowsigel\nYou can filter on a single agent_class or multiple agent_classes by providing the agent classes as a comma separated list.Filter nb_tests based on ad_hoc tests. ad_hoc will be one of the following values:
truefalseFilter nb_tests based on current_alert_modes. current_alert_modes include following modes:
stoppedunknownpausedfailwarningsuccessYou can filter on a single current_alert_mode or multiple current_alert_modes by providing the current_alert_modes as a comma separated list.
Filter nb_tests based on current_states. current_states include following states:
initializationrunningpausedstop-requestedstoppedexceptionchange-requestedpause-requestedresume-requestedYou can filter on a single current_state or multiple current_states by providing the current_states as a comma separated list.
Filter nb_tests based on network_interfaces. You can filter on a single network_interface or multiple network_interfaces as a comma separated list. Available network_interfaces are:
Filter nb_tests based on network_interface_types. You can filter on a single network_interface_type or multiple network_interface_types as a comma separated list. Available network_interface_types are:
wired10/100gigabitvirtualwirelessFilter nb_tests based on schedule_types. You can filter on a single schedule_type or multiple schedule_types as a comma separated list. Available schedule_types are:
periodicscheduledad_hocFilter nb_tests based on targets. You can filter on a single target or multiple targets by providing the target ids as a comma separated list.
Filter nb_tests based on test_templates. You can filter on a single test_template or multiple test_templates by providing the test_template ids as a comma separated list.
Filter nb_tests based on test_types. You can filter on a single test_type or multiple test_types as a comma separated list. Available test_types are:
pingdnshttptraceroutepath_analysisFilter nb_tests based on wifi_profiles. You can filter on a single wifi_profile or multiple wifi_profiles by providing the wifi_profile ids as a comma separated list.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
This endpoint gives the ability to retrieve traceroute results. See below for available filter options for this endpoint.
See the Traceroute Results data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["nb_tests","traceroutes","results"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter traceroute_results based on ts (timestamp). This filter allows you to provide a single operator and value(s) to filter ts and results that fall within the parameters.
For the <=>(between) operator use the filter[ts][value1] and filter[ts][value2] providing a unix timestamp for each (in milliseconds).
For the <=,<,=,>,>= operators use the filter[ts][value] providing a unix timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,=,>,>=.
Use if filter[ts][operator] is provided and is <=>.
Use if filter[ts][operator] is provided and is <=>.
Filter traceroute_results based on agents. You can filter on a single agent or multiple agents by providing the agent ids as a comma separated list.
Filter traceroute_results based on test_templates. You can filter on a single template or multiple templates by providing the template ids as a comma separated list.
Filter traceroute_results based on domain. This filter is a string search, any string matches for domain will be provided.
Filter traceroute_results by domain based on a provided regex pattern. This filter will return any results that match domain to the provided regex. d
Filter traceroute_results based on ip. This filter is a string search, any string matches for ip will be provided.
Filter traceroute_results by ip based on a provided regex pattern. This filter will return any results that match ip to the provided regex.
Filter traceroute_results based on rtt. This filter allows you to provide a single operator and values to filter rtt and results that fall within the parameters.
For the <=>(between) operator use the filter[rtt][value1] and filter[rtt][value2] providing a number for each.
For the <=,<,=,>,>= operators use the filter[rtt][value] providing a number.
Use if filter[rtt][operator] is provided and is one of the following: <=,<,=,>,>=.
Use if filter[rtt][operator] is provided and is <=>.
Use if filter[rtt][operator] is provided and is <=>.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
The Traceroute Results resource allows retrieving of results for Traceroute tests performed by agents.
This endpoint gives the ability to retrieve path_analysis results. See below for available filter options for this endpoint.
See the Path Analysis Results data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["nb_tests","path_analysis","results"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter path_analysis_results based on agents. You can filter on a single agent or multiple agents by providing the agent ids as a comma separated list.
Filter path_analysis_results based on nb_tests. You can filter on a single nb_test or multiple nb_test by providing the nb_test ids as a comma separated list.
Filter path_analysis_results based on nb_test_templates. You can filter on a single template or multiple templates by providing the template ids as a comma separated list.
Filter path_analysis_result based on ip_address. This filter is a string search, any string matches for ip_address will be provided.
Filter path_analysis_results based on ts (timestamp). This filter allows you to provide a single operator and value(s) to filter ts and results that fall within the parameters.\nFor the <=>(between) operator use the filter[ts][value1] and filter[ts][value2] providing a unix timestamp for each (in milliseconds).\nFor the <=,<,=,>,>= operators use the filter[ts][value] providing a unix timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,=,>,>=.
Use if filter[ts][operator] is provided and is <=>.
Use if filter[ts][operator] is provided and is <=>.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
This endpoint gives the ability to retrieve a specific path_analysis result.
See the Path Analysis Results Timestamp data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["nb_tests","path_analysis","results",":timestamp"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide the timestamp of the path_analysis_result you wish to retrieve.
This endpoint gives the ability to retrieve ping results. See below for available filter options for this endpoint.
See the Ping Results data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["nb_tests","ping","results"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter results based on agents. You can filter on a single agent or multiple agents by providing the agent ids as a comma separated list.
Filter results based on nb_test_templates. You can filter on a single template or multiple templates by providing the template ids as a comma separated list.
Filter results based on nb_tests. You can filter on a single nb_test or multiple nb_test by providing the nb_test ids as a comma separated list.
Filter results based on network_interface_types. You can filter on a single network_interface_type or multiple network_interface_types as a comma separated list. Available network_interface_types are:
wired10/100gigabitvirtualwirelessvpnFilter results based on ts (timestamp). This filter allows you to provide a single operator and value(s) to filter ts and results that fall within the parameters. \nFor the <=> (between) operator use the filter[ts][value1] and filter[ts][value2] providing a unix timestamp for each (in milliseconds). \nFor the <=,<,=,>,>= operators use the filter[ts][value] providing a unix timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,=,>,>=.
Use if filter[ts][operator] is provided and is <=>.
Use if filter[ts][operator] is provided and is <=>.
Filter results based on value. This filter allows you to provide a single operator and values to filter value and results that fall within the parameters. \nFor the <=> (between) operator use the filter[value][value1] and filter[value][value2] providing a number for each.
For the <=,<,=,>,>= operators use the filter[value][value] providing a number.
Use if filter[value][operator] is provided and is one of the following: <=,<,=,>,>=.
Use if filter[value][operator] is provided and is <=>.
Use if filter[value][operator] is provided and is <=>.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
\nvalueerror_codenetwork_interface_typetsUse if order[attributes] is provided and use either asc or desc direction.
This endpoint gives the ability to retrieve scheduled_nb_test_templates information. See below for available filter options for this endpoint.
See the Scheduled Test Templates data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["scheduled_nb_test_templates.json"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter scheduled_nb_test_templates based on label. This filter is a string search, any string matches for label will be provided.
Filter scheduled_nb_test_templates based on test_type_id. This filter is used to return only tests of a specific type. For reference: Iperf is 5, Network Speed is 7 and VoIP is8.
Filter the scheduled_nb_test_templates based on the set of agent ids provided as source agents. The returned set of tests will have all the agents provided as source agents.
Filter the scheduled_nb_test_templates based on the destination agent's id.
Filter the scheduled_nb_test_templates based on the destination FQDN or IP address of a test. This is mostly for any M-to-1 Iperf tests.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
idlabelUse if order[attributes] is provided and use either asc or desc direction.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
This endpoint gives the ability to retrieve a specific scheduled_nb_test_template information.
See the Scheduled Test Template data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["scheduled_nb_test_templates",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide theid of the scheduled_nb_test_template you wish to retrieve.
This endpoint gives the ability to create a scheduled_nb_test_template, which provides the ability for agents to run iperf, speedtest, and voip tests on a schedule.
See the Scheduled Test Templates data structure reference for additional information.
\nNote: This endpoint does not support our new JSONAPI based create/update payloads but will in the near future. This endpoint will be backwards compatible with the current format for two versions once JSONAPI based payloads have been release for this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["scheduled_nb_test_templates.json"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[{"id":"e1750257-4dfb-4f40-b70f-a23cbce880f9","name":"Create new 1-to-1 Iperf test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 5,\n \"agent_ids\": [\n 6\n ],\n \"bandwidth\": null,\n \"cron_schedule\": \"0 9,15,21 * * 1,2,3,4,5\",\n \"iperf_port\": 5001,\n \"iperf_time\": 10,\n \"iperf_type\": 1,\n \"iperf_version\": 2,\n \"label\": \"Test API POST\",\n \"multicast\": false,\n \"multicast_ip\": false,\n \"parallel_streams\": 1,\n \"reverse\": false,\n \"target_is_agent\": 5,\n \"tcp_window\": 1,\n \"ttl\": 5,\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"3\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"Test API POST\",\n \"target\": \"0.0.0.0\",\n \"test_type_id\": 5,\n \"cron_schedule\": \"0 9,15,21 * * 1,2,3,4,5\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"IperfTemplate\",\n \"created_at\": \"2023-10-03T17:51:41.000Z\",\n \"configuration\": {\n \"iperf_type\": 1,\n \"iperf_time\": 10,\n \"iperf_port\": 5001,\n \"multicast\": false,\n \"multicast_ip\": \"0\",\n \"tcp_window\": 1,\n \"bandwidth\": null,\n \"ttl\": 5,\n \"tos\": null,\n \"data_size\": null,\n \"target_is_agent\": 5,\n \"parallel_streams\": 1,\n \"iperf_version\": 2,\n \"reverse\": false\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"6\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"},{"id":"68b79e8a-ced4-4903-8500-0687f79d0bfa","name":"Create new M-to-1 Iperf test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"data_size\":null,\n \"iperf_port\":5001,\n \"iperf_time\":10,\n \"iperf_type\":1,\n \"multicast\":false,\n \"multicast_ip\":null,\n \"parallel_streams\":1,\n \"iperf_version\":2,\n \"reverse\":false,\n \"target_is_agent\":18,\n \"tcp_window\":1,\n \"tos\":null,\n \"ttl\":null,\n \"bandwidth\":null,\n \"label\":\"test post\",\n \"cron_schedule\":\"0 12 * * 1-5\",\n \"target\":\"\",\n \"test_type_id\":5,\n \"agent_ids\":[15]\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"7aeee39a-07ed-478c-a153-fe9305fa56f6","name":"Create new Network Speed test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 7,\n \"agent_ids\": [\n 14,\n 7,\n 6,\n 5,\n 4,\n 2,\n 1\n ],\n \"cron_schedule\": \"0 8,14,20 * * 1,2,3,4,5\",\n \"target\": \"\",\n \"label\": \"Network Speed Test API\",\n \"secure\": true,\n \"speedtest_type\": 2,\n \"server\": \"\",\n \"mini_server\": \"\",\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"4\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"Network Speed Test API\",\n \"target\": \"\",\n \"test_type_id\": 7,\n \"cron_schedule\": \"0 8,14,20 * * 1,2,3,4,5\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"SpeedtestTemplate\",\n \"created_at\": \"2023-10-03T17:57:09.000Z\",\n \"configuration\": {\n \"server\": \"\",\n \"secure\": true,\n \"mini_server\": \"\",\n \"speedtest_type\": 2\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"1\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"2\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"4\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"5\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"6\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"7\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"14\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"},{"id":"4f99b7f6-6665-494f-abf4-51419eec7ad3","name":"Create new VoIP test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 8,\n \"agent_ids\": [\n 5\n ],\n \"cron_schedule\": \"0 9,15,21 * * *\",\n \"target\": \"\",\n \"label\": \"VoIP Test API\",\n \"codec\": \"g711\",\n \"num_of_concurrent_calls\": 1,\n \"target_is_agent\": 6,\n \"voip_port\": 12001,\n \"voip_time\": 30,\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"6\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"VoIP Test API\",\n \"target\": \"0.0.0.0\",\n \"test_type_id\": 8,\n \"cron_schedule\": \"0 9,15,21 * * *\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"VoipTemplate\",\n \"created_at\": \"2023-10-03T19:51:32.000Z\",\n \"configuration\": {\n \"codec\": \"g711\",\n \"voip_time\": 30,\n \"voip_port\": 12001,\n \"num_of_concurrent_calls\": 1,\n \"target_is_agent\": 6\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"5\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"},{"id":"79a0af2e-1495-47d1-bff1-82af5fc6ba8f","name":"Create new 1-to-1 Iperf test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 5,\n \"agent_ids\": [\n 6\n ],\n \"bandwidth\": null,\n \"cron_schedule\": \"0 9,15,21 * * 1,2,3,4,5\",\n \"iperf_port\": 5001,\n \"iperf_time\": 10,\n \"iperf_type\": 1,\n \"iperf_version\": 2,\n \"label\": \"Test API POST\",\n \"multicast\": false,\n \"multicast_ip\": false,\n \"parallel_streams\": 1,\n \"reverse\": false,\n \"target_is_agent\": 5,\n \"tcp_window\": 1,\n \"ttl\": 5,\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"3\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"Test API POST\",\n \"target\": \"0.0.0.0\",\n \"test_type_id\": 5,\n \"cron_schedule\": \"0 9,15,21 * * 1,2,3,4,5\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"IperfTemplate\",\n \"created_at\": \"2023-10-03T17:51:41.000Z\",\n \"configuration\": {\n \"iperf_type\": 1,\n \"iperf_time\": 10,\n \"iperf_port\": 5001,\n \"multicast\": false,\n \"multicast_ip\": \"0\",\n \"tcp_window\": 1,\n \"bandwidth\": null,\n \"ttl\": 5,\n \"tos\": null,\n \"data_size\": null,\n \"target_is_agent\": 5,\n \"parallel_streams\": 1,\n \"iperf_version\": 2,\n \"reverse\": false\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"6\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"},{"id":"4f6f749b-1cbf-43bf-8e3a-3a23e43842c8","name":"Create new M-to-1 Iperf test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"data_size\":null,\n \"iperf_port\":5001,\n \"iperf_time\":10,\n \"iperf_type\":1,\n \"multicast\":false,\n \"multicast_ip\":null,\n \"parallel_streams\":1,\n \"iperf_version\":2,\n \"reverse\":false,\n \"target_is_agent\":18,\n \"tcp_window\":1,\n \"tos\":null,\n \"ttl\":null,\n \"bandwidth\":null,\n \"label\":\"test post\",\n \"cron_schedule\":\"0 12 * * 1-5\",\n \"target\":\"\",\n \"test_type_id\":5,\n \"agent_ids\":[15]\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"0d4404e1-15e9-4312-9dad-9e8973df955a","name":"Create new Network Speed test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 7,\n \"agent_ids\": [\n 14,\n 7,\n 6,\n 5,\n 4,\n 2,\n 1\n ],\n \"cron_schedule\": \"0 8,14,20 * * 1,2,3,4,5\",\n \"target\": \"\",\n \"label\": \"Network Speed Test API\",\n \"secure\": true,\n \"speedtest_type\": 2,\n \"server\": \"\",\n \"mini_server\": \"\",\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"4\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"Network Speed Test API\",\n \"target\": \"\",\n \"test_type_id\": 7,\n \"cron_schedule\": \"0 8,14,20 * * 1,2,3,4,5\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"SpeedtestTemplate\",\n \"created_at\": \"2023-10-03T17:57:09.000Z\",\n \"configuration\": {\n \"server\": \"\",\n \"secure\": true,\n \"mini_server\": \"\",\n \"speedtest_type\": 2\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"1\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"2\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"4\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"5\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"6\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"7\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"14\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"},{"id":"b57013f0-3e08-4ecf-b620-9b7d3ab420c2","name":"Create new VoIP test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 8,\n \"agent_ids\": [\n 5\n ],\n \"cron_schedule\": \"0 9,15,21 * * *\",\n \"target\": \"\",\n \"label\": \"VoIP Test API\",\n \"codec\": \"g711\",\n \"num_of_concurrent_calls\": 1,\n \"target_is_agent\": 6,\n \"voip_port\": 12001,\n \"voip_time\": 30,\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"6\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"VoIP Test API\",\n \"target\": \"0.0.0.0\",\n \"test_type_id\": 8,\n \"cron_schedule\": \"0 9,15,21 * * *\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"VoipTemplate\",\n \"created_at\": \"2023-10-03T19:51:32.000Z\",\n \"configuration\": {\n \"codec\": \"g711\",\n \"voip_time\": 30,\n \"voip_port\": 12001,\n \"num_of_concurrent_calls\": 1,\n \"target_is_agent\": 6\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"5\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"24b30b27-fd67-485a-a33d-f129d286ce9f"},{"name":"/scheduled_nb_test_templates (jsonapi)","id":"0e2151be-3682-4d4d-bc1c-1cb230d1b228","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"id\": \"19\",\n \"type\": \"scheduled_test_template\",\n \"attributes\": {\n \"secure\": true,\n \"speedtest_type\": 2,\n \"label\": \"Test API\",\n \"cron_schedule\": \"10 12 * * *\"\n },\n \"relationships\": {\n \"test_type\": {\n \"data\": {\n \"type\": \"test_type\",\n \"id\": \"7\"\n }\n },\n \"agents\": {\n \"data\": [\n {\n \"type\": \"agent\",\n \"id\": \"2\"\n }\n ]\n },\n \"monitoring_condition\": {\n \"data\": {\n \"type\": \"monitoring_condition\",\n \"id\": \"1\"\n }\n },\n \"alert_detectors\": {\n \"data\": [\n {\n \"type\": \"alert_detector\",\n \"id\": \"1\"\n }\n ]\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates","description":"This endpoint gives the ability to create a scheduled_nb_test_template, which provides the ability for agents to run iperf, speedtest, and voip tests on a schedule.
See the Scheduled Test Templates data structure reference for additional information. See POST/PUT using JSONAPI reference topic for information on sending JSONAPI payloads.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["scheduled_nb_test_templates"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[{"id":"5ccb884d-4ca2-4c23-904a-ced18619d9e1","name":"Create new 1-to-1 Iperf test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 5,\n \"agent_ids\": [\n 6\n ],\n \"bandwidth\": null,\n \"cron_schedule\": \"0 9,15,21 * * 1,2,3,4,5\",\n \"iperf_port\": 5001,\n \"iperf_time\": 10,\n \"iperf_type\": 1,\n \"iperf_version\": 2,\n \"label\": \"Test API POST\",\n \"multicast\": false,\n \"multicast_ip\": false,\n \"parallel_streams\": 1,\n \"reverse\": false,\n \"target_is_agent\": 5,\n \"tcp_window\": 1,\n \"ttl\": 5,\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"3\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"Test API POST\",\n \"target\": \"0.0.0.0\",\n \"test_type_id\": 5,\n \"cron_schedule\": \"0 9,15,21 * * 1,2,3,4,5\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"IperfTemplate\",\n \"created_at\": \"2023-10-03T17:51:41.000Z\",\n \"configuration\": {\n \"iperf_type\": 1,\n \"iperf_time\": 10,\n \"iperf_port\": 5001,\n \"multicast\": false,\n \"multicast_ip\": \"0\",\n \"tcp_window\": 1,\n \"bandwidth\": null,\n \"ttl\": 5,\n \"tos\": null,\n \"data_size\": null,\n \"target_is_agent\": 5,\n \"parallel_streams\": 1,\n \"iperf_version\": 2,\n \"reverse\": false\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"6\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"},{"id":"19946e6e-a00d-423d-b303-711d2b718cdd","name":"Create new M-to-1 Iperf test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"data_size\":null,\n \"iperf_port\":5001,\n \"iperf_time\":10,\n \"iperf_type\":1,\n \"multicast\":false,\n \"multicast_ip\":null,\n \"parallel_streams\":1,\n \"iperf_version\":2,\n \"reverse\":false,\n \"target_is_agent\":18,\n \"tcp_window\":1,\n \"tos\":null,\n \"ttl\":null,\n \"bandwidth\":null,\n \"label\":\"test post\",\n \"cron_schedule\":\"0 12 * * 1-5\",\n \"target\":\"\",\n \"test_type_id\":5,\n \"agent_ids\":[15]\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"b41e06be-da46-44a9-a106-b30b07e25098","name":"Create new Network Speed test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 7,\n \"agent_ids\": [\n 14,\n 7,\n 6,\n 5,\n 4,\n 2,\n 1\n ],\n \"cron_schedule\": \"0 8,14,20 * * 1,2,3,4,5\",\n \"target\": \"\",\n \"label\": \"Network Speed Test API\",\n \"secure\": true,\n \"speedtest_type\": 2,\n \"server\": \"\",\n \"mini_server\": \"\",\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"4\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"Network Speed Test API\",\n \"target\": \"\",\n \"test_type_id\": 7,\n \"cron_schedule\": \"0 8,14,20 * * 1,2,3,4,5\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"SpeedtestTemplate\",\n \"created_at\": \"2023-10-03T17:57:09.000Z\",\n \"configuration\": {\n \"server\": \"\",\n \"secure\": true,\n \"mini_server\": \"\",\n \"speedtest_type\": 2\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"1\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"2\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"4\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"5\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"6\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"7\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"14\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"},{"id":"a61617cc-a888-45e8-b1d9-7e2ccd6d19d9","name":"Create new VoIP test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 8,\n \"agent_ids\": [\n 5\n ],\n \"cron_schedule\": \"0 9,15,21 * * *\",\n \"target\": \"\",\n \"label\": \"VoIP Test API\",\n \"codec\": \"g711\",\n \"num_of_concurrent_calls\": 1,\n \"target_is_agent\": 6,\n \"voip_port\": 12001,\n \"voip_time\": 30,\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"6\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"VoIP Test API\",\n \"target\": \"0.0.0.0\",\n \"test_type_id\": 8,\n \"cron_schedule\": \"0 9,15,21 * * *\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"VoipTemplate\",\n \"created_at\": \"2023-10-03T19:51:32.000Z\",\n \"configuration\": {\n \"codec\": \"g711\",\n \"voip_time\": 30,\n \"voip_port\": 12001,\n \"num_of_concurrent_calls\": 1,\n \"target_is_agent\": 6\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"5\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"},{"id":"82c1115d-081b-4113-808e-c4ac08fb3544","name":"Create new 1-to-1 Iperf test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 5,\n \"agent_ids\": [\n 6\n ],\n \"bandwidth\": null,\n \"cron_schedule\": \"0 9,15,21 * * 1,2,3,4,5\",\n \"iperf_port\": 5001,\n \"iperf_time\": 10,\n \"iperf_type\": 1,\n \"iperf_version\": 2,\n \"label\": \"Test API POST\",\n \"multicast\": false,\n \"multicast_ip\": false,\n \"parallel_streams\": 1,\n \"reverse\": false,\n \"target_is_agent\": 5,\n \"tcp_window\": 1,\n \"ttl\": 5,\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"3\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"Test API POST\",\n \"target\": \"0.0.0.0\",\n \"test_type_id\": 5,\n \"cron_schedule\": \"0 9,15,21 * * 1,2,3,4,5\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"IperfTemplate\",\n \"created_at\": \"2023-10-03T17:51:41.000Z\",\n \"configuration\": {\n \"iperf_type\": 1,\n \"iperf_time\": 10,\n \"iperf_port\": 5001,\n \"multicast\": false,\n \"multicast_ip\": \"0\",\n \"tcp_window\": 1,\n \"bandwidth\": null,\n \"ttl\": 5,\n \"tos\": null,\n \"data_size\": null,\n \"target_is_agent\": 5,\n \"parallel_streams\": 1,\n \"iperf_version\": 2,\n \"reverse\": false\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"6\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"},{"id":"39bca3b9-001b-4070-89d1-898b38f3dc44","name":"Create new M-to-1 Iperf test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"data_size\":null,\n \"iperf_port\":5001,\n \"iperf_time\":10,\n \"iperf_type\":1,\n \"multicast\":false,\n \"multicast_ip\":null,\n \"parallel_streams\":1,\n \"iperf_version\":2,\n \"reverse\":false,\n \"target_is_agent\":18,\n \"tcp_window\":1,\n \"tos\":null,\n \"ttl\":null,\n \"bandwidth\":null,\n \"label\":\"test post\",\n \"cron_schedule\":\"0 12 * * 1-5\",\n \"target\":\"\",\n \"test_type_id\":5,\n \"agent_ids\":[15]\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"b13e5ae7-5ed2-4eba-8a6f-66f6d87eb41c","name":"Create new Network Speed test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 7,\n \"agent_ids\": [\n 14,\n 7,\n 6,\n 5,\n 4,\n 2,\n 1\n ],\n \"cron_schedule\": \"0 8,14,20 * * 1,2,3,4,5\",\n \"target\": \"\",\n \"label\": \"Network Speed Test API\",\n \"secure\": true,\n \"speedtest_type\": 2,\n \"server\": \"\",\n \"mini_server\": \"\",\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"4\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"Network Speed Test API\",\n \"target\": \"\",\n \"test_type_id\": 7,\n \"cron_schedule\": \"0 8,14,20 * * 1,2,3,4,5\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"SpeedtestTemplate\",\n \"created_at\": \"2023-10-03T17:57:09.000Z\",\n \"configuration\": {\n \"server\": \"\",\n \"secure\": true,\n \"mini_server\": \"\",\n \"speedtest_type\": 2\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"1\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"2\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"4\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"5\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"6\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"7\",\n \"type\": \"agent\"\n },\n {\n \"id\": \"14\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"},{"id":"fdcf17f3-130b-456b-8567-46b400028a6d","name":"Create new VoIP test","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"scheduled_nb_test_template\": {\n \"test_type_id\": 8,\n \"agent_ids\": [\n 5\n ],\n \"cron_schedule\": \"0 9,15,21 * * *\",\n \"target\": \"\",\n \"label\": \"VoIP Test API\",\n \"codec\": \"g711\",\n \"num_of_concurrent_calls\": 1,\n \"target_is_agent\": 6,\n \"voip_port\": 12001,\n \"voip_time\": 30,\n \"warning_conditions\": {}\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates.json"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"6\",\n \"type\": \"scheduled_nb_test_template\",\n \"attributes\": {\n \"label\": \"VoIP Test API\",\n \"target\": \"0.0.0.0\",\n \"test_type_id\": 8,\n \"cron_schedule\": \"0 9,15,21 * * *\",\n \"pause_other_tests\": true,\n \"scheduled_test_templatable_type\": \"VoipTemplate\",\n \"created_at\": \"2023-10-03T19:51:32.000Z\",\n \"configuration\": {\n \"codec\": \"g711\",\n \"voip_time\": 30,\n \"voip_port\": 12001,\n \"num_of_concurrent_calls\": 1,\n \"target_is_agent\": 6\n },\n \"warning_conditions\": {},\n \"last_result\": null\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": \"5\",\n \"type\": \"agent\"\n }\n ]\n }\n }\n }\n}"}],"_postman_id":"0e2151be-3682-4d4d-bc1c-1cb230d1b228"},{"name":"/scheduled_nb_test_templates/:id","id":"d82ea759-2409-451a-817a-8c885cb7d86d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n\t\"data_size\":null,\n\t\"iperf_port\":5001,\n\t\"iperf_time\":10,\n\t\"iperf_type\":1,\n\t\"multicast\":false,\n\t\"multicast_ip\":null,\n\t\"parallel_streams\":1,\n\t\"iperf_version\":2,\n\t\"reverse\":false,\n\t\"target_is_agent\":18,\n\t\"tcp_window\":1,\n\t\"tos\":null,\n\t\"ttl\":null,\n\t\"bandwidth\":null,\n\t\"label\":\"test put changed\",\n\t\"cron_schedule\":\"0 13 * * 1-5\",\n\t\"target\":\"172.17.0.4\",\n\t\"test_type_id\":5,\n\t\"agent_ids\":[15]\n}\n","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/scheduled_nb_test_templates/:id","description":"This endpoint gives the ability to update a specified scheduled_nb_test_template.
See the Scheduled Test Templates data structure reference for additional information.
\nNote: This endpoint does not support our new JSONAPI based create/update payloads but will in the near future. This endpoint will be backwards compatible with the current format for two versions once JSONAPI based payloads have been release for this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["scheduled_nb_test_templates",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide the id of the scheduled_nb_test_template you wish to update.
This endpoint gives the ability to update a specified scheduled_nb_test_template.
See the Scheduled Test Templates data structure reference for additional information. See POST/PUT using JSONAPI reference topic for information on sending JSONAPI payloads.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["scheduled_nb_test_templates",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"id":"86e476f6-42c8-4e68-825e-15d66c0c4b69","description":{"content":"Provide the id of the scheduled_nb_test_template you wish to update.
This endpoint gives the ability to retrieve multiagent_test_runs information. See below for available filter options for this endpoint.
See the Multiagent Test Run data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["multiagent_nb_test_runs"],"host":["[HOSTNAME]"],"query":[{"description":{"content":"Filter multiagent_nb_test_runs based on the id of the runs. You may provide a comma separated list of ids.
Filter runs based on ts (timestamp). This filter allows you to provide a single operator and value(s) to filter ts and results that fall within the parameters.
For the <=>(between) operator use the filter[ts][value1] and filter[ts][value2] providing a unix timestamp for each (in milliseconds).
For the <=,<,>,>= operators use the filter[ts][value] providing a unix timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[ts][operator] is provided and is <=>.
Use if filter[ts][operator] is provided and is <=>.
Use the include parameter in order to include all the associated results with each run returned.
This endpoint allows you to perform an ad-hoc test run on multiple Agents. Currently this is limited to Network Speed Tests and VoIP Tests.
See the Multiagent Test Run data structure reference for additional information. See POST/PUT using JSONAPI reference topic for information on sending JSONAPI payloads.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["multiagent_nb_test_runs","ad_hoc"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[{"id":"9489e547-afb5-4ddf-9387-ccd59986b2c1","name":"Request a Network Speedtest on an agent","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"Bearer [API_KEY]"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"multiagent_nb_test_run\",\n \"attributes\": {\n \"speedtest_type\": 2,\n \"target\": \"\"\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": 279,\n \"type\": \"agent\"\n }\n ]\n },\n \"test_type\": {\n \"data\": {\n \"id\": 7,\n \"type\": \"test_type\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/multiagent_nb_test_runs/ad_hoc"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"1640\",\n \"type\": \"multiagent_nb_test_run\",\n \"attributes\": {\n \"ts\": 1696306581840,\n \"state\": \"initialization\",\n \"configuration\": {\n \"target\": \"\",\n \"schedule_type\": \"ad_hoc\",\n \"speedtest_type\": 2,\n \"agent_ids\": [\n 279,\n 280\n ],\n \"test_type_id\": 7\n }\n },\n \"relationships\": {\n \"scheduled_nb_test_template\": {\n \"data\": null\n },\n \"scheduled_nb_test_results\": {\n \"data\": []\n },\n \"test_type\": {\n \"data\": null\n }\n }\n }\n}"},{"id":"80db86bb-ff5d-4a97-908a-42a01c1dfb10","name":"Run a Custom Command test","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"type\": \"multiagent_nb_test_run\",\n \"attributes\": {\n \"custom_command\": \"#!/usr/bin/env bash\\necho \\\"value=123\\\"\",\n \"output_schema\": [\n {\n \"metric\": \"value\",\n \"unit\": \"int\"\n }\n ]\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n {\n \"id\": 3646,\n \"type\": \"agent\"\n },\n {\n \"id\": 3588,\n \"type\": \"agent\"\n }\n ]\n },\n \"test_type\": {\n \"data\": {\n \"id\": 11,\n \"type\": \"test_type\"\n }\n }\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"https://[HOSTNAME]/multiagent_nb_test_runs/ad_hoc"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": {\n \"id\": \"450374\",\n \"type\": \"multiagent_nb_test_run\",\n \"attributes\": {\n \"ts\": 1773652644033,\n \"state\": \"initialization\",\n \"configuration\": {\n \"schedule_type\": \"ad_hoc\",\n \"custom_command\": \"#!/usr/bin/env bash\\necho \\\"value=123\\\"\",\n \"output_schema\": [\n {\n \"metric\": \"value\",\n \"unit\": \"int\"\n }\n ],\n \"agent_ids\": [\n 3646,\n 3588\n ],\n \"test_type_id\": 11\n }\n },\n \"relationships\": {\n \"scheduled_nb_test_template\": {\n \"data\": null\n },\n \"scheduled_nb_test_results\": {\n \"data\": []\n },\n \"test_type\": {\n \"data\": null\n }\n }\n }\n}"}],"_postman_id":"6f62e8f6-ae2f-4b02-8b9a-1f4ef1ae6237"}],"id":"859139ed-80e0-4702-853b-84aa238386bd","_postman_id":"859139ed-80e0-4702-853b-84aa238386bd","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}}},{"name":"Scheduled Test Results","item":[{"name":"/scheduled_nb_test_templates/:scheduled_nb_test_template_id/results","id":"06fb70e8-f831-423d-8f68-dc4af597d1ca","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"https://[HOSTNAME]/scheduled_nb_test_templates/:scheduled_nb_test_template_id/results?order[attributes]=ts&order[direction]=desc&page[offset]=1&page[limit]=5","description":"This endpoint gives the ability to retrieve results for a specified scheduled_nb_test_template. See below for available filter options for this endpoint.
See the Scheduled Test Results data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["scheduled_nb_test_templates",":scheduled_nb_test_template_id","results"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter results based on ts (timestamp). This filter allows you to provide a single operator and value(s) to filter ts and results that fall within the parameters.
For the <=>(between) operator use the filter[ts][value1] and filter[ts][value2] providing a unix timestamp for each (in milliseconds).
For the <=,<,>,>= operators use the filter[ts][value] providing a unix timestamp.
Use if filter[ts][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[ts][operator] is provided and is <=>.
Use if filter[ts][operator] is provided and is <=>.
Filter results based on severity (error: 1, warning: 4, success: 6). This filter allows you to provide a single operator and value(s) to filter severity and results that fall within the parameters.
For the <=>(between) operator use the filter[severity][value1] and filter[severity][value2] providing the desired severity values between 1 and 6.
For the <=,<,>,>= operators use the filter[severity][value] providing a value between 1 and 6.
Use if filter[severity][operator] is provided and is one of the following: <=,<,>,>=
Use if filter[severity][operator] is provided and is <=>.
Use if filter[severity][operator] is provided and is <=>.
Filter results based on ssid. You can filter on a single ssid or multiple ssids by providing the ssids ids as a comma separated list.
Filter results based on the category of the source agent. category can be one of the following values:
network_agentremote_worker_agentFilter results based on the agent_classes of the source agent. agent_classes include following categories:
containerfastewirelesscumulusexternalgigesoftwarevirtualmacwindowsigel\nYou can filter on a single agent_class or multiple agent_classes by providing the agent classes as a comma separated list.Filter results based on agents. You can filter on a single agent or multiple agents by providing the agent ids as a comma separated list.
Filter results based on last_result for each agent specified using filter[agents] or for all agents associated to the scheduled_test iffilter[agents] is not provided.
Filter results based on whether they have an alert attached to them or not. Set the parameter to true to get the results with an alert attached to them, and false to get the ones without any alerts on them.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
tsseverityUse if order[attributes] is provided and provide either asc or desc direction.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Provide the id of the scheduled_nb_test_template you wish to retrieve results for.
This endpoint gives the ability to retrieve statistics for a specified scheduled_nb_test_template. See below for available filter options for this endpoint.
See the Scheduled Test Run Statistic data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["scheduled_nb_test_templates",":scheduled_nb_test_template_id","results","statistics"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"A unix timestamp that specifies the start time of the averages timeline.
\n","type":"text/plain"},"key":"from_ts","value":"1596045659171"},{"disabled":true,"description":{"content":"A unix timestamp that specifies the end time of the averages timeline.
\n","type":"text/plain"},"key":"to_ts","value":"1596045708881"},{"description":{"content":"Order payload statistics results based on provided attribute. You may only provide a single attribute. Use in conjunction with order[direction]. Available attributes for ordering are (assuming the test type of the scheduled test template you are querying for includes them):
tserror_countwarning_countupdownlatencyjitterbwpackets_sentpackets_lostpacket_lossretriesmosbpsUse if order[attributes] is provided and provide either asc or desc direction.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Provide the id of the scheduled_nb_test_template you wish to retrieve statistics for.
This endpoint gives the ability pause or resume a specified nb_test.
See the Transition State data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["nb_tests",":nb_test_id","transition_states",":state"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide the id of the nb_test you wish to transition.
Provide the state you wish to transition the nb_test to. Use one of the following states:
pause_requested: Request the test to be paused.resume_requested: Request the test to resume.This endpoint gives the ability pause or resume a specified nb_test.
See the Transition State data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["scheduled_nb_tests",":scheduled_nb_test_id","transition_states",":state"],"host":["[HOSTNAME]"],"query":[],"variable":[{"id":"e209a83c-e7d6-4d8c-b8d4-15476eb6908f","type":"any","value":"1","key":"scheduled_nb_test_id"},{"id":"1324ee17-1cf5-4d3d-be84-912624d6236d","description":{"content":"Provide the state you wish to transition the nb_test to. Use one of the following states:
pause_requested: Request the test to be paused.resume_requested: Request the test to resume.This endpoint gives the ability pause or resume a tests for specified agents, targets, or wifi_profiles.
See the Transition State data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["nb_tests","transition_states",":state"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide the state you wish to transition nb_tests to. Use one of the following states:
pause_requested: Request the test to be paused.resume_requested: Request the test to resume.This endpoint gives the ability to retrieve wifi_profile information from the NetBeez server. See below for available filter options for this endpoint.
See the WiFi Profile data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["wifi_profiles"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter wifi_profiles based on ssid. This filter is a string search, any string matches for ssid will be provided.
Filter wifi_profiles based on description. This filter is a string search, any string matches for description will be provided.
Filter wifi_profiles based on encryption_method. You can filter on a single encryption_method or multiple encryption_methods by providing the encryption_methods as a comma separated list. Available encryption_method options are:
openwep-64wep-128wep-256wpa-pskwpa-eapFilter wifi_profiles based on authentication_method. You can filter on a single authentication_method or multiple authentication_methods by providing the authentication_methods as a comma separated list. authentication_method filter only applies for wifi_profiles where encryption_method is wpa-eap. Available authentication_methods options are:
eap-tlseap-ttlsleappeapFilter wifi_profile based on whether or not they have an open incident at the time of the request.
Depreciated: This filter has been renamed to filter[in_incident]. filter[in_incident] will no longer work in 16.0.x.
\nFilter wifi_profile based on whether or not they have an open incident at the time of the request.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
idssiddescriptionencryption_methodUse if order[attributes] is provided and use either asc or desc direction.
This endpoint gives the ability to retrieve a specific wifi_profilefrom the NetBeez server.
See the WiFi Profile data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["wifi_profiles",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide theid of the wifi_profile you wish to retrieve.
This endpoint gives the ability to create a wifi_profile on the NetBeez server.
See the WiFi Profile data structure reference for additional information.
\nNote: This endpoint does support our new JSONAPI based create/update payloads but will in the near future. This endpoint will be backwards compatible with the current format for two versions once JSONAPI based payloads have been release for this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["wifi_profiles"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[],"_postman_id":"bbc5925d-ddb9-4cc9-86b4-cc25b7ae8530"},{"name":"/wifi_profiles/:id","id":"653c6556-bfc5-46a1-b118-67310b71706b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","type":"text","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"wifi_profile\": {\n\t\t\"ssid\": \"my-ssid\",\n\t\t\"encryption_method\": \"wep-256\",\n\t\t\"description\": \"my ssids description\",\n\t\t\"network_verification_enabled\": false,\n\t\t\"preshared_key\": \"my-preshared-key\"\n\t}\n}"},"url":"https://[HOSTNAME]/wifi_profiles/:id","description":"This endpoint gives the ability to update a specific wifi_profile on the NetBeez server.
See the WiFi Profile data structure reference for additional information.
\nNote: This endpoint does not support our new JSONAPI based create/update payloads but will in the near future. This endpoint will be backwards compatible with the current format for two versions once JSONAPI based payloads have been release for this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["wifi_profiles",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide theid of the wifi_profile you wish to update.
This endpoint gives the ability to retrieve wifi_hopping_group information from the NetBeez server. See below for available filter options for this endpoint.
See the WiFi Hopping Group data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["wifi_hopping_groups"],"host":["[HOSTNAME]"],"query":[{"disabled":true,"description":{"content":"Filter wifi_hopping_group based on name. This filter is a string search, any string matches for name will be provided.
Filter wifi_hopping_group based on description. This filter is a string search, any string matches for description will be provided.
Filter wifi_hopping_group based on wifi_profiles. You can filter on a single wifi_profile or multiple wifi_profiles by providing the wifi_profiles as a comma separated list of ids.
Filter agents based on agents. You can filter on a single agent or multiple agents by providing the agents as a comma separated list of ids.
Use page[offset] to specify which page, as a number, of the results you would like to return in the payload. By default the first page is returned.
Use page[limit] to specify how many results to return on each page. The default limit is 25.
Order payload results based on provided attributes. You may provide a single attribute or multiple attributes as a comma separated list. The attributes will be applied in the order they are provided. Use in conjunction with order[direction]. You may only order attributes in the same direction. Available attributes for ordering are:
idnamedescriptionUse if order[attributes] is provided and provide either asc or desc direction.
This endpoint gives the ability to retrieve a specific wifi_hopping_group the NetBeez server.
See the WiFi Hopping Group data structure reference for additional information.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["wifi_hopping_groups",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provided theid of the wifi_hopping_group you wish to retrieve.
This endpoint gives the ability to create a wifi_hopping_group on the NetBeez server.
See the WiFi Hopping Group data structure reference for additional information.
\nNote: This endpoint does support our new JSONAPI based create/update payloads but will in the near future. This endpoint will be backwards compatible with the current format for two versions once JSONAPI based payloads have been release for this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["wifi_hopping_groups"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[],"_postman_id":"bc04f8c6-186a-4475-99ee-ddd70180363d"},{"name":"/wifi_hopping_groups/:id","id":"90b2c807-318e-468d-b75e-f89efaca408e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n\t\"wifi_hopping_group\": {\n\t\t\"name\": \"test name\",\n\t\t\"description\": \"Ut mollis felis dui.\",\n\t\t\"interval_minutes\": 20,\n\t\t\"wifi_profiles\": [100,102,66],\n\t\t\"agents\": [6059]\n\t}\n}"},"url":"https://[HOSTNAME]/wifi_hopping_groups/:id","description":"This endpoint gives the ability to update a specific wifi_hopping_group on the NetBeez server.
See the WiFi Hopping Group data structure reference for additional information.
\nNote: This endpoint does support our new JSONAPI based create/update payloads but will in the near future. This endpoint will be backwards compatible with the current format for two versions once JSONAPI based payloads have been release for this endpoint.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["wifi_hopping_groups",":id"],"host":["[HOSTNAME]"],"query":[],"variable":[{"description":{"content":"Provide theid of the wifi_hopping_group you wish to update.
The WiFi Hopping Group resource allows the retrieval of wifi_hopping_groups that assigned agents periodically jump between. wifi_hopping_groups hop between WiFi networks using the configuration defined in wifi_profiles.
This endpoint retrieves the current maintenance mode settings.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["settings","maintenance_mode"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[],"_postman_id":"abbb5775-f858-4ecf-a787-035b58b6538c"},{"name":"/settings/maintenance_mode","id":"61d86e7f-8459-4ee4-b88d-e3ede63eb695","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"data\": {\n \"id\": false,\n \"type\": \"setting/maintenance_mode\",\n \"attributes\": {\n \"enabled\": true\n }\n }\n}"},"url":"https://[HOSTNAME]/settings/maintenance_mode","description":"This endpoint is used to update the maintenance mode settings.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}},"urlObject":{"protocol":"https","path":["settings","maintenance_mode"],"host":["[HOSTNAME]"],"query":[],"variable":[]}},"response":[],"_postman_id":"61d86e7f-8459-4ee4-b88d-e3ede63eb695"}],"id":"fecd522d-3c5c-46d2-8baa-a1469aa7bff5","event":[{"listen":"prerequest","script":{"id":"7acc19e6-15b6-47de-b9d9-8aaf44e5139c","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c362fdda-4837-42c4-b653-116dc9caf6e5","type":"text/javascript","exec":[""]}}],"_postman_id":"fecd522d-3c5c-46d2-8baa-a1469aa7bff5","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}}}],"id":"aec9b7dd-6498-4ce3-9a3a-bfbe18f2f4f0","_postman_id":"aec9b7dd-6498-4ce3-9a3a-bfbe18f2f4f0","description":"","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]},"isInherited":true,"source":{"_postman_id":"2497eaca-6106-40b1-acac-7366b290def4","id":"2497eaca-6106-40b1-acac-7366b290def4","name":"NetBeez API","type":"collection"}}},{"name":"Reference","item":[{"name":"Data Resources","item":[{"name":"Access Point","item":[],"id":"50d998a0-90a2-4b35-8ca8-4899dd8cd3ae","description":"An access_point represents WiFi access points that a wireless agent connects to. access_point does not have any user defined attributes and cannot be modified through the API.
An access_point_connection represents the connection of a wireless agent to a wifi_profile and the timing of each phase of the connection.
An agent represents a hardware or software agent that can run various network tests and return the test results. Refer to the User Defined? column to determine which attributes can be used when utilizing POST or PUT endpoints.
When using the bulk updating API you must also supply the id attribute. The id must be the id of an existing agent and this id is not used to update the id of an agent but to look up and identify an agent that the change is to be applied to.
An agent_performance_metric represents the status of an agents resources at a particular point in time.
An agent_group represents groups of agents. An agent_group also can ensure associated agents all run the same targets.
An agent_log represents various log messages that may be received from an agent.
An alert represents an issue encountered by an agent while running assigned tests based on configured alert_detectors.
An alert_detector represents the conditions in which a test run by an agent should trigger an alert.
An dns_result represents the recorded value of a dns_test that was run by an agent.
A dns_test represents the configuration that is used when an agent tests DNS.
generated_report.attributes.data contains attributes that represent the generated data for the givenreport_type. See below for the attributes for each report_type.
generated_report.attributes.parameters contains attributes that define how the specified report_type should be created. See below for the valid attributes for each report_type.
A generated_report represents a report that was created either from a scheduled_report or by a user requesting it ad-hoc.
A grouped_alert_count represents the number of alerts by severity per agent.
An http_result represents the recorded value of a http_test that was run by an agent.
A http_test represents the configuration that is used when an agent tests HTTP.
An incident represents a detected problem with an agent based on a configured threshold of alerts.
A ipref_test represents the configuration that is used when an agent tests Iperf.
A monitoring_condition consists of the following attributes:
A multiagent_nb_test_run consists of the following attributes:
A nb_test consists of the following attributes:
A nb_test will also include one of the following relationships based on test_type.
An network_interface represents a single network interface of a given agent. An agent will have at least one network_interface and may have multiple interfaces. network_interface does not have any user defined attributes and cannot be modified through the API.
supplemental information for a path_analsysi_result consists of the following attributes:
A path_analysis_result consists of the following attributes:
Below are the options if the nb_test test_type is path_analysis:
The following attributes of a ping_result:
A result also consists of the following relationships:
Below are the options if the nb_test test_type is ping_test:
A scheduled_report represents the criteria, report_type, and the schedule for which a generated_report will be created.
A scheduled_test_result consists of the following attributes:
A scheduled_test_result_average consists of the following attributes:
A scheduled_nb_test_template consists of the following attributes:
A scheduled_test_template will also include one of the following list of attributes based on test_type.
Below are the options if the nb_test test_type is scheduled speedtest:
NetBeez gives you a simplified way of generating a target. Users will provide basic information and Netbeez will handle the rest of the configuration with pre-defined defaults.
\n","_postman_id":"521f47b5-bb2c-4cdb-b09e-b766b50fc238","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0b1aaabc-12ef-494d-89a7-3a0ccd148aa3","id":"0b1aaabc-12ef-494d-89a7-3a0ccd148aa3","name":"Reference","type":"folder"}}},{"name":"Saas Target","item":[],"id":"4a20f542-9897-485b-8cd6-b95865f4af64","description":"NetBeez gives you an easy way to set up monitoring for popular SaaS platforms using the /targets/saas endpoint. See below for available SaaS options. If SaaS has additional configuration see corresponding table below.
\n","_postman_id":"4a20f542-9897-485b-8cd6-b95865f4af64","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0b1aaabc-12ef-494d-89a7-3a0ccd148aa3","id":"0b1aaabc-12ef-494d-89a7-3a0ccd148aa3","name":"Reference","type":"folder"}}}],"id":"b4e7de06-0045-4856-a102-1856ab5dff25","description":"A target represents a set of resources that need to be monitored as a unit. It consists of multiple test_templates.
A test_template describes a type of test and how it should be performed and alerted on, with the destination being a specific FQDN, IP address (and port, wherever is applicable) or URL (in the case of HTTP).
The following paragraphs will describe test-type specific attributes that are included with the common attributes described above.
\nA traceroute_result consists of the following attributes:
hops under a traceroute_result consists of the following attributes:
Below are the options if the nb_test test_type is traceroute:
Transition all tests by using one of the following attributes. You must use one of the following.
\n","_postman_id":"97ba51c9-65db-424a-a8bc-db275042cb58","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"0b1aaabc-12ef-494d-89a7-3a0ccd148aa3","id":"0b1aaabc-12ef-494d-89a7-3a0ccd148aa3","name":"Reference","type":"folder"}}},{"name":"VoIP Test","item":[],"id":"833e6220-0261-413c-b28d-e28c24193010","description":"Below are the options if the nb_test test_type is scheduled voip_test:
A wifi_hopping_group represents a group of between 2 and 4 wifi_profiles in which a wireless agent will \"hop\" between at a given interval.
A wifi_profile represents a wireless network an agent can connect to.
Before we started implementing JSONAPI payload support for POST and PUT requests you were required to provide all information regarding relationships when making a request. This required consumers of the API to make additional API calls to gather the required information making it cumbersom to use.
\nYou have a Target and has a currently relationship to Agents 1, 2, and 3. Now you wanted to also add Agent 4 to the Target. That meant you needed to provided Agent ids 1, 2, 3, and 4. Otherwise providing just Agent 4 would remove Agents 1, 2, and 3.
{\n \"target\": {\n ...\n \"agent_ids\": [4] // Agents 1, 2, 3 will be removed.\n ...\n }\n}\n{\n \"target\": {\n ...\n \"agent_ids\": [1,2,3,4] // Agent 4 is added to 1, 2, and, 3.\n ...\n }\n}\n\nWith JSONAPI payloads for POST and PUT requests we can now support upserting of associations. That means consumers of the API will no longer have to provide all ids of an association in order to add or remove them.
\nYou have a Target and has a currently relationship to Agents 1, 2, and 3. Now you wanted to also add Agent 4 to the Target. This means you can upsert only Agent 4 to the Target without needing to know the currently related Agents.
{\n \"data\": {\n \"id\": \"1\",\n \"type\": \"target\",\n \"attributes\": {\n ...\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n { \n \"id\": \"4\",\n \"type\": \"agent\" // Upsert Agent 4 to add to Target.\n }\n ]\n }\n }\n }\n}\n\nLike wise with JSONAPI payloads for POST and PUT requests we can request the removal of relationships. That means consumers of the API will no longer have to provide all ids of the remaining related Agents.
You have a Target and has a currently relationship to Agents 1, 2, 3, and 4. Now you wanted to remove Agent 4 from the Target. This means you can remove only Agent 4 to the Target without needing to know the all the Agents that should remain related.
{\n \"data\": {\n \"id\": \"1\",\n \"type\": \"target\",\n \"attributes\": {\n ...\n },\n \"relationships\": {\n \"agents\": {\n \"data\": [\n { \n \"id\": \"4\",\n \"type\": \"agent\",\n \"method\": \"remove\" // Add 'method' with value 'remove' to remove Agent 4.\n }\n ]\n }\n }\n }\n}\n\nHere you'll find reference information on the various data resources in NetBeez. Each resource will describe its attributes, attribute data types, description, and in some cases if the attribute is user defined and can be modified. We will also provide other relevant information when necessary.
\n","auth":{"type":"noauth","isInherited":false},"_postman_id":"0b1aaabc-12ef-494d-89a7-3a0ccd148aa3"},{"name":"Changelog","item":[{"name":"Version 14.0","item":[],"id":"148e11f8-b744-472c-bb75-1fecd979c883","description":"Agent APIs
\nopen_incident, such that all agents with an open incident will appear before / after agents without an incidentTarget APIs
\n[ADDED]
\nTarget index route can now be sorted by open_incident, such that all targets with an open incident will appear before / after targets without an incident
Depreciations will be removed in version15.0, please update your integrations.
open_incient_id will no longer be available as an Agent attribute and will instead be provided as a relationship. You can find if an Agent has an open incident via \"relationships\" -> \"open_incident\".wifi_profile_id will no longer be available as an Agent attribute and will instead be provided as a relationship. You can find if an Agent has a WifiProfile via \"relationships\" -> \"wifi_profile\" if the Agent is wireless.wifi_hopping_group_id will no longer be available as an Agent attribute and will instead be provided as a relationship. You can find if an Agent has an open incident via \"relationships\" -> \"wifi_hopping_group\" if the Agent is wireless./incidents resource.last_result when using GET /scheduled_nb_test_templates/:scheduled_nb_test_template_id/results with filter[last_result] ./agents/:id/logs with included[alerts] parameter./alerts resource./nb_tests/dns/results resource./nb_tests/http/results resource./nb_tests/ping/results resource.active_ts when using GET /agents with filter[active_ts]./alert_detectors resource./nb_tests/:id/transition_states/:state./nb_tests/transition_states/:state.error_state when using GET /agents/:agent_id/access_point_connections with filter[error_states] .Depreciations will be removed in 12.0__, please use renamed filters.
/agents, filter[status] has been renamed to filter[active]./agents, filter[agent_class] has been renamed to filter[agent_classes]./agents, filter[category] has been renamed to filter[categories]./generated_reports, filter[report_type] has been renamed to filter[report_types]./scheduled_nb_test_templates, filter[test_type_id] has been renamed to filter[test_types]./nb_tests/traceroutes/results, filter[nb_test_templates] has been renamed to filter[test_templates]./nb_tests/path_analysis/results resource./nb_tests/traceroutes/results resource./agents resource./agent_groups resource./reports/generated_reports resource./scheduled_nb_test_templates/:id/results resource./scheduled_nb_test_templates/:id/results/statistics resource./scheduled_nb_test_templates resource./wifi_profiles resource./agents/:id/logs resource./agents/:agent_id/access_point_connections resource.As of 4.0, the V1 version of our API is deprecated. The V1 version will continue to receive support for bug fixes but will not receive any further enhancements. This is to allow us to focus our efforts on expanding our new API offering to our customers introduced in 4.0. The V1 version will continue to exist until we have released comparable functionality through our new API. During this time customers who have deployed public dashboards will not notice any changes in functionality and they will continue to work as expected.
\n","_postman_id":"edd224ff-68ed-4191-bd1a-f4cc37884e30","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"ab987a8f-1301-43a3-8a23-5a38388f6bbd","id":"ab987a8f-1301-43a3-8a23-5a38388f6bbd","name":"Changelog","type":"folder"}}}],"id":"ab987a8f-1301-43a3-8a23-5a38388f6bbd","description":"The Changelog details changes made to NetBeez API functionality. Changes for each version of NetBeez can be found below.
\n","auth":{"type":"noauth","isInherited":false},"_postman_id":"ab987a8f-1301-43a3-8a23-5a38388f6bbd"}],"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"[API_KEY]"}]}},"event":[{"listen":"prerequest","script":{"id":"dd2023e4-9248-4924-98d8-68398857f066","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"be070534-b528-4047-b0bb-81e27b7939ae","type":"text/javascript","exec":[""]}}],"variable":[{"key":"HOSTNAME","value":"[HOSTNAME]"},{"key":"API_KEY","value":"[API_KEY]"}]}