Skip to main content
POST
/
v1
/
relays
/
register
Register a new relay
curl --request POST \
  --url https://relay.fluxer.app/v1/relays/register \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "url": "<string>",
  "latitude": 0,
  "longitude": 0,
  "public_key": "<string>",
  "region": "<string>",
  "capacity": 4503599627370496
}
'
{
  "id": "<string>",
  "name": "<string>",
  "url": "<string>",
  "latitude": 123,
  "longitude": 123,
  "region": "<string>",
  "capacity": 4503599627370495,
  "current_connections": 4503599627370495,
  "public_key": "<string>",
  "registered_at": "2023-11-07T05:31:56Z",
  "last_seen_at": "2023-11-07T05:31:56Z",
  "healthy": true
}

Body

application/json
​
name
string
required

Human-readable name of the relay

Required string length: 1 - 100
​
url
string<uri>
required

Base URL of the relay service

​
latitude
number
required

Geographic latitude of the relay

Required range: -90 <= x <= 90
​
longitude
number
required

Geographic longitude of the relay

Required range: -180 <= x <= 180
​
public_key
string
required

Base64-encoded X25519 public key for E2E encryption

Minimum string length: 1
​
region
string

Region identifier

Required string length: 1 - 50
​
capacity
integer<int64>

Maximum connection capacity

Required range: 1 <= x <= 9007199254740991

Response

201 - application/json

Relay registered successfully

​
id
string
required

Unique identifier for the relay

​
name
string
required

Human-readable name of the relay

​
url
string<uri>
required

Base URL of the relay service

​
latitude
number
required

Geographic latitude of the relay

​
longitude
number
required

Geographic longitude of the relay

​
region
string
required

Region identifier (e.g., eu-west, us-east)

​
capacity
integer<int64>
required

Maximum number of connections this relay can handle

Required range: 0 <= x <= 9007199254740991
​
current_connections
integer<int64>
required

Current number of active connections

Required range: 0 <= x <= 9007199254740991
​
public_key
string
required

Base64-encoded X25519 public key for E2E encryption

​
registered_at
string<date-time>
required

ISO 8601 timestamp when the relay was registered

​
last_seen_at
string<date-time>
required

ISO 8601 timestamp of the last health check or heartbeat

​
healthy
boolean
required

Whether the relay is currently healthy