NoxVR Documentation
Relays

List relays (admin only)

List all relay servers. Requires admin privileges.

GET
/relays
AuthorizationBearer <token>

Bearer token authentication for user sessions

In: header

Response Body

application/json

application/json

application/json

curl -X GET "https://nox.hactazia.fr/api/relays"
[
  {
    "id": 0,
    "runtime": "string",
    "running": true,
    "status": {
      "instances": [
        {
          "id": 0,
          "internal_id": 0,
          "players": [
            {
              "id": 0,
              "client_id": 0,
              "display": "string",
              "flags": [
                "string"
              ]
            }
          ],
          "flags": [
            "string"
          ],
          "world": "string",
          "capacity": 0
        }
      ],
      "max_instances": 0,
      "clients": [
        {
          "id": 0,
          "address": "string",
          "platform": "string",
          "engine": "string",
          "user": "string"
        }
      ],
      "version": "string",
      "protocol": 0,
      "uptime": 0,
      "response": 0
    },
    "address": {
      "property1": "string",
      "property2": "string"
    }
  }
]
{
  "error": {
    "message": "You are not logged in.",
    "code": 7,
    "status": 401
  },
  "data": null
}
{
  "error": {
    "message": "You are not authorized to {0}.",
    "code": 8,
    "status": 401
  },
  "data": null
}