Skip to main content

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.

Netbox RIPE Updater is a Docker Compose wrapper around the ripe-updater service that automatically synchronizes IP prefix data from NetBox into the RIPE database. When you create, update, or delete a prefix in NetBox, the updater responds to the webhook and propagates the change to RIPE — keeping your registration data accurate without manual intervention.

Quickstart

Deploy the stack and connect NetBox to RIPE in under 15 minutes

Environment variables

Full reference for all configuration options in .env and .env.updater

NetBox setup

Configure custom fields, regions, and webhooks in NetBox

Templates

Define RIPE object attributes with JSON templates

Backups

Browse and restore S3-backed RIPE object backups

API endpoints

HTTP endpoints exposed by the updater service

How it works

The updater runs as a Flask application inside a Docker container. NetBox sends a webhook to the /update endpoint whenever a prefix is created, updated, or deleted. The updater then:
  1. Validates the incoming webhook and checks the ripe_report custom field
  2. Queries NetBox for full prefix details, including region, aggregate, and custom fields
  3. Renders a RIPE INETNUM or INET6NUM object using your JSON templates
  4. Pushes the object to the RIPE REST API (or deletes it if ripe_report is false or the prefix was deleted)
  5. Stores a backup of any overwritten or deleted object in Minio (S3-compatible)

Key features

  • Automatic synchronization — NetBox webhooks trigger RIPE updates with no manual steps
  • Custom NETNAME — Set per-prefix ripe_netname in NetBox to control the NETNAME attribute
  • S3-backed backups — Every overwritten or deleted RIPE object is backed up to Minio
  • Template system — JSON templates control RIPE object attributes, with inheritance support
  • IPv4 and IPv6 — Manages both INETNUM and INET6NUM objects
  • RIPE API key auth — Authenticates to RIPE using API credentials with a built-in rotation script
  • Backup UI — Browse and download backed-up RIPE objects through a protected web interface

Requirements

  • Docker and Docker Compose
  • A running NetBox instance (v2.4 or later)
  • RIPE DB access with write permissions to your INET(6)NUM objects

Build docs developers (and LLMs) love