Before Netbox RIPE Updater can synchronize prefix data with RIPE-DB, NetBox must be configured with a set of custom fields that carry RIPE-specific metadata, a region hierarchy that maps sites to ISO 3166-1 country codes, and a webhook that fires on every prefix create, update, or delete event. Without these three pieces in place the updater has no way to determine which prefixes should be reported, which RIPE template to apply, or which country to associate with an object.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/jalmargyyk/netbox-ripe-updater/llms.txt
Use this file to discover all available pages before exploring further.
Custom fields
Four custom fields are required. Add them under Customization → Custom Fields in the NetBox admin interface.lir — Local Internet Registry
| Property | Value |
|---|---|
| Name | lir |
| Label | LIR |
| Assigned models | IPAM → Aggregates |
| Type | Selection |
| Required | Yes |
| Choices | One entry per LIR you are responsible for |
| Description | RIPE Local Internet Registry |
lir_org.json template file.
ripe_report — RIPE reporting flag
| Property | Value |
|---|---|
| Name | ripe_report |
| Label | RIPE Report |
| Assigned models | IPAM → Prefixes |
| Type | Boolean |
| Required | No |
| Default | false |
| Description | Should this prefix be in RIPE-DB |
true on any prefix you want the updater to create or maintain in RIPE-DB. Prefixes with this field absent or set to false are ignored.
ripe_template — Template selector
| Property | Value |
|---|---|
| Name | ripe_template |
| Label | RIPE Template |
| Assigned models | IPAM → Prefixes |
| Type | Selection |
| Required | No |
| Choices | One entry per template defined in templates.json |
templates.json file. The value must exactly match a key in that file (e.g. CLOUD-POOL or CUST-ACCESS-NET).
ripe_netname — RIPE netname override
| Property | Value |
|---|---|
| Name | ripe_netname |
| Label | RIPE Netname |
| Assigned models | IPAM → Prefixes |
| Type | String |
| Required | No |
netname attribute on the INETNUM or INET6NUM object instead of the automatically derived value.
Region setup
The updater derives the two-letter country code from the slug of a site’s parent region. For example, a region with slug
gb maps to the United Kingdom. Ensure your country regions use lowercase ISO 3166-1 alpha-2 slugs (e.g. de, nl, gb).DEFAULT_COUNTRY value set in .env.updater.
Create country regions
In NetBox, go to Organization → Regions and create a region for each country you operate in. Set the slug to the lowercase ISO 3166-1 alpha-2 code for that country (e.g.
gb for the United Kingdom, de for Germany, nl for the Netherlands).Webhook
The webhook tells NetBox to notify the updater whenever a prefix is created, updated, or deleted.Set HTTP request options
| Field | Value |
|---|---|
| HTTP method | POST |
| Payload URL | http(s)://your-ripe-updater-host/update |
| HTTP content type | application/json |
Assign models
Under Assigned models, select IPAM → Prefix. The webhook fires only for prefix objects.
Add the authorization header
If you have set Replace
UPDATE_TOKEN in .env.updater, add a matching header under Additional headers:YOURTOKEN with the exact value you set for UPDATE_TOKEN. The updater rejects any webhook request that does not carry this header when the token is configured.Environment variables
Review all application and Docker Compose variables.
Templates
Define RIPE object attributes using the JSON template system.