Get information about the specified world
GET
/api/world?world=string
Application/Json
Key | Value | Type | Required |
---|---|---|---|
Authorization | Basic [key] | string | For Basic authentication mode only |
Authorization | [key] | string | For Key-Basic and Key-Advanced authentication modes only |
Key | Value | Type | Required |
---|---|---|---|
world | World name | string | Yes |
No parameters
Authentication type | Key type | Allowed |
---|---|---|
Open | ![]() | |
Basic | ![]() | |
Key-Basic | ![]() | |
Key-Advanced | Public key | ![]() |
Key-Advanced | Protected key | ![]() |
Key-Advanced | Admin key | ![]() |
{
"found": bool,
"name": string,
"allowAnimals": bool,
"allowMonsters": bool,
"difficulty": string,
"gameTime": double,
"pvp": bool,
"spawnX": int,
"spawnY": int,
"spawnZ": int,
"time": double
}
{
"success": bool,
"code": int,
"message": string
}
HTTP Code | Type |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |