BGPq Proxy

A simple REST API that serves as a proxy to bgpq3/bgpq4.

Requirements

This project relies on Python with Flask and Redis as caching database.

Calling The API

The current implementation exposes four different endpoints:

• get list of cached ASNs
• get list of cached AS-SET
• get prefixes based on an ASN
• get prefixes based on an AS-SET

All endpoints answer to GET requests. Endpoints fetching prefixes will give IPv4 and IPv6 prefix lists back. They also accept two optional parameters:

• ?invalidate=1 will make the API forgot about the cached result and will avoid caching the new result
• ?no_cache=1 will forbid the API to look for the result in the cache and cache the new result

Cached ASNs Endpoint

Query: GET /bgpq/asn/

Response:

{
    "asn": [
        "AS201281"
    ]
}

Cached AS-SETs Endpoint

Query: GET /bgpq/as-set/

Response:

{
    "as_sets": [
        "AS-MAZOYER-EU"
    ]
}

ASN Endpoint

Query: GET /bgpq/asn/201281

Response:

{
    "ipv4": [
        {
            "prefix": "45.154.62.0/24",
            "exact": true
        }
    ],
    "ipv6": [
        {
            "prefix": "2001:678:794::/48",
            "exact": true
        },
        {
            "prefix": "2a0f:b100:200::/40",
            "exact": true
        }
    ]
}

AS-SET Endpoint

Query: GET /bgpq/as-set/AS-MAZOYER-EU

Response:

{
    "ipv4": [
        {
            "prefix": "45.154.62.0/24",
            "exact": true
        }
    ],
    "ipv6": [
        {
            "prefix": "2001:678:794::/48",
            "exact": true
        },
        {
            "prefix": "2a0f:b100:200::/40",
            "exact": true
        }
    ]
}

A specific optional parameter to limit the depth while resolving the AS-SET prefix list can be passed. Use ?depth=<value> where value is a positive interger, 0 meaning no depth limit.

Docker

A Dockerfile and Docker Compose file are provided to quickly turn up bgpq-proxy.

docker build -t bgpq-proxy .
docker compose up