API Documentation

Integrate mclo.gs directly into your server panel, your hosting software or anything else. This platform was built for high performance automation and can easily be integrated into any existing software via our HTTP API.

Paste a log file

POST https://api.mclo.gs/1/log application/x-www-form-urlencoded
Field Type Description
content string The raw log file content as string. Maximum length is 10MiB and 25k lines, will be shortened if necessary.

cURL Upload log files from a shell

curl -X POST --data-urlencode 'content@path/to/latest.log' 'https://api.mclo.gs/1/log'

Success application/json

{
    "success": true,
    "id": "8FlTowW",
    "url": "https://mclo.gs/8FlTowW",
    "raw": "https://api.mclo.gs/1/raw/8FlTowW"
}

Error application/json

{
    "success": false,
    "error": "Required POST argument 'content' is empty."
}

Get the raw log file content

GET https://api.mclo.gs/1/raw/[id]
Field Type Description
[id] string The log file id, received from the paste endpoint or from a URL (https://mclo.gs/[id]).

Success text/plain

[18:25:33] [Server thread/INFO]: Starting minecraft server version 1.16.2
[18:25:33] [Server thread/INFO]: Loading properties
[18:25:34] [Server thread/INFO]: Default game type: SURVIVAL
...

Error application/json

{
    "success": false,
    "error": "Log not found."
}

Get insights

GET https://api.mclo.gs/1/insights/[id]
Field Type Description
[id] string The log file id, received from the paste endpoint or from a URL (https://mclo.gs/[id]).

Success application/json

{
  "id": "name/type",
  "name": "Software name, e.g. Vanilla",
  "type": "Type name, e.g. Server Log",
  "version": "Version, e.g. 1.12.2",
  "title": "Combined title, e.g. Vanilla 1.12.2 Server Log",
  "analysis": {
    "problems": [
      {
        "message": "A message explaining the problem.",
        "counter": 1,
        "entry": {
          "level": 6,
          "time": null,
          "prefix": "The prefix of this entry, usually the part containing time and loglevel.",
          "lines": [
            {
              "number": 1,
              "content": "The full content of the line."
            }
          ]
        },
        "solutions": [
          {
            "message": "A message explaining a possible solution."
          }
        ]
      }
    ],
    "information": [
      {
        "message": "Label: value",
        "counter": 1,
        "label": "The label of this information, e.g. Minecraft version",
        "value": "The value of this information, e.g. 1.12.2",
        "entry": {
          "level": 6,
          "time": null,
          "prefix": "The prefix of this entry, usually the part containing time and loglevel.",
          "lines": [
            {
              "number": 6,
              "content": "The full content of the line."
            }
          ]
        }
      }
    ]
  }
}

Error application/json

{
    "success": false,
    "error": "Log not found."
}

Check storage limits

GET https://api.mclo.gs/1/limits

Success application/json

{
  "storageTime": 7776000,
  "maxLength": 10485760,
  "maxLines": 25000
}
Field Type Description
storageTime integer The duration in seconds that a log is stored for after the last view.
maxLength integer Maximum file length in bytes. Logs over this limit will be truncated to this length.
maxLines integer Maximum number of lines. Additional lines will be removed.

Notes

The API has currently a rate limit of 60 requests per minute per IP address. This is set to ensure the operability of this service. If you have any use case that requires a higher limit, feel free to contact us.