WebSocket Connector Service

Get service status

get
/status

Returns service status with version, commit hash, current time, and user count

Responses
chevron-right
200

Service status

application/json
get
/status

Get Prometheus metrics

get
/metrics

Returns Prometheus metrics for monitoring

Responses
chevron-right
200

Prometheus metrics

text/plain
Responsestring
get
/metrics

Liveness probe

get
/health/live

Returns 'alive' for liveness checks

Responses
chevron-right
200

Service is alive

text/plain
ResponsestringExample: alive
get
/health/live

WebSocket connection

get
/ws

Establishes a WebSocket connection for real-time communication in the Archipelago system. This endpoint enables peer-to-peer communication, position synchronization, and island management for Decentraland clients.

Authentication Flow:

  1. Client initiates connection with an Ethereum address

  2. Server responds with a challenge string to sign

  3. Client sends signed challenge with AuthChain

  4. Server validates signature and assigns peer ID

Supported Message Types:

  • challengeRequest: Initial connection with address

  • challengeResponse: Server-provided challenge

  • signedChallenge: Client-provided signed challenge with AuthChain

  • welcome: Server confirmation with assigned peer ID

  • heartbeat: Keep-alive messages

  • kicked: Disconnection notification

Once authenticated, the peer receives real-time updates about island assignments, nearby peers, and position changes as they move through Decentraland's metaverse.

Responses
chevron-right
200

WebSocket connection established

application/json
get
/ws

No content

Last updated