NoxVR Documentation
Instances

Search instances

Search for active instances.

GET
/instances

Query Parameters

query?string

Text query to search instances

world?string

World identifier to filter by

owner?string

Owner identifier to filter by

limit?integer
Default10
Range1 <= value <= 100
offset?integer
Default0
Range0 <= value

Response Body

application/json

curl -X GET "https://nox.hactazia.fr/api/instances"
{
  "total": 0,
  "query": "string",
  "world": "string",
  "owner": "string",
  "limit": 0,
  "offset": 0,
  "instances": [
    {
      "id": 0,
      "server": "string",
      "name": "string",
      "title": "string",
      "description": "string",
      "thumbnail": "http://example.com",
      "capacity": 0,
      "owner": "string",
      "tags": [
        "string"
      ],
      "world": "string",
      "connection": {
        "method": "string",
        "data": "string"
      },
      "client_count": 0,
      "players": [
        {
          "user": "string",
          "display": "string"
        }
      ]
    }
  ]
}