Download OpenAPI specification:
Update props on a world
| worldId required | integer Numeric ID of the world to update props on |
Array of props to update
| id | integer ID of the prop |
| wid | integer ID of the world the prop belongs to |
| uid | integer ID of the user the prop belongs to |
| date | integer Creation/modification timestamp (ms) of the prop |
| x | number X coordinate of the prop (in meters) |
| y | number Y coordinate of the prop (in meters) |
| z | number Z coordinate of the prop (in meters) |
| ya | number Yaw of the prop (in radians) |
| pi | number Pitch of the prop (in radians) |
| ro | number Roll of the prop (in radians) |
| name | string Model name of the prop |
| desc | string Description of the prop |
| act | string Action field of the prop |
[- {
- "id": 13257,
- "wid": 2,
- "uid": 321,
- "date": 1751733868025,
- "x": 215,
- "y": 10.2,
- "z": 8915.12,
- "ya": 3.1415,
- "pi": 0.0162,
- "ro": 0,
- "name": "sign1.rwx",
- "desc": "John's Shack",
- "act": "create sign;"
}
][- null
]Create props on a world
| worldId required | integer Numeric ID of the world to create props on |
Array of props to create
| id | integer ID of the prop |
| wid | integer ID of the world the prop belongs to |
| uid | integer ID of the user the prop belongs to |
| date | integer Creation/modification timestamp (ms) of the prop |
| x | number X coordinate of the prop (in meters) |
| y | number Y coordinate of the prop (in meters) |
| z | number Z coordinate of the prop (in meters) |
| ya | number Yaw of the prop (in radians) |
| pi | number Pitch of the prop (in radians) |
| ro | number Roll of the prop (in radians) |
| name | string Model name of the prop |
| desc | string Description of the prop |
| act | string Action field of the prop |
[- {
- "id": 13257,
- "wid": 2,
- "uid": 321,
- "date": 1751733868025,
- "x": 215,
- "y": 10.2,
- "z": 8915.12,
- "ya": 3.1415,
- "pi": 0.0162,
- "ro": 0,
- "name": "sign1.rwx",
- "desc": "John's Shack",
- "act": "create sign;"
}
][- null
]Delete props from a world
| worldId required | integer Numeric ID of the world to delete props from |
Array of prop IDs to delete
[- 0
][- null
]Authenticate a user based on the provided credentials
Credentials for user authentication
| username | string Username in plain text |
| password | string Password in plain text |
{- "username": "John",
- "password": "p.4SsW0r-*D"
}{- "id": 3247,
- "role": "citizen",
- "token": "eyJhbGciOiJ...kVUQjE"
}[
]Get terrain elevation data for a single page a of a single world
| worldId required | integer Numeric ID of the world to get |
| x required | integer Page position along the X axis |
| z required | integer Page position along the Z axis |
[- {
- "name": "nonUniqueBodyEmail",
- "ctx": "body",
- "field": "email",
- "desc": "Email is already in use"
}
]Get terrain texture data for a single page a of a single world
| worldId required | integer Numeric ID of the world to get |
| x required | integer Page position along the X axis |
| z required | integer Page position along the Z axis |
[- {
- "name": "nonUniqueBodyEmail",
- "ctx": "body",
- "field": "email",
- "desc": "Email is already in use"
}
]Get water elevation data for a single page a of a single world
| worldId required | integer Numeric ID of the world to get |
| x required | integer Page position along the X axis |
| z required | integer Page position along the Z axis |
[- {
- "name": "nonUniqueBodyEmail",
- "ctx": "body",
- "field": "email",
- "desc": "Email is already in use"
}
]Create a new user
Payload to create a new user
| name required | string Name of the user |
| email required | string Email address bound to this user account |
| role required | string Role of the user, can be one of |
| password required | any Password of the user in clear text, will be stored hashed and salted. |
| privilegePassword | string Optional (null for none) privilege password of the user in clear text, will be stored hashed and salted. |
{- "name": "string",
- "email": "string",
- "role": "string",
- "password": null,
- "privilegePassword": "string"
}{- "id": 3247,
- "name": "johndoe",
- "email": "john.doe@domain.com",
- "role": "citizen"
}Update a user
| userId required | integer Numeric ID of the user to update |
Payload to update the user
| name | string Name of the user |
string Email address bound to this user account | |
| role | string Role of the user, can be one of |
| password | any Password of the user in clear text, will be stored hashed and salted. |
| privilegePassword | string Optional (null for none) privilege password of the user in clear text, will be stored hashed and salted. |
{- "name": "johndoe",
- "email": "john.doe@domain.com",
- "role": "citizen",
- "password": null,
- "privilegePassword": "string"
}{- "id": 3247,
- "name": "johndoe",
- "email": "john.doe@domain.com",
- "role": "citizen"
}