GoSyntech API Documentation

Overview

The GoSyntech API allows users to manage their hosted servers using simple HTTP requests. This guide explains authentication, endpoints, rate limiting, and best practices.

Base URL

1. Authentication

All API requests require authentication using gosyntech_id and auth_token as query parameters.

Example:

Response:

{
    "status": "success",
    "message": "Authenticated successfully",
    "user": {
        "gosyntech_id": "user123",
        "email": "[email protected]",
        "tokens": 100,
        "email_verified": true
    }
}
            

2. List All Servers

This API endpoint retrieves and displays a list of all servers associated with the user whose unique gosyntech_id is provided as the user parameter. It returns essential details about each server, including its current status (running, stopped, or error), resource usage (CPU, RAM, and storage), assigned IP address, and other relevant metadata. This allows users to efficiently monitor and manage their servers, perform administrative tasks such as starting, stopping, or restarting servers, and gain insights into their overall system performance. The response is structured to provide a clear and concise overview, making it easier to integrate with front-end applications or server management dashboards.

{
    "status": "success",
    "servers": [
        {
            "server_name": "MyServer",
            "server_type": "Minecraft",
            "server_status": "running",
            "server_ip": "192.168.1.1"
        }
    ]
}
            

3. Show Server Info

This API endpoint retrieves detailed information about a specific server, as specified by the server_name parameter in the URL. The server being queried must belong to the user whose unique gosyntech_id is provided in the user parameter. The response includes key details such as the server’s current status (running, stopped, or error), allocated resources (CPU, RAM, and storage usage), assigned IP address, uptime, installed plugins, and any additional metadata relevant to its configuration. This allows users to monitor server performance, check system health, and manage operations efficiently within their server dashboard.

{
    "status": "success",
    "server": {
        "server_name": "MyServer",
        "server_type": "Minecraft",
        "server_ram": "4GB",
        "server_status": "running",
        "server_ip": "192.168.1.1"
    }
}
            

4. See RAM, DISK, CPU Usage

This API endpoint retrieves detailed RAM, Disk Space, CPU Usage information about a specific server, as specified by the server_name parameter in the URL. The server being queried must belong to the user whose unique gosyntech_id is provided in the user parameter. The response includes key details such as the server’s current status (running, stopped, or error), allocated resources (CPU, RAM, and storage usage), assigned IP address, uptime, installed plugins, and any additional metadata relevant to its configuration. This allows users to monitor server performance, check system health, and manage operations efficiently within their server dashboard.

{
    "status": "success",
    "server_usage": {
        "ram_usage": "2.5GB / 4GB",
        "disk_usage": "30GB / 50GB",
        "cpu_usage": "50%"
    }
}
            

5. Add Plugin to Server

This API endpoint allows you to add a plugin to your server seamlessly. To use this endpoint, you must provide the plugin_url parameter, which should contain a valid URL pointing to a .jar file of a plugin that is compatible with the server. The server will verify the plugin file for integrity and compatibility before installation. Once successfully added, the plugin will be available for use, and depending on the type of plugin, the server may need to be restarted for the changes to take effect. This functionality enables users to enhance their server with new features, optimizations, or gameplay modifications efficiently.

{
    "status": "success"
}
            

6. Start / Stop / Restart Server

This API endpoint enables you to remotely control a specific Minecraft server by issuing simple GET requests. You can use this endpoint to start, stop, or restart a server, depending on the action specified in the request parameters. When a request is made, the API verifies the server's current state and executes the requested operation accordingly. This functionality allows for efficient server management, ensuring that users can easily bring their servers online, safely shut them down, or perform restarts to apply changes, such as newly installed plugins or configuration updates.

{
    "status": "Server started successfully"
}
            

Error Handling

Click here to see all possible errors.