> ## Documentation Index
> Fetch the complete documentation index at: https://docs.keephq.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# NetBox

> NetBox provider allows you to get events from NetBox through webhook.

## Overview

NetBox is the leading solution for modeling and documenting modern networks. By combining the traditional disciplines of IP address management (IPAM) and datacenter infrastructure management (DCIM) with powerful APIs and extensions, NetBox provides the ideal "source of truth" to power network automation. Read on to discover why thousands of organizations worldwide put NetBox at the heart of their infrastructure.

## Connecting NetBox to Keep

To connect NetBox to Keep, you need to create a webhook in NetBox.

1. Go to NetBox dashboard, click on `Webhooks` under `Operations` section in the sidebar.

<Frame width="100" height="200">
  <img height="10" src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/netbox-provider_1.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=a1c9690cd41efbb3d2f7f04e763f5b2f" data-path="images/netbox-provider_1.png" />
</Frame>

2. Add a new webhook by clicking on `Add` button.

<Frame width="100" height="200">
  <img height="10" src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/netbox-provider_2.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=8407aa930727a366df69dc86d885d4c1" data-path="images/netbox-provider_2.png" />
</Frame>

3. Enter [https://api.keephq.dev/alerts/event/netbox](https://api.keephq.dev/alerts/event/netbox) as the URL and select the request method as `POST`.

4. Follow the below steps to create a new API key in Keep.

5. Go to Keep dashboard and click on the profile icon in the botton left corner and click `Settings`.

<Frame width="100" height="200">
  <img height="10" src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/netbox-provider_4.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=b35c07c5a4768a645e600e1aed094310" data-path="images/netbox-provider_4.png" />
</Frame>

6. Select `Users and Access` tab and then select `API Keys` tab and create a new API key.

<Frame width="100" height="200">
  <img height="10" src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/netbox-provider_5.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=86fde7d4ad9ecf31385098597738e6ea" data-path="images/netbox-provider_5.png" />
</Frame>

7. Give name and select the role as `webhook` and click on `Create API Key`.

<Frame width="100" height="200">
  <img height="10" src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/netbox-provider_6.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=e0c8bcaf005a3e2be00d407c1cbd21c7" data-path="images/netbox-provider_6.png" />
</Frame>

8. In the `Additional headers` field enter `X-API-KEY` as the key and the API key generated in step 7 as the value. It should look like below. Refer the screenshot from step 3.

```
X-API-KEY: your-api-key
```

9. Disable the `SSL verification` (Optional) or enable it based on your requirement.

<Frame width="100" height="200">
  <img height="10" src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/netbox-provider_7.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=1b729fbf71ff48af3b545db97200a0df" data-path="images/netbox-provider_7.png" />
</Frame>

10. Click on `Save` to save the webhook.

11. Go to `Event Rules` under `Operations` section in the sidebar and click on `Add` button to create a new event rule.

<Frame width="100" height="200">
  <img height="10" src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/netbox-provider_8.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=a06f1076cf6b7d04c03bcd1cb71390a4" data-path="images/netbox-provider_8.png" />
</Frame>

12. Fill the required fields based on your requirement. Select the `Object types` and `Event types` for which you want to receive the events.

<Frame width="100" height="200">
  <img height="10" src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/netbox-provider_9.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=b838134d4ac916d1d1bda64a24064206" data-path="images/netbox-provider_9.png" />
</Frame>

13. In the `Action type` select `Webhook` and select the webhook created in step 3 and click on `Save`.

<Frame width="100" height="200">
  <img height="10" src="https://mintcdn.com/keep-docs/S6DFtL8OlXzhsodk/images/netbox-provider_10.png?fit=max&auto=format&n=S6DFtL8OlXzhsodk&q=85&s=bab2737ce626c119f0758f5e37f6766c" data-path="images/netbox-provider_10.png" />
</Frame>

Now, you have successfully connected NetBox to Keep. You will start receiving the events in Keep based on the event rules you have created.

## Useful Links

* [NetBox](https://netboxlabs.com/)

## In workflows

This provider can't be used as a "step" or "action" in workflows. If you want to use it, please let us know by creating an issue in the [GitHub repository](https://github.com/keephq/keep/issues).