GoSyntech API - Error Handling Guide

πŸ“Œ Overview

This document explains all possible API errors, their causes, and how to fix them. Understanding these errors helps developers troubleshoot issues quickly and efficiently.

🚨 Common API Errors

1️⃣ Invalid Authentication

{
    "status": "error",
    "message": "Invalid user ID or password"
}
                

πŸ” Reason: The provided goGoSyntech_id or auth_token is incorrect.

βœ… Fix: Double-check the credentials. Ensure that you are passing the correct values.

2️⃣ Rate Limit Exceeded

{
    "error": "Rate limit exceeded. Try again later."
}
                

πŸ” Reason: Too many API requests were sent in a short period.

βœ… Fix: Implement request throttling or wait before retrying.

3️⃣ Missing Required Parameter

{
    "status": "error",
    "message": "Missing required parameter: server_name"
}
                

πŸ” Reason: The request lacks a mandatory field (e.g., server_name).

βœ… Fix: Check the API documentation and ensure all required parameters are included.

4️⃣ Unauthorized Server Access

{
    "status": "error",
    "message": "Unauthorized server access or server not found"
}
                

πŸ” Reason: Either the server doesn't exist, or the user does not have the right permissions.

βœ… Fix: Ensure you have access to the server and that the correct server_name is used.

5️⃣ Node Information Not Found

{
    "status": "error",
    "message": "Node information not found"
}
                

πŸ” Reason: The backend node managing the server is unavailable.

βœ… Fix: Try again later or contact GoSyntech support.

6️⃣ Plugin Installation Failed

{
    "status": "error",
    "message": "Failed to install plugin."
}
                

πŸ” Reason: The provided plugin URL is invalid, or the server is rejecting the request.

βœ… Fix: Verify the plugin_url and ensure the server is online.

7️⃣ Server Action Failed

{
    "error": "Failed to start your server due to backend failure (Node might be under maintenance)."
}
                

πŸ” Reason: The server is unable to start due to a backend issue.

βœ… Fix: Wait and retry. If the issue persists, check GoSyntech’s status page.

πŸ“ž Contact Support

For assistance, visit GoSyntech Support.