https://github.com/michelboucey/ipv6db

A RESTful Web Service for IPv6-related data
https://github.com/michelboucey/ipv6db

database ipv6 ipv6-address microservice restful-webservices

Last synced: about 1 month ago
JSON representation

A RESTful Web Service for IPv6-related data

• Host: GitHub
• URL: https://github.com/michelboucey/ipv6db
• Owner: MichelBoucey
• License: bsd-3-clause
• Created: 2017-03-23T14:59:36.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T15:16:12.000Z (9 months ago)
• Last Synced: 2024-05-22T16:08:58.875Z (9 months ago)
• Topics: database, ipv6, ipv6-address, microservice, restful-webservices
• Language: Haskell
• Homepage: http://hackage.haskell.org/package/IPv6DB
• Size: 109 KB
• Stars: 5
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# IPv6DB

## A RESTful Web service for IPv6 related data ![CI](https://github.com/MichelBoucey/IPv6DB/actions/workflows/haskell-ci.yml/badge.svg) [![Hackage](https://img.shields.io/hackage/v/IPv6DB.svg)](https://hackage.haskell.org/package/IPv6DB)

IPv6DB is a RESTful microservice using Redis as backend to store lists of IPv6 addresses and attach to each of them any valuable data in a schema-free valid JSON value. Each resource can be permanent or TTLed.

```bash

[user@box ~]$ ipv6db --help

IPv6DB v0.3.3.1 APIv1, (c) Michel Boucey 2017-2024

Usage: ipv6db [-h|--host ARG] [-p|--port ARG] [-l|--log-file ARG]

              [-o|--redis-host ARG] [-r|--redis-port ARG]

              [-d|--redis-database ARG] [-a|--redis-auth ARG]

  RESTful Web Service for IPv6 related data

Available options:

  -h,--host ARG            Alternative host (default: "::")

  -p,--port ARG            Alternative listening port (default: 4446)

  -l,--log-file ARG        Log file (default: "/var/log/ipv6db.log")

  -o,--redis-host ARG      Redis host (default: "localhost")

  -r,--redis-port ARG      Redis listening port (default: 6379)

  -d,--redis-database ARG  Redis database (default: 0)

  -a,--redis-auth ARG      Redis authentication password

  -h,--help                Show this help text

```

A resource example:

```json

    {

      "list": "black",

      "address": "abcd::1234",

      "ttl": 34582,

      "source":

        {

          "services": [25,587,143]

        }

    }

```

The field "source" is mandatory and carry any valid JSON value.

The field "ttl" is optional in API requests for a permanent resource.

See the full [IPv6DB APIv1](https://github.com/MichelBoucey/IPv6DB/blob/master/IPv6DB_APIv1.md).

The package includes binary and library.