NoxVR Documentation
Instances

Create instance

Create a new instance.

PUT
/instances
AuthorizationBearer <token>

Bearer token authentication for user sessions

In: header

name?string
title?string
description?string
thumbnail?string
Formaturi
worldstring

World identifier

capacityinteger
exposestring

Whether the instance is public or private

use_password?boolean
Defaultfalse
password?string
use_whitelist?boolean
Defaultfalse
whitelist?array<string>

Response Body

application/json

application/json

application/json

curl -X PUT "https://nox.hactazia.fr/api/instances" \  -H "Content-Type: application/json" \  -d '{    "world": "string",    "capacity": 0,    "expose": "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": "You are not logged in.",
    "code": 7,
    "status": 401
  },
  "data": null
}
{
  "error": {
    "message": "User not found.",
    "code": 2,
    "status": 404
  },
  "data": null
}