Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/grizzlyware/netbox-ripe-updater/llms.txt

Use this file to discover all available pages before exploring further.

The ripe-updater Flask application exposes four HTTP endpoints. Three are used for operational purposes and one is the core webhook receiver that processes NetBox prefix events.

​
GET /health

No authentication required. Returns the plain text string Ok with HTTP 200. Use this endpoint for health checks from a monitoring system or load balancer probe. 
curl http://your-ripe-updater-host/health
Response 
Ok
StatusMeaning
200 OKService is running

​
POST /update

The core webhook receiver. NetBox calls this endpoint whenever a prefix is created, updated, or deleted. The endpoint authenticates via a token header, validates the payload, then creates, updates, or deletes the corresponding RIPE inetnum/inet6num object.

​
Authentication

​
Authorisation
string
Token-based authentication header. Required only when UPDATE_TOKEN is set in .env.updater. Value must exactly match UPDATE_TOKEN. Note the British spelling of Authorisation (with an s). Returns 401 if the header value does not match.

​
Request

​
Content-Type
string
required
Must be application/json.
The request body is the standard NetBox webhook JSON payload. The following fields are read by the updater:
​
model
string
required
Must be "prefix". Any other value returns 400 Bad Request with the message only prefixes are supported.
​
event
string
required
The NetBox event type. One of "created", "updated", or "deleted". A "deleted" event always triggers deletion of the RIPE object regardless of ripe_report.
​
data.prefix
string
required
The prefix string, e.g. 192.0.2.0/24 or 2001:db8::/32.
​
data.custom_fields.ripe_report
boolean
required
When true and the event is not "deleted", the RIPE object is created or updated. When false, the RIPE object is deleted.
​
data.custom_fields.ripe_template
string
required
The template key to use when building the RIPE object. Must match a key in templates.json (matched case-sensitively after uppercasing).
​
data.custom_fields.ripe_netname
string
Optional. Overrides the netname attribute on the RIPE object. When not set, the netname is derived from the ripe_template value.
​
username
string
Optional. The NetBox username who triggered the webhook event. Used in log output and email reports. If absent, the updater logs "None" as the username.

​
Behaviour

ConditionAction
ripe_report=falseDelete the RIPE object
event="deleted"Delete the RIPE object
ripe_report=true and event is "created" or "updated"Create or update the RIPE object
Two exceptions are caught and returned as 200 rather than errors:
  • NotRoutedNetwork — the prefix is an RFC1918 or otherwise non-routable address; the request is skipped silently.
  • ErrorSmallPrefix — the prefix length exceeds SMALLEST_PREFIX_V4 (default 31) or SMALLEST_PREFIX_V6 (default 127); the request is skipped silently.

​
Response codes

StatusMeaning
204 No ContentOperation succeeded
200 OKPrefix skipped (NotRoutedNetwork or ErrorSmallPrefix)
400 Bad RequestInvalid payload, missing fields, or unsupported model type
401 UnauthorizedToken mismatch
500 Internal Server ErrorRIPE DB operation failed

​
Example

curl -X POST http://your-ripe-updater-host/update \
  -H "Authorisation: Token mysecrettoken" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "prefix",
    "event": "updated",
    "data": {
      "prefix": "192.0.2.0/24",
      "custom_fields": {
        "ripe_report": true,
        "ripe_template": "CLOUD-POOL",
        "ripe_netname": "EXAMPLE-NET"
      }
    }
  }'

​
GET /backups

Lists all backup files stored in S3. Requires HTTP Basic Auth using UI_USER and UI_PASSWORD from .env.updater. Returns an HTML page. Returns 401 if unauthenticated. A backup is automatically saved for any prefix that exists in the RIPE DB before it is overwritten or deleted. 
curl -u admin:password http://your-ripe-updater-host/backups
StatusMeaning
200 OKHTML page listing backup files
401 UnauthorizedMissing or incorrect Basic Auth credentials

​
GET /backup/{name}

Returns the JSON content of a single backup file. Requires HTTP Basic Auth using UI_USER and UI_PASSWORD. Use this endpoint to retrieve a specific backup before restoring it manually via the RIPE REST API.

​
Path parameter

​
name
string
required
The backup filename. Filenames follow the pattern prefix_<prefix>_<length>.json, where / in the prefix is replaced with _. For example, 192.0.2.0/24 becomes prefix_192.0.2.0_24.json.

​
Response

​
objects
object
The full RIPE DB JSON representation of the backed-up inetnum or inet6num object, as returned by the RIPE REST API at the time of backup.
curl -u admin:password \
  http://your-ripe-updater-host/backup/prefix_192.0.2.0_24.json
To restore the backup, post the file directly to the RIPE REST API: 
curl --user "RIPE_API_USER:RIPE_API_PASS" \
  -X POST \
  -H 'Content-Type: application/json' \
  --data @prefix_192.0.2.0_24.json \
  'https://rest.db.ripe.net/ripe/inetnum'
StatusMeaning
200 OKJSON content of the backup file
401 UnauthorizedMissing or incorrect Basic Auth credentials

Build docs developers (and LLMs) love

Get started for freeTalk to us