API Reference

The Z-UCP API is a RESTful API that uses JSON for communication. It is used to exchange data between the panel, the bridge, and external tools.

Authentication

All requests to the API must include a valid API key in the header:

X-API-Key: YOUR_PROJECT_KEY

Endpoints

1. Player Data (/api/v2/players)

GET /api/v2/players

Returns a list of all players.

• Query Parameters:
  • limit: (Optional) Number of results (Default: 50)
  • offset: (Optional) Pagination offset
  • search: (Optional) Search by name or identifier

GET /api/v2/players/:identifier

Returns detailed information about a specific player (inventory, vehicles, account balances).

2. Live Actions (/api/v2/bridge)

These endpoints send commands directly to the FiveM server.

POST /api/v2/bridge/:serverId/kick

Kicks a player from the server.

• Body:

  {
    "target": "identifier",
    "reason": "Rule violation"
  }
  

POST /api/v2/bridge/:serverId/money

Gives money to or deducts it from a player.

• Body:

  {
    "target": "identifier",
    "type": "bank",
    "amount": 5000,
    "action": "add"
  }
  

3. System Status (/api/v2/health)

Returns the status of the API and database connections.

Rate Limiting

The API is limited to 100 requests per minute per project. If exceeded, a 429 Too Many Requests error is returned.