ToLink.to API

API v1

Dokumentation der ToLink.to API.

Allgemein

Die Verwendung der API ist kostenlos und bedarf nur der Erstellung eines API Keys im Benutzerkonto.

API Key muss im Benutzerkonto erstellt werden
alle Anfragen müssen den Content-Type: application/json im Header mitsenden
alle Anfragen erfolgen im JSON Format
alle Anfragen erfolgen per POST Request

1 Authentifizierung

Bei jeder Anfrage muss zur Identifizierung ein Token mit geschickt werden ("apikey"). Diesen könnt Ihr in euren Profil Einstellunge erstellen.

1.1 Request Beispiel

Einfaches Beispiel:

        Action: /api/v1/ping
        Method: POST
        Content-Type: application/json
        Content:
        {
            "apikey": "token123",
            "body": {
                "message": "Ping"
            }
        }

1.2 Response Beispiel

Einfaches Beispiel:

        {
            "response": {
                "status": "OK",
                "errorCode": 0,
                "errorMsg": "",
                "body": "Pong"
            }
        }

2 Ordner

2.1 Ordner erstellen

Um einen Ordner zu erstellen werden 7 Informationen benötigt. Die übergebenen Links müssen mit ; getrennt werden.

Action: /api/v1/folder/create

2.1.1 Request Beispiel

Einfaches Beispiel:

        {
          "apikey": "key123456",
          "body": {
            "title": "Test Folder",
            "links": "http://linkZumDownload;http://linkZumDownload;http://linkZumDownload",
            "options": {
              "web": true,
              "container": false,
              "cln": true,
              "captcha": true,
              "captcha_text": false,
              "password": ""
            }
          }
        }

2.1.2 Response Beispiel

Einfaches Beispiel:

        {
          "response": {
            "status": "OK",
            "errorCode": 0,
            "errorMsg": "",
            "body": "http://tolink.to/f/fo587f92cc4c213"
          }
        }

2.2 Ordnerstatus abfragen

Um einen Ordnerstatus abzufragen muss der Ordner Link Alias übergeben werden.

Action: /api/v1/folder/status

2.2.1 Request Beispiel

Einfaches Beispiel:

        {
          "apikey": "key123456",
          "body": {
            "folder": "fo5857eeb4727a7"
          }
        }

2.2.2 Response Beispiel

Wichtig: Der Status kann folgende Werte haben.

0 | null = unbekannt
1 = online
2 = offline
3 = teilweise offline

Einfaches Beispiel:

        {
            "response": {
                "status": "OK",
                "errorCode": 0,
                "errorMsg": "",
                "body": {
                    "folder": "fo5857eeb4727a7",
                    "checked": "2016-12-21 11:12:16",
                    "status": null
                }
            }
        }

2.3 Ordner löschen

Um einen Ordner zu löschen muss der Ordnerlink Alias übergeben werden.

Action: /api/v1/folder/delete

2.3.1 Request Beispiel

Einfaches Beispiel:

        {
          "apikey": "key123456",
          "body": {
            "folder": "fo5857eeb4727a7"
          }
        }

2.3.2 Response Beispiel

Einfaches Beispiel:

        {
          "response": {
            "status": "OK",
            "errorCode": 0,
            "errorMsg": "",
            "body": {
              "message": "Ordner erfolgreich gelöscht"
            }
          }
        }

2.4 Ordner bearbeiten

Um einen Ordner zu bearbeiten müssen alle Informationen wie beim erstellen zusätzlich der Ordnerlink übergeben werden.

Action: /api/v1/folder/edit

2.4.1 Request Beispiel

Einfaches Beispiel:

        {
          "apikey": "key123456",
          "body": {
            "folder": "fo58c6a90b44710",
            "title": "Test Folder BEARBEITET",
            "links": "http://linkZumDownload;http://linkZumDownload;http://linkZumDownload",
            "options": {
              "web": true,
              "container": true,
              "cln": true,
              "captcha": false,
              "captcha_text": false,
              "password": ""
            }
          }
        }

2.4.2 Response Beispiel

Einfaches Beispiel:

        {
          "response": {
            "status": "OK",
            "errorCode": 0,
            "errorMsg": "",
            "body": {
              "affected": 1,
              "folder": "fo58c6a90b44710"
            }
          }
        }

2.5 Ordner abfragen

Um Ordner abzufragen muss eine Sortierung und ein Limit angegeben werden. (max Limit = 10000)

Action: /api/v1/folder/fetch

2.5.1 Request Beispiel

Einfaches Beispiel:

        {
          "apikey": "key123456",
              "body": {
                "order": "ASC",     // "DESC"
                "limit": 5          // max. 15000
                "status": "offline" // 'offline', 'online', 'partial'
              }
          }
        }

2.5.2 Response Beispiel

Einfaches Beispiel:

        {
          "response": {
            "status": "OK",
            "errorCode": 0,
            "errorMsg": "",
            "body": {
                "fo5857ec8f7837c": {
                    "id": "2",
                    "title": "Test01",
                    "status": "1", // online
                    "hits": 0,
                    "hoster": [
                        "uploaded"
                    ]
                },
                "fo5857eeb4727a7": {
                    "id": "3",
                    "title": "Test02",
                    "status": "2", // offline
                    "hits": "17",
                    "hoster": [
                        "uploaded"
                    ]
                },
                "fo5857f062d1c85": {
                    "id": "4",
                    "title": "Test03",
                    "status": "3", // partial offline
                    "hits": "1",
                    "hoster": [
                        "uploaded"
                    ]
                },
                "fo585a4d5fe54e2": {
                    "id": "6",
                    "title": "Test05",
                    "status": "2",
                    "hits": "1",
                    "hoster": [
                        "uploaded"
                    ]
                },
                "fo585a4d79c509b": {
                    "id": "7",
                    "title": "Test06",
                    "status": "1",
                    "hits": "2",
                    "hoster": [
                        "uploaded"
                    ]
                }
            }
          }
        }

3 Kurzlink

3.1 Kurzlink erstellen

Um einen Kurzlink zu erstellen werden 3 Informationen benötigt. Titel ist auf 50 Zeichen und Beschreibung auf 200 Zeichen begrenzt.

Action: /api/v1/shortlink/create

3.1.1 Request Beispiel

Einfaches Beispiel:

        {
          "apikey": "key123456",
          "body": {
            "title": "Test Shortlink",
            "link": "http://yourLongLink",
            "description": "Test"
          }
        }

3.1.2 Response Beispiel

Einfaches Beispiel:

        {
          "response": {
            "status": "OK",
            "errorCode": 0,
            "errorMsg": "",
            "body": "http://tolink.to/l/a5"
          }
        }

3.2 Kurzlink löschen

Um einen Kurzlink zu löschen muss der Kurzlink Alias übergeben werden.

Action: /api/v1/shortlink/delete

3.2.1 Request Beispiel

Einfaches Beispiel:

        {
          "apikey": "key123456",
          "body": {
            "shortAlias": "a5"
          }
        }

3.2.2 Response Beispiel

Einfaches Beispiel:

        {
          "response": {
            "status": "OK",
            "errorCode": 0,
            "errorMsg": "",
            "body": {
              "message": "Link successful deleted"
            }
          }
        }

API v2

Die API v2 steht neben der API v1. v1 bleibt wie sie ist. v2 nutzt Adressen und HTTP-Methoden. Derselbe API-Key aus den Einstellungen gilt als Bearer-Token. Erfolg und Fehler kommen als HTTP-Status und JSON, ohne den alten Umschlag aus v1.

Fehlt der Key oder ist er falsch, antwortet die API mit Status 401 und {"message":"Invalid API Key"}.

Ping

GET /api/v2/ping

Request

GET /api/v2/ping
Authorization: Bearer token123

Response

{
  "message": "Pong"
}

Ordner anlegen

POST /api/v2/folders

Mehrere Links stehen in einem Text und werden mit ; getrennt.

Request

POST /api/v2/folders
Authorization: Bearer token123
Content-Type: application/json

{
  "title": "Test Folder",
  "links": "https://example.com/file.bin;https://example.com/second.bin",
  "options": {
    "web": true,
    "container": false,
    "cln": false,
    "captcha": false,
    "captcha_text": false,
    "password": ""
  }
}

Response

{
  "url": "https://tolink.to/f/foexamplefolder1",
  "folder": "foexamplefolder1",
  "title": "Test Folder"
}

Ordner auflisten

GET /api/v2/folders

Query: order ist ASC oder DESC (Standard DESC). limit ist die Anzahl Ordner pro Seite (Standard 100, höchstens 200). page ist die Seite (Standard 1). status ist online, offline, partial oder disabled. offline enthält offline und deaktivierte Ordner. Die Antwort nennt page, pages und total.

Request

GET /api/v2/folders?order=DESC&limit=10&page=1&status=partial
Authorization: Bearer token123

Response

{
  "order": "DESC",
  "limit": 10,
  "page": 1,
  "pages": 1,
  "total": 1,
  "status": "partial",
  "folders": [
    {
      "id": "4",
      "folder": "foexamplefolder1",
      "title": "Test Folder",
      "status": "3",
      "hits": 1,
      "hoster": ["uploaded"]
    }
  ]
}

Status eines Ordners

GET /api/v2/folders/{folder}

Request

GET /api/v2/folders/foexamplefolder1
Authorization: Bearer token123

Response

{
  "folder": "foexamplefolder1",
  "checked": null,
  "status": 3
}

Details eines Ordners

GET /api/v2/folders/{folder}/details

Nur der Eigentümer bekommt die Antwort. Ein fremder oder unbekannter Ordner liefert 404 mit Resource not found. Der Status-Abruf darüber bleibt für jeden gültigen Key offen.

Request

GET /api/v2/folders/foexamplefolder1/details
Authorization: Bearer token123

Response

{
  "id": "4",
  "folder": "foexamplefolder1",
  "url": "https://tolink.to/f/foexamplefolder1",
  "title": "Test Folder",
  "status": 3,
  "hits": 12,
  "created": "2026-11-01 12:00:00",
  "modified": "2026-11-02 08:00:00",
  "checked": "2026-11-02 09:00:00",
  "options": {
    "web": true,
    "container": false,
    "cln": false,
    "captcha": false,
    "captcha_text": false,
    "password": ""
  },
  "links": [
    {
      "id": "18",
      "url": "https://example.com/file.bin",
      "title": "file.bin",
      "status": 1,
      "size": 1500,
      "hits": 3,
      "hoster": "uploaded",
      "created": "2026-11-01 12:00:00"
    }
  ]
}

Ordner ändern

PATCH /api/v2/folders/{folder}

Felder, die fehlen, bleiben. Ein leeres links lässt die vorhandenen Links stehen.

Request

PATCH /api/v2/folders/foexamplefolder1
Authorization: Bearer token123
Content-Type: application/json

{
  "title": "Neuer Titel"
}

Response

{
  "folder": "foexamplefolder1",
  "title": "Neuer Titel",
  "affected": 1
}

Ordner löschen

DELETE /api/v2/folders/{folder}

Request

DELETE /api/v2/folders/foexamplefolder1
Authorization: Bearer token123

Response

{
  "deleted": true,
  "folder": "foexamplefolder1",
  "message": "Ordner erfolgreich gelöscht"
}

Kurzlink anlegen

POST /api/v2/shortlinks

Request

POST /api/v2/shortlinks
Authorization: Bearer token123
Content-Type: application/json

{
  "link": "https://example.com/file.bin"
}

Response

{
  "url": "https://tolink.to/l/a5",
  "alias": "a5"
}

Kurzlink löschen

DELETE /api/v2/shortlinks/{shortlink}

Request

DELETE /api/v2/shortlinks/a5
Authorization: Bearer token123

Response

{
  "deleted": true,
  "alias": "a5",
  "message": "Link successful deleted"
}