IPv6DB

A RESTful Web Service for IPv6-related data

https://github.com/MichelBoucey/IPv6DB

Version on this page:0.1.1
LTS Haskell 12.26:0.3.1
Stackage Nightly 2018-09-28:0.3.1
Latest on Hackage:0.3.3.1

See all snapshots IPv6DB appears in

BSD-3-Clause licensed by Michel Boucey
Maintained by [email protected]
This version can be pinned in stack with:IPv6DB-0.1.1@sha256:ea4cb3a0d5a7a2782487dc8b586d1b4922d5178744e9187eb91a5ceee784ae41,2435

Module documentation for 0.1.1

IPv6DB

A RESTful Web service for IPv6 related data Build Status

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.

[user@box ~]$ ipv6db --help
IPv6DB v0.1.0 APIv1, (c) Michel Boucey 2017

Usage: ipv6db [-p|--port] [-h|--redis-host ARG] [-r|--redis-port]
              [-d|--redis-database ARG] [-a|--redis-auth ARG]
              [-l|--log-file ARG]
  RESTful Web Service for IPv6 related data

Available options:
  -p,--port                Alternative listening port (default: 4446)
  -l,--log-file ARG        Log file (default: "/var/log/ipv6db.log")
  -h,--redis-host ARG      Redis host (default: "localhost")
  -r,--redis-port          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:

    {
      "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.

The package includes binary and library.