Getting started

                // You'll find cURL examples, HTTP response examples,
// and other notes in this column.
                
            

The LobFile API will allow you (or an application you're writing) to automate the management of your files and other account features. The examples provided on the right column will be cURL.

To use this API, you need an API Key. Access to the API is free to anyone, no matter what account tier you have. Your API key can be found on the my-account page once you have created an account and logged in. Be sure to verify your account's Email address, otherwise requests will fail with an unauthorised error.

If you find this service useful, or if you need more performance out of LobFile (like faster downloads or more account space), please consider becoming a Patreon member.

rate limits

                // HTTP response header example, no response body.
HTTP/1.1 429 Too Many Requests
                
            

LobFile is configured with a global rate limit of 4 requests per second per IP. If you exceed this rate limit you will receive a HTTP1.1 429 Too Many Requests response with no response body.

Please be respectful with your use of the API in your integration and use case.

api requests

// Example of valid API request.
curl \
-H 'X-API-Key: TheExampleAPIKey' \
-H 'Content-Type: application/json' \
-d '{"file":"5l1D"}' \
https://lobfile.com/api/v3/rest/toggle-favorite
            

The only API endpoint that requires POST form data in the request is UPLOAD. All other API endpoints require you to send JSON requests. Be sure to use the examples as an additional guide.

api responses

// Example of successful API request response.
HTTP/1.1 200 OK
{
    "success": true,
    "url": "https://lobfile.com/file/5l1D.png"
}

// Example of a failed API request response.
HTTP/1.1 401 Unauthorized
{
    "success": false,
    "error": "Invalid API key"
}

// Example of a failed API request response, no response body.
HTTP/1.1 500 Internal Server Error
            

Foremost: All HTTP requests will respond with the most relevant HTTP status code. A response with HTTP1.1 200 OK means the request was fully successful, and that the JSON response from the server will be valid.

API responses are JSON objects. Note that the server will not always be able to provide a valid JSON response. You must plan for cases where the API response may not include a valid JSON object or a JSON object at all.

All responses that contain any valid JSON will include a "success" boolean field. In some cases, an "error" JSON field will be present if there was a problem. Otherwise, you can expect whatever else is documented for that API endpoint.

authentication

// Example of X-API-Key HTTP header authentication:
curl \
-H 'X-API-Key: TheExampleAPIKey' \
-F 'file=@/path/to/file.ext' \
-X POST \
https://lobfile.com/api/v3/upload.php

// Example of unauthorised response.
HTTP/1.1 401 Unauthorized
{
    "success": false,
    "error": "Invalid API key"
}
            

All HTTP requests will require you to provide an API Key for authentication. This can be done by sending a HTTP Header: X-API-Key: TheExampleAPIKey with your request.

Requests that have failed authentication will yield a HTTP 401 Unauthorized response.

UPLOAD

// Example of uploading a file:
curl \
-H 'X-API-Key: TheExampleAPIKey' \
-F 'file=@/path/to/file.ext' \
-X POST \
https://lobfile.com/api/v3/upload.php

// Response
HTTP/1.1 200 OK
{
    "success": true,
    "url": "https://lobfile.com/file/5l1D.png"
}

// Example of uploading a file with the optional sha_256 param:
curl \
-H 'X-API-Key: TheExampleAPIKey' \
-F 'file=@/path/to/file.ext' \
-F 'sha_256=64characterhashgoeshere' \
-X POST \
https://lobfile.com/api/v3/upload.php

// Response
HTTP/1.1 500 Internal Server Error
{
    "success": false,
    "error": "Failed to get hash of file"
}
            

Endpoint: https://lobfile.com/api/v3/upload
Request Method: POST
Request Parameter Type: HTTP FORM DATA
Purpose: Upload a file to LobFile.
Notes: Upload limitations such as file size, file count, etc. will depend on your account tier, login to LobFile and visit the my-account page to see your specific account limits.

Currently, all file extensions are allowed, however certain extensions are restricted and will automatically be changed upon upload. Duplicate uploads will simply return the existing link for your account. One file per HTTP request.

POST QUERY PARAMETERS

RESPONSE JSON

GET-FILE-LIST

// Example retrieving the account file list:
curl \
-H 'X-API-Key: TheExampleAPIKey' \
-X GET \
https://lobfile.com/api/v3/rest/get-file-list
            

Endpoint: https://lobfile.com/api/v3/rest/get-file-list
Request Method: GET
Request Parameter Type: NONE
Purpose: Retrieve the complete list of files for the account associated with the API key provided.
Note: If you are currently logged in to LobFile on this browser, you can click the link above and visit the endpoint to see the output directly (without having to provide the X-API-Key header).

QUERY PARAMETERS

RESPONSE JSON

TOGGLE-FAVORITE

// Example of toggling a file as a 'favorite'.
curl \
-H 'X-API-Key: TheExampleAPIKey' \
-H 'Content-Type: application/json' \
-d '{"file":"5l1D"}' \
-X POST \
https://lobfile.com/api/v3/rest/toggle-favorite
            

Endpoint: https://lobfile.com/api/v3/rest/toggle-favorite
Request Method: POST
Request Parameter Type: JSON
Purpose: Mark a specific file as a "favorite".
Note: Files marked as a "Favorite" are excluded from automatic deletion by the "Continuous Uploading" account setting and appear in file-management with a gold star. This endpoint is an implicit toggle operation, rather than an explicit adjustment. The response will also indicate the new "favorite" state of the file.

JSON QUERY PARAMETERS

RESPONSE JSON

DELETE-FILES

// Example of deleting a single file.
curl \
-H 'X-API-Key: TheExampleAPIKey' \
-H 'Content-Type: application/json' \
-d '["5l1D"]' \
-X DELETE \
https://lobfile.com/api/v3/rest/delete-files

// Example of deleting multiple files at once.
curl \
-H 'X-API-Key: TheExampleAPIKey' \
-H 'Content-Type: application/json' \
-d '["PduRkgR8","9qspq67Q"]' \
-X DELETE \
https://lobfile.com/api/v3/rest/delete-files            

Endpoint: https://lobfile.com/api/v3/rest/delete-files
Request Method: DELETE
Request Parameter Type: JSON
Purpose: Delete a file from the account.
Note: Files deleted from a LobFile account immediately become unavailable for download.

JSON QUERY PARAMETERS

RESPONSE JSON

GET-ACCOUNT-INFO

// Example of fetching account info.
curl \
-H 'X-API-Key: ExampleAPIKey' \
https://lobfile.com/api/v3/rest/get-account-info
            

Endpoint: https://lobfile.com/api/v3/rest/get-account-info
Request Method: GET
Request Parameter Type: NONE
Purpose: Retrieve account information.
Note: If you are currently logged in to LobFile on this browser, you can click the link above and visit the endpoint to see the output directly (without having to provide the X-API-Key header).

QUERY PARAMETERS

RESPONSE JSON

GET-ACCOUNT-SETTINGS

// Example of fetching account info.
curl \
-H 'X-API-Key: ExampleAPIKey' \
https://lobfile.com/api/v3/rest/get-account-settings
            

Endpoint: https://lobfile.com/api/v3/rest/get-account-settings
Request Method: GET
Request Parameter Type: NONE
Purpose: Retrieve account settings.
Note: If you are currently logged in to LobFile on this browser, you can click the link above and visit the endpoint to see the output directly (without having to provide the X-API-Key header).

QUERY PARAMETERS

RESPONSE JSON