# APIs & Developer Support

**URL:** https://community.netbeez.net/c/developer/12.md

[Latest](https://community.netbeez.net/latest.md) · [Categories](https://community.netbeez.net/categories.md) · [Tags](https://community.netbeez.net/tags.md)

---

## [About the APIs & Developer Support category](https://community.netbeez.net/t/about-the-apis-developer-support-category/47)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0

</div>

Working on a custom integration, extension, or add-on? Share your project, advice on how you solved specific problems, or get help with your code and API challenges. This category is actively monitored by our Support tea…

---

## [NetBeez Webhook payload reference](https://community.netbeez.net/t/netbeez-webhook-payload-reference/320)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [April 17, 2026, 10:43am UTC](https://community.netbeez.net/t/netbeez-webhook-payload-reference/320 "2026-04-17T10:43:23Z")

</div>

NetBeez Webhook Payloads Reference Reference for the JSON payloads that the NetBeez platform POSTs to a configured webhook endpoint for each supported notification case. Read this if you are building the consumer side …

---

## [Running Ad-hoc Custom Command Tests through the API](https://community.netbeez.net/t/running-ad-hoc-custom-command-tests-through-the-api/318)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [March 16, 2026, 9:50am UTC](https://community.netbeez.net/t/running-ad-hoc-custom-command-tests-through-the-api/318 "2026-03-16T09:50:20Z")

</div>

NetBeez’s BeezKeeper API supports ad-hoc custom command tests. You can trigger on-demand custom script runs from one or more agents and retrieve the parsed results (e.g. for dashboards or automation). How It Works Crea…

---

## [How to Send Webhooks from NetBeez to Zapier](https://community.netbeez.net/t/how-to-send-webhooks-from-netbeez-to-zapier/309)

<div class="topic-metadata">

**Author:** [@stefano](https://community.netbeez.net/u/stefano)\
**Replies:** 0\
**Last updated:** [October 15, 2025, 11:44am UTC](https://community.netbeez.net/t/how-to-send-webhooks-from-netbeez-to-zapier/309 "2025-10-15T11:44:51Z")

</div>

Do you want to automate workflows with data from your NetBeez dashboard? You can easily send notifications of alerts or incidents from NetBeez to Zapier using webhooks. Here’s how: In Zapier, create a new Zap and cho…

---

## [Getting availability metrics for an Agent or a Target](https://community.netbeez.net/t/getting-availability-metrics-for-an-agent-or-a-target/243)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [January 3, 2025, 7:07pm UTC](https://community.netbeez.net/t/getting-availability-metrics-for-an-agent-or-a-target/243 "2025-01-03T19:07:55Z")

</div>

I’ve been asked a few times regarding retrieving the availability metrics for Agents and Targets in order to report them in third-party dashboards. Here’s how we calculate these metrics and how the get them through the A…

---

## [Agents to Agent Groups based on name](https://community.netbeez.net/t/agents-to-agent-groups-based-on-name/241)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [December 16, 2024, 3:56pm UTC](https://community.netbeez.net/t/agents-to-agent-groups-based-on-name/241 "2024-12-16T15:56:00Z")

</div>

Hello community! Many of you have asked us if it is possible to add agents into various agent groups based on their name. Even though we have this recorded as a feature request, there is a way to do this through the API…

---

## [Creating Custom Targets using the NetBeez API](https://community.netbeez.net/t/creating-custom-targets-using-the-netbeez-api/215)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [July 1, 2024, 5:41pm UTC](https://community.netbeez.net/t/creating-custom-targets-using-the-netbeez-api/215 "2024-07-01T17:41:01Z")

</div>

An essential part of automating your NetBeez configuration is the ability to add targets to your monitoring setup programmatically. I can think of two ways where this can be used for. First, by setting up automation scr…

---

## [How to Use the Agent Collection API Endpoint](https://community.netbeez.net/t/how-to-use-the-agent-collection-api-endpoint/68)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 1\
**Last updated:** [March 27, 2024, 5:55pm UTC](https://community.netbeez.net/t/how-to-use-the-agent-collection-api-endpoint/68 "2024-03-27T17:55:58Z")

</div>

Hello, API enthusiasts! Today, we’re diving into the Agent Collection API endpoint. With this powerful API, you can fetch a collection of agents, filter, order, and paginate the result set. In this post, we’ll walk you t…

---

## [Exporting Agent Data in CSV Using the NetBeez Agents Collection API in Python](https://community.netbeez.net/t/exporting-agent-data-in-csv-using-the-netbeez-agents-collection-api-in-python/78)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 1\
**Last updated:** [March 27, 2024, 5:54pm UTC](https://community.netbeez.net/t/exporting-agent-data-in-csv-using-the-netbeez-agents-collection-api-in-python/78 "2024-03-27T17:54:30Z")

</div>

The Agents Collection API provided by NetBeez allows us to retrieve extensive data about our network and remote worker agents. This tutorial demonstrates how to retrieve information for all agents using pagination and ou…

---

## [Cloning Scheduled Tests with Modified Source, Destination, and Schedule Using the NetBeez API](https://community.netbeez.net/t/cloning-scheduled-tests-with-modified-source-destination-and-schedule-using-the-netbeez-api/146)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [January 19, 2024, 4:33am UTC](https://community.netbeez.net/t/cloning-scheduled-tests-with-modified-source-destination-and-schedule-using-the-netbeez-api/146 "2024-01-19T04:33:33Z")

</div>

Looking to create a new scheduled test based on an existing one, but with some adjustments to the source, destination, or schedule? The NetBeez API makes it easy to achieve this! In this guide, we’ll walk you through th…

---

## [Retrieving the Latest Results for Scheduled Tests with the NetBeez API](https://community.netbeez.net/t/retrieving-the-latest-results-for-scheduled-tests-with-the-netbeez-api/145)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [January 19, 2024, 3:47am UTC](https://community.netbeez.net/t/retrieving-the-latest-results-for-scheduled-tests-with-the-netbeez-api/145 "2024-01-19T03:47:56Z")

</div>

Want to quickly access the most recent results for each agent running a scheduled test? The NetBeez API makes it a breeze! In this guide, we’ll walk you through the process of retrieving the latest results using the API. …

---

## [Fetching Ping Results from a Specific Agent using NetBeez API into a CSV file](https://community.netbeez.net/t/fetching-ping-results-from-a-specific-agent-using-netbeez-api-into-a-csv-file/106)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [August 23, 2023, 6:38pm UTC](https://community.netbeez.net/t/fetching-ping-results-from-a-specific-agent-using-netbeez-api-into-a-csv-file/106 "2023-08-23T18:38:36Z")

</div>

In this guide, we’ll demonstrate how to write a Python script to fetch all ping results from a specific agent within a given time range, using NetBeez’s API. The results will be saved in a CSV file, with each timestamp p…

---

## [Running Ad-hoc Network Speed Tests through the API](https://community.netbeez.net/t/running-ad-hoc-network-speed-tests-through-the-api/110)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 2\
**Last updated:** [October 12, 2023, 8:46pm UTC](https://community.netbeez.net/t/running-ad-hoc-network-speed-tests-through-the-api/110 "2023-10-12T20:46:35Z")

</div>

NetBeez’s BeezKeeper API in v.13.0 introduces a new set of endpoints designed to execute network speed tests. With these API calls, you can seamlessly integrate on-demand network speed tests into third-party dashboards. …

---

## [How to Download NetBeez Path Analysis Results Using Python Script](https://community.netbeez.net/t/how-to-download-netbeez-path-analysis-results-using-python-script/117)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [October 11, 2023, 1:08pm UTC](https://community.netbeez.net/t/how-to-download-netbeez-path-analysis-results-using-python-script/117 "2023-10-11T13:08:15Z")

</div>

Are you looking to retrieve path analysis results from the NetBeez BeezKeeper API for further analysis or reporting? With the provided Python script, you can easily download all the path analysis results and store them i…

---

## [Create New Iperf, Network Speed or VoIP Tests Using the API](https://community.netbeez.net/t/create-new-iperf-network-speed-or-voip-tests-using-the-api/111)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [October 3, 2023, 8:26pm UTC](https://community.netbeez.net/t/create-new-iperf-network-speed-or-voip-tests-using-the-api/111 "2023-10-03T20:26:31Z")

</div>

Introduction Managing scheduled tests via API offers significant advantages, especially for large-scale deployments with hundreds of agents. It streamlines configuration, ensures consistency, and facilitates automation. …

---

## [Timestamp Script](https://community.netbeez.net/t/timestamp-script/105)

<div class="topic-metadata">

**Author:** [@SebastianCoros](https://community.netbeez.net/u/SebastianCoros)\
**Replies:** 1\
**Last updated:** [August 23, 2023, 6:42pm UTC](https://community.netbeez.net/t/timestamp-script/105 "2023-08-23T18:42:27Z")

</div>

Good afternoon team, Hope all is well. I was wondering if you have a script that would return the data from the API with the real timestamp rather than the epoch time? Kind Regards, Sebastian

---

## [How to bulk-remove agents from the dashboard using the API](https://community.netbeez.net/t/how-to-bulk-remove-agents-from-the-dashboard-using-the-api/97)

<div class="topic-metadata">

**Author:** [@Anton](https://community.netbeez.net/u/Anton)\
**Replies:** 0\
**Last updated:** [July 25, 2023, 7:11pm UTC](https://community.netbeez.net/t/how-to-bulk-remove-agents-from-the-dashboard-using-the-api/97 "2023-07-25T19:11:37Z")

</div>

Hello NetBeez community! I am a software engineer at NetBeez and I am going to show some simple steps to remove agents from the dashboard in bulk using the API. This is useful when we need to remove a large number of age…

---

## [How to Use the Agent Collection API Endpoint in Google Sheets](https://community.netbeez.net/t/how-to-use-the-agent-collection-api-endpoint-in-google-sheets/89)

<div class="topic-metadata">

**Author:** [@bill](https://community.netbeez.net/u/bill)\
**Replies:** 2\
**Last updated:** [July 10, 2023, 6:43pm UTC](https://community.netbeez.net/t/how-to-use-the-agent-collection-api-endpoint-in-google-sheets/89 "2023-07-10T18:43:10Z")

</div>

Hello, Community! Today, we’re exploring how to leverage the Agent Collection API endpoint using Google Sheets, specifically with the built-in Apps Script feature. This powerful API allows you to fetch a collection of ag…

---

## [API requests for specific speed test results](https://community.netbeez.net/t/api-requests-for-specific-speed-test-results/56)

<div class="topic-metadata">

**Author:** [@snorkel](https://community.netbeez.net/u/snorkel)\
**Replies:** 2\
**Last updated:** [May 8, 2023, 4:24pm UTC](https://community.netbeez.net/t/api-requests-for-specific-speed-test-results/56 "2023-05-08T16:24:49Z")

</div>

We’re working on trying to build some custom reporting in Netbeez regarding remote worker network performance. We have regularly scheduled speed tests for our remote workers. what we’d like to be able to do is query for …

---

## [Rate Limits For API](https://community.netbeez.net/t/rate-limits-for-api/50)

<div class="topic-metadata">

**Author:** [@Carey\_Casile](https://community.netbeez.net/u/Carey_Casile)\
**Replies:** 1\
**Last updated:** [April 6, 2023, 7:47pm UTC](https://community.netbeez.net/t/rate-limits-for-api/50 "2023-04-06T19:47:32Z")

</div>

Are there any rate limits for the API? Are there any other things to take into account or any tips for using the API?

---

## [Automatically Rename Remote Worker Agents based on the employee’s HR profile](https://community.netbeez.net/t/automatically-rename-remote-worker-agents-based-on-the-employee-s-hr-profile/48)

<div class="topic-metadata">

**Author:** [@panickos](https://community.netbeez.net/u/panickos)\
**Replies:** 0\
**Last updated:** [April 6, 2023, 12:20am UTC](https://community.netbeez.net/t/automatically-rename-remote-worker-agents-based-on-the-employee-s-hr-profile/48 "2023-04-06T00:20:02Z")

</div>

I wanted to share a useful script for those of you managing more than 100 remote worker agents on your NetBeez BeezKeeper. This script was developed from a customer request who manages over 10000 remote worker agents. Th…
