Base-URL for our API is https://api.highload.to

All requests to the API shall be HTTP GET or POST

Please make sure to use the API with https only, http requests will result in a HTTP 302 redirect to https.

Most requests require a API Login & API Key, you can find both in the User Panel at the "Account" Tab.

Response is json, structure is as follows:

{
"status": <status-code>,
"msg": "<informational message. might vary, use the status code in your code!>",
"server_time":"<Time of server>"",
"result": <result of the request. varies depending on the request>
}

status

200: Everything is OK. Request succeeded

400: Bad request (e.g. wrong parameters)

403: Permission denied (wrong api login/key, action on a file which does not belong to you, ...)

404: File not found

451: Unavailable For Legal Reasons

509: Bandwidth usage exceeded. Please try again later. (you might see this during peak hours)

50x: Server errors. You should not see this, but be prepared.

msg

This message gives more detailed information in case there is an error.

You can use this for displaying it to the user, but please don't use it for checking if the request succeeded. That's what the status code is for.

result

holds the response of the request if succeeded. Might hold an array of data or just a boolean true/false, depending on the request

Everything account related (total used storage, reward, ...)

Request

https://api.highload.to/account/info?login={login}&key={key}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
    "id": "<userextid>",
    "email": "[email protected]",
    "signup_at": "2019-01-09 23:59:59",
}
}

check the status of a file, e.g. if the file exists

Request

https://api.highload.to/file/info?file={file}&login={login}&key={key}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
        "id": "vcatzwnjh0sm",
        "status": 200,
        "name": "test878ds78d88s.mp4",
        "size": "361357875",
        "folder": "2",
        "sha1": "d16594b09e7645b1377e85f86b6e873889085059",
        "content_type": "video/mp4",
}
}

Get an Upload URL

Uploads shall be POSTed to the upload URL returned by our API and shall be multipart/form-data encoded. Example with curl:

curl \
-F "login=6a6d9c40ed240f4e3" \
-F "key=d9tbp9ugv1ttz1" \
-F "[email protected]" \
-F "folder=1" \
https://server.example.com/uls/60f9badb15337

Get next available upload server

https://api.highload.to/file/ul?login={login}&key={key}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
    "url": "https://server.example.com/uls/60ec19ff4d321",
    "valid_until": "2019-01-09 00:32:20"
}
}

Remote Uploading a file

Request

https://api.highload.to/remotedl/add?login={login}&key={key}&url={url}&folder={folder}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
"id": "8ykqg0nkqxoh",
"folderid": "12345"
}
}

Check Status of Remote Upload

Request

https://api.highload.to/remotedl/status?login={login}&key={key}&id={id}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
    "id": "oau6d7cbex8s",
    "remoteurl": "http://proof.ovh.net/files/100Mio.dat",
    "status": "pending",
    "bytes_loaded": null,
    "bytes_total": "0",
    "folderid": "12345",
    "added": "2019-01-01 02:20:12",
    "started": "0000-00-00 00:00:00",
    "finished": "0000-00-00 00:00:00",

}
}

Removing/Cancelling a remote upload

Request

https://api.highload.to/remotedl/remove?login={login}&key={key}&id={id}

Parameters

Response

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}

restart a remote upload

Request

https://api.highload.to/remotedl/restart?login={login}&key={key}&restart=true

Parameters

Response

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}

Shows the content of your folders Limit per page 200

Request

https://api.highload.to/file/listfolder?login={login}&key={key}&folder={folder}&limit={limit}&page={pagination}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
"folders": [
    {
    "id": "34567",
    "name": "RemoteDl"
    },
    {
    "id": "4567",
    "name": "test"
    },
    {
    "id": "567",
    "name": "videos"
    },
    {
    "id": "6789",
    "name": "series"
    },
    {
    "id": "678",
    "name": "film"
    }
],
"files": [
    {
    "name": "bigbuckbunny.mp4",
    "sha1": "de179ccafa808cabf06cd2e12cd38eb663094e47",
    "folderid": "4567",
    "upload_at": "2021-07-12 14:16:10",
    "status": "active",
    "size": "5321514545",
    "content_type": "video/mp4",
    "download_count": "848",
    "cstatus": "pending",
    "link": "https://highload.to/f/9fnelnvpql73/big_buck_bunny.mp4.mp4",
    "id": "9fnelnvpql73"
    },
    {
    "name": "Sintel.2010.mkv.mp4",
    "sha1": "75b16e207b52f38019fe5400946ff7b228d94bc1",
    "folderid": "4567",
    "upload_at": "2021-07-12 14:16:10",
    "status": "active",
    "size": "5321514545",
    "content_type": "video/mp4",
    "download_count": "1337",
    "cstatus": "Completed",
    "link": "https://highload.to/f/baespiqulj4e/Sintel.2010.1080p.mkv.mp4",
    "id": "baespiqulj4e"
    }
]
}
}

Creates a new Folder

Request

https://api.highload.to/file/createfolder?login={login}&key={key}&name={name}&pid={parent}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": {
    "folderid": "35678"
}
}

Renames a Folder

Request

https://api.highload.to/file/renamefolder?login={login}&key={key}&folder={folder}&name={name}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}

Deletes a Folder with all subfolders and all files in it. Be careful!

Request

https://api.highload.to/file/deletefolder?login={login}&key={key}&folder={folder}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}

Renames a File

Request

https://api.highload.to/file/rename?login={login}&key={key}&file={file}&name={name}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}

Moves a File into a different folder

Request

https://api.highload.to/file/move?login={login}&key={key}&file={file}&folder={folder}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": true
}

Removes a file

Request

https://api.highload.to/file/delete?login={login}&key={key}&file={file}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",

"result": true
}

Shows running file converts by folder

Request

https://api.highload.to/file/runningconverts?login={login}&key={key}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": [
{
    "name": "MyOldCamera.avi",
    "id": "16544848",
    "status": "pending",
    "last_update": "2019-01-01 04:40:40",
    "link": "https://highload.to/f/baespiqulj4e/Geysir.AVI",
    "id": "paupt7t96vod"
}
]
}

Should be unnecessary, if you have problems with convert, send us a message

Shows the video splash image (thumbnail)

Request

https://api.highload.to/file/getsplash?login={login}&key={key}&file={file}

Parameters

Response

200 (OK)
Content-Type: application/json

{
"status": 200,
"msg": "OK",
"server_time":"2021-07-12 08:36:15",
"result": "https://thumb.highdeliveryscdn.com/thumb/d79eb7cdd4ac/paupt7t96vod.jpg"
}