ip-plz is a tiny HTTP API that returns caller's public IP address

✉️ Returns the caller's public IP
🔀 Reverse-proxy support with configurable trusted headers
🚀 Deploy as container, AWS lambda or traditional binary
📦 Zero configuration and works out of the box with secure defaults
🪶 Lightweight and almost no dependencies
🔭 Observability using metrics

Run the lambda Makefile target to build an archive for the provided.al2 runtime and the arm64 architecture. Either create a Lambda using AWS cli / Console or run the Terraform code to create an API Gateway instance and Lambda function.

$ make lambda
$ terraform -chdir=deployment/terraform/envs/dev apply
$ curl $(terraform -chdir=tf output --raw api_gateway_invoke_url)v1/ip

$ docker run -d -p 8080:8080 ghcr.io/soerenschneider/ip-plz
$ curl localhost:8080/ip-plz

Head to the releases section and download the correct binary for your system.

As a prerequisite, you need to have Golang SDK installed. After that, you can install ip-plz from source by invoking:

$ go install github.com/soerenschneider/ip-plz@latest

$ curl https://dtp9iioxbc.execute-api.us-east-1.amazonaws.com/prod/ip
178.200.50.73

Configuration is only available when not deploying via Lambda. ip-plz is configured via environment variables only.

Configuration reference:

Metrics are prefixed with ip_plz

Read the full changelog