DemoGitHubDiscord Server

Console

Manage game servers for minecraft and battleye games.

Get a list of consoles.

get

Requires View Console permission.

Authorizations
Query parameters
showIpbooleanOptionalDefault: false
Responses
200
Success
application/json
get
GET /api/consoles HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "port": 1,
      "type": 0,
      "is_online": true,
      "created_at": "2025-06-22T22:20:25.637Z",
      "ip": "text"
    }
  ]
}

Get a console.

get

Requires View Console permission.

Authorizations
Path parameters
consoleIdstringRequiredDefault: ""
Query parameters
showIpbooleanOptionalDefault: false
Responses
200
Success
application/json
get
GET /api/consoles/{consoleId} HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": {
    "port": 1,
    "type": 0,
    "is_online": true,
    "created_at": "2025-06-22T22:20:25.637Z",
    "ip": "text"
  }
}

Get a list of player names on the server.

get

Requires View Console and View Players permissions.

Authorizations
Path parameters
consoleIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/consoles/{consoleId}/server/players HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    "text"
  ]
}

Get a list of battleye players on the server.

get

Requires View Console and View Players permissions.

Authorizations
Path parameters
consoleIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/consoles/{consoleId}/battleye/players HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "number": 1,
      "ip": "text",
      "ping": "text",
      "guid": "text",
      "name": "text",
      "status": "text",
      "location": "text",
      "comment": "text"
    }
  ]
}

Execute a command on the server.

post

Requires View Console permission and Use Console Commandss.

Authorizations
Path parameters
consoleIdstringRequiredDefault: ""
Body
commandstringOptional
Responses
200
Success
application/json
post
POST /api/consoles/{consoleId}/server/command HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "command": "text"
}
{
  "success": true,
  "code": 1,
  "message": "text",
  "data": "text"
}

Send a global message.

post

Requires View Console and Message Global permissions.

Authorizations
Path parameters
consoleIdstringRequiredDefault: ""
Body
messagestringOptional
Responses
200
Success
application/json
post
POST /api/consoles/{consoleId}/message/global HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 18

{
  "message": "text"
}
{
  "success": true,
  "code": 1,
  "message": "text"
}

Send a message to a player.

post

Requires View Console and Message Players permissions.

Authorizations
Path parameters
consoleIdstringRequiredDefault: ""
Body
playerstringOptional
messagestringOptional
Responses
200
Success
application/json
post
POST /api/consoles/{consoleId}/message/player HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

{
  "player": "text",
  "message": "text"
}
{
  "success": true,
  "code": 1,
  "message": "text"
}

Kick a player on the server.

put

Requires View Console and Kick Players permissions.

Authorizations
Path parameters
consoleIdstringRequiredDefault: ""
Body
playerstringOptional
reasonstringOptional
Responses
200
Success
application/json
put
PUT /api/consoles/{consoleId}/players/kick HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "player": "text",
  "reason": "text"
}
{
  "success": true,
  "code": 1,
  "message": "text"
}

Ban a player on the server.

put

Requires View Console and Ban Players permissions.

Authorizations
Path parameters
consoleIdstringRequiredDefault: ""
Body
playerstringOptional
reasonstringOptional
Responses
200
Success
application/json
put
PUT /api/consoles/{consoleId}/players/ban HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "player": "text",
  "reason": "text"
}
{
  "success": true,
  "code": 1,
  "message": "text"
}

Control the server.

post

Requires View Console and Control Console permissions.

Authorizations
Path parameters
consoleIdstringRequiredDefault: ""
Query parameters
typestringRequired
Responses
200
Success
application/json
post
POST /api/consoles/{consoleId}/server/control HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text"
}

Get a list of rcon connections.

get

Requires View Console and View Connections permissions.

Authorizations
Path parameters
consoleIdstringRequiredDefault: ""
Responses
200
Success
application/json
get
GET /api/consoles/{consoleId}/battleye/connections HTTP/1.1
Host: devspace.fluxpoint.dev
Authorization: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "data": [
    {
      "id": 1,
      "ip": "text"
    }
  ]
}
PreviousClientNextDocker