NoxVR Documentation
Instances

Get instance

Retrieve an instance by ID or name (prefix with # for name search).

GET
/instances/{search}

Path Parameters

searchstring

Instance ID or name (use

Response Body

application/json

application/json

curl -X GET "https://nox.hactazia.fr/api/instances/string"
{
  "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"
    }
  ]
}
{
  "error": {
    "message": "Resource not found.",
    "code": 3,
    "status": 404
  },
  "data": null
}