API Documentation

The Build5Nines IPConfig REST API returns information about the requesting client. All endpoints support both JSON and plain text responses.

Content Negotiation: By default, responses are returned as plain text. To receive JSON, include Accept: application/json in your request header.

Endpoints

GET /api/me

Returns full client information including IP address, port, protocol, and user agent.

Example Request (Plain Text - Default)

curl https://ipconfig.build5nines.com/api/me

Example Plain Text Response

IP: 203.0.113.42
Port: 54321
Protocol: HTTP/2
UserAgent: curl/8.1.2

Example JSON Request

curl -H "Accept: application/json" https://ipconfig.build5nines.com/api/me

Example JSON Response

{
  "ip": "203.0.113.42",
  "port": 54321,
  "protocol": "HTTP/2",
  "userAgent": "curl/8.1.2"
}

GET /api/me/ip

Returns only the requester's public IP address.

Example Request (Plain Text - Default)

curl https://ipconfig.build5nines.com/api/me/ip

Plain Text Response

203.0.113.42

JSON Request

curl -H "Accept: application/json" https://ipconfig.build5nines.com/api/me/ip

JSON Response

{
  "ip": "203.0.113.42"
}

Response Formats

Accept Header	Response Format
`text/plain` (default)	Plain text (key: value pairs or raw value)
`application/json`	JSON object