Sections

Introduction Authentication Response format Servers Rate limits Support

Beacon panel · REST

Automation-friendly API reference

Base path /api/v1 with bearer-authenticated workloads you can curl, pipeline in CI, or integrate with your control plane tooling.

Introduction

The Beacon Panel API allows you to programmatically manage your game servers, databases, files, schedules, backups, and more. This documentation sketches every generated route bundle, authentication expectations, and request/response examples.

All endpoints are rooted at /api/v1 unless denoted otherwise, and Bearer tokens gate access.

Authentication

Attach a Bearer credential on every authenticated verb:

Header

Authorization: Bearer YOUR_TOKEN_HERE

Obtaining a token

Mint API keys inside account settings inside the Beacon panel UI. Tokens mirror your RBAC posture — revoke and rotate aggressively if they leak.

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Response format

Payloads converge on one envelope irrespective of verb family:

{
"success": true|false,
"data": {}, // Only present on success
"error": "Error message" // Only present on failure
}

Success example

{
"success": true,
"data": {
  "id": "servers/123",
  "name": "Minecraft Server",
  "status": "running"
}
}

Error example

{
"success": false,
"error": "Server not found"
}

HTTP status codes

Status	Description
200 OK	Request succeeded with a usable payload or empty success envelope.
400 Bad Request	Validator rejected malformed input or missing required keys.
401 Unauthorized	Bearer token absent, malformed, or expired.
403 Forbidden	Identity valid but forbidden for that resource/action tuple.
404 Not Found	Unknown UUID, wiped server row, or out-of-scope identifier.
429 Too Many Requests	Exhausted quotas — backoff using rate-limit headers.
500 Internal Server Error	Unexpected stack path — escalate with correlation IDs/timestamps.

Servers

Get download for servers

GET/api/v1/servers/{serverId}/backups/{backup}/download

Get download for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
backup	string	Yes	The backup identifier

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/backups/{backup}/download" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Get servers details

GET/api/v1/servers/{serverId}/backups/{backup}

Get servers details

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
backup	string	Yes	The backup identifier

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/backups/{backup}" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Delete servers

DELETE/api/v1/servers/{serverId}/backups/{backup}

Delete servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
backup	string	Yes	The backup identifier

Example request

cURL

curl -X DELETE "https://www.beaconhosting.org/api/v1/servers/{serverId}/backups/{backup}" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Get backups for servers

GET/api/v1/servers/{serverId}/backups

Get backups for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
name	string	No	The name parameter
ignored	string	No	The ignored parameter

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/backups" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Perform backups on servers

POST/api/v1/servers/{serverId}/backups

Perform backups on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
name	string	No	The name parameter
ignored	string	No	The ignored parameter

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/backups" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "name": "example_name",
  "ignored": "example_ignored"
}'

Get console for servers

GET/api/v1/servers/{serverId}/console

Get console for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Query parameters

Parameter	Type	Required	Description
size	string	No	Number of items to return

Request body

Parameter	Type	Required	Description
command	string	Yes	The command to execute

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/console" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Perform console on servers

POST/api/v1/servers/{serverId}/console

Perform console on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Query parameters

Parameter	Type	Required	Description
size	string	No	Number of items to return

Request body

Parameter	Type	Required	Description
command	string	Yes	The command to execute

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/console" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "command": "say Hello from the API!"
}'

Perform rotate-password on servers

POST/api/v1/servers/{serverId}/databases/{database}/rotate-password

Perform rotate-password on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
database	string	Yes	The database name

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/databases/{database}/rotate-password" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json"

Delete servers

DELETE/api/v1/servers/{serverId}/databases/{database}

Delete servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
database	string	Yes	The database name

Example request

cURL

curl -X DELETE "https://www.beaconhosting.org/api/v1/servers/{serverId}/databases/{database}" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Get databases for servers

GET/api/v1/servers/{serverId}/databases

Get databases for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
database	string	Yes	The database name

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/databases" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Perform databases on servers

POST/api/v1/servers/{serverId}/databases

Perform databases on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
database	string	Yes	The database name

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/databases" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "database": "example_database"
}'

Perform compress on servers

POST/api/v1/servers/{serverId}/files/compress

Perform compress on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
files	array	Yes	The files parameter
root	string	No	The root parameter

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/compress" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "files": "example_files",
  "root": "example_root"
}'

Get contents for servers

GET/api/v1/servers/{serverId}/files/contents

Get contents for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/contents" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Perform copy on servers

POST/api/v1/servers/{serverId}/files/copy

Perform copy on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
from	string	Yes	The from parameter
to	string	Yes	The to parameter

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/copy" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "from": "example_from",
  "to": "example_to"
}'

Perform create-folder on servers

POST/api/v1/servers/{serverId}/files/create-folder

Perform create-folder on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
name	string	Yes	The name parameter
path	string	No	The path parameter

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/create-folder" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "name": "example_name",
  "path": "example_path"
}'

Perform decompress on servers

POST/api/v1/servers/{serverId}/files/decompress

Perform decompress on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
file	string	Yes	The file path
root	string	No	The root parameter

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/decompress" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "file": "example_file",
  "root": "example_root"
}'

Perform delete on servers

POST/api/v1/servers/{serverId}/files/delete

Perform delete on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
file	string	Yes	The file path

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/delete" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "file": "example_file"
}'

Get download for servers

GET/api/v1/servers/{serverId}/files/download

Get download for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/download" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Get list for servers

GET/api/v1/servers/{serverId}/files/list

Get list for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Query parameters

Parameter	Type	Required	Description
directory	string	No	The directory path

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/list" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Update servers

PUT/api/v1/servers/{serverId}/files/rename

Update servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
from	string	Yes	The from parameter
to	string	Yes	The to parameter

Example request

cURL

curl -X PUT "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/rename" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "from": "example_from",
  "to": "example_to"
}'

Perform upload on servers

POST/api/v1/servers/{serverId}/files/upload

Perform upload on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/upload" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json"

Perform write on servers

POST/api/v1/servers/{serverId}/files/write

Perform write on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
file	string	Yes	The file path
content	string	No	The content parameter

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/files/write" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "file": "example_file",
  "content": "example_content"
}'

Perform primary on servers

POST/api/v1/servers/{serverId}/network/allocations/{allocation}/primary

Perform primary on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
allocation	string	Yes	The allocation parameter

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/network/allocations/{allocation}/primary" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json"

Create or update servers

POST/api/v1/servers/{serverId}/network/allocations/{allocation}

Create or update servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
allocation	string	Yes	The allocation parameter

Request body

Parameter	Type	Required	Description
notes	string	No	The notes parameter

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/network/allocations/{allocation}" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "notes": "example_notes"
}'

Delete servers

DELETE/api/v1/servers/{serverId}/network/allocations/{allocation}

Delete servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
allocation	string	Yes	The allocation parameter

Request body

Parameter	Type	Required	Description
notes	string	No	The notes parameter

Example request

cURL

curl -X DELETE "https://www.beaconhosting.org/api/v1/servers/{serverId}/network/allocations/{allocation}" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Get allocations for servers

GET/api/v1/servers/{serverId}/network/allocations

Get allocations for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/network/allocations" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Perform allocations on servers

POST/api/v1/servers/{serverId}/network/allocations

Perform allocations on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/network/allocations" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json"

Get permissions for servers

GET/api/v1/servers/{serverId}/permissions

Get permissions for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/permissions" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Get servers details

GET/api/v1/servers/{serverId}

Get servers details

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
action	string	No	The action to perform

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Create or update servers

POST/api/v1/servers/{serverId}

Create or update servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Request body

Parameter	Type	Required	Description
action	string	No	The action to perform

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json" \
-d '{
  "action": "restart"
}'

Get resources for servers

GET/api/v1/servers/{serverId}/settings/resources

Get resources for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/settings/resources" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Get servers details

GET/api/v1/servers/{serverId}/users/{subuser}

Get servers details

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
subuser	string	Yes	The subuser parameter

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/users/{subuser}" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Create or update servers

POST/api/v1/servers/{serverId}/users/{subuser}

Create or update servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
subuser	string	Yes	The subuser parameter

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/users/{subuser}" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json"

Delete servers

DELETE/api/v1/servers/{serverId}/users/{subuser}

Delete servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server
subuser	string	Yes	The subuser parameter

Example request

cURL

curl -X DELETE "https://www.beaconhosting.org/api/v1/servers/{serverId}/users/{subuser}" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Get users for servers

GET/api/v1/servers/{serverId}/users

Get users for servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers/{serverId}/users" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Perform users on servers

POST/api/v1/servers/{serverId}/users

Perform users on servers

Path parameters

Parameter	Type	Required	Description
serverId	string	Yes	The unique identifier of the server

Example request

cURL

curl -X POST "https://www.beaconhosting.org/api/v1/servers/{serverId}/users" \
-H "Authorization: Bearer YOUR_TOKEN_HERE" \
-H "Content-Type: application/json"

List all servers

GET/api/v1/servers

List all servers

Example request

cURL

curl -X GET "https://www.beaconhosting.org/api/v1/servers" \
-H "Authorization: Bearer YOUR_TOKEN_HERE"

Rate limiting

Throughput quotas keep noisy neighbors sane — baseline accounts land on the standard lane unless sales elevates concurrency via contract.

Tier	Limit
Standard	Roughly 180 requests per rolling minute window per credential
Enterprise	Higher bursts via onboarding — negotiate with Beacon support ahead of load tests.

429 Too Many Requests returns whenever you exceed quotas. Respect the headers while implementing backoff with jitter so automation stays courteous.

Header	Description
X-RateLimit-Limit	Ceiling of requests allowed inside the monitored window.
X-RateLimit-Remaining	Remaining allotment before saturation for this interval.
X-RateLimit-Reset	Countdown describing when rolling counters refresh.

Support

Reach builders instead of scripted triage when API nuance stalls your deployment pipeline.

Documentation fixes

Spotted contradictory schemas or stale curl snippets? Submit upstream so every integrator inherits the corrections.

GitHub issues →

Operational support

Production incidents and bespoke quota discussions route through Beacon’s API support desk.

api-support@beaconhosting.org