📕API Reference

So.. what can I do with this thing?

Authorization Required: All endpoints below require an API Key. Click here to see how to find it! Authorization Header: X-Api-Key Example: X-Api-Key: a9bd9586-2da8-496c-9699-83ff93c824e2

Base URL: https://maple-api.marizma.games/

Please note that not all data is up-to-date, we are consistently updating and improving the documentation.

Endpoints

Get public server information

get

Retrieves public information for the server.

Header parameters

X-Api-KeystringRequired

API Key

Responses

200

Server information

application/json

401

Unauthorized

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

get

/v1/server

GET /v1/server HTTP/1.1
Host: maple-api.marizma.games
X-Api-Key: text
Accept: */*

{
  "_documentation": "text",
  "data": {
    "Admins": [
      1
    ],
    "Code": "text",
    "HeadAdmins": [
      1
    ],
    "Icon": "text",
    "MaxPlayers": 1,
    "Owner": 1,
    "PlayerCount": 1,
    "ServerDescription": "text",
    "ServerName": "text"
  },
  "success": true
}

Get server players

get

Retrieves players for the server.

Header parameters

X-Api-KeystringRequired

API Key

Responses

200

Server players

application/json

401

Unauthorized

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

get

/v1/server/players

GET /v1/server/players HTTP/1.1
Host: maple-api.marizma.games
X-Api-Key: text
Accept: */*

{
  "_documentation": "text",
  "data": {
    "Players": [
      1
    ]
  },
  "success": true
}

Get server queue

get

Retrieves the queue for the server.

Header parameters

X-Api-KeystringRequired

API Key

Responses

200

Server queue

application/json

401

Unauthorized

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

get

/v1/server/queue

GET /v1/server/queue HTTP/1.1
Host: maple-api.marizma.games
X-Api-Key: text
Accept: */*

{
  "_documentation": "text",
  "data": {
    "Queue": [
      1
    ]
  },
  "success": true
}

Get server bans

get

Retrieves bans for the server.

Header parameters

X-Api-KeystringRequired

API Key

Responses

200

Server bans

application/json

401

Unauthorized

application/json

429

Rate limit exceeded

application/json

500

Internal server error

application/json

get

/v1/server/bans

GET /v1/server/bans HTTP/1.1
Host: maple-api.marizma.games
X-Api-Key: text
Accept: */*

{
  "_documentation": "text",
  "data": {
    "Bans": [
      1
    ]
  },
  "success": true
}

Rate Limiting: POST requests are subject to stricter Rate Limits. Make sure your application is configured to handle them properly!

Announce a message to the server

post

Sends an announcement message to the server.

Header parameters

X-Api-KeystringRequired

API Key

Body

Request body for announcing a message

messagestringRequiredExample: hello world

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

post

/v1/server/announce

POST /v1/server/announce HTTP/1.1
Host: maple-api.marizma.games
X-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "message": "hello world"
}

{
  "_documentation": "text",
  "data": null,
  "success": true
}

Shutdown the server

post

Shuts down the server after 30 second timeout.

Header parameters

X-Api-KeystringRequired

API Key

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

post

/v1/server/shutdown

POST /v1/server/shutdown HTTP/1.1
Host: maple-api.marizma.games
X-Api-Key: text
Accept: */*

{
  "_documentation": "text",
  "data": null,
  "success": true
}

We allow the following settings to be changed:

Private: bool (FriendsOnly)
HideFromList: bool
minLevel: int

Please remember to respect our ratelimits!

Update server setting

post

Updates a specific server setting.

Header parameters

X-Api-KeystringRequired

API Key

Body

Request body for updating a server setting

HideFromListbooleanOptional

PrivatebooleanOptional

minLevelintegerOptional

Responses

200

Setting updated successfully

application/json

400

Invalid request body or server already banned

application/json

401

Unauthorized

application/json

403

Setting not allowed or invalid type

application/json

429

Too many requests

application/json

500

Internal server error

application/json

post

/v1/server/setSetting

POST /v1/server/setSetting HTTP/1.1
Host: maple-api.marizma.games
X-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "HideFromList": false,
  "Private": false,
  "minLevel": 0
}

{
  "_documentation": "text",
  "data": null,
  "success": true
}

Toggle ban for a user

post

Adds or removes the given userId from the banlist.

Header parameters

X-Api-KeystringRequired

API Key

Body

BannedbooleanRequiredExample: true

UserIdintegerRequiredExample: 123456789

Responses

200

User banned/unbanned successfully

application/json

400

Invalid request body

application/json

401

Unauthorized

application/json

404

User not found

application/json

500

Internal server error

application/json

post

/v1/server/banplayer

POST /v1/server/banplayer HTTP/1.1
Host: maple-api.marizma.games
X-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "Banned": true,
  "UserId": 123456789
}

{
  "_documentation": "text",
  "data": null,
  "success": true
}

Kick a player from the server

post

Kicks a player from the server.

Header parameters

X-Api-KeystringRequired

API Key

Body

Request body for kicking a player

ModerationReasonstringOptionalExample: Optional reason for the kick

UserIdintegerRequiredExample: 123456789

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

post

/v1/server/moderation/kick

POST /v1/server/moderation/kick HTTP/1.1
Host: maple-api.marizma.games
X-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 70

{
  "ModerationReason": "Optional reason for the kick",
  "UserId": 123456789
}

{
  "_documentation": "text",
  "data": null,
  "success": true
}

Set a banner for the server

post

Sets a banner for the server.

Header parameters

X-Api-KeystringRequired

API Key

Body

Request body for setting a banner

bannerstringRequiredExample: Hello World!

Responses

200

application/json

400

Bad Request

application/json

401

Unauthorized

application/json

429

Too Many Requests

application/json

500

Internal Server Error

application/json

post

/v1/server/setbanner

POST /v1/server/setbanner HTTP/1.1
Host: maple-api.marizma.games
X-Api-Key: text
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "banner": "Hello World!"
}

{
  "_documentation": "text",
  "data": null,
  "success": true
}

PreviousWhat is this thing?NextAPI Keys

Last updated 9 days ago